Use null category instead of potentially confusing 'Default' for HIP-RA-X params. Include HIP-RA-X parameters in sphinx docs

Author: softwareengineerprogrammer

.gitignore

@@ -13,6 +13,7 @@ requirements.txt
 .DS_Store
 *.lock
 *.json
+all_messages_conf.log
 
 # C extensions
 *.so
@@ -81,6 +82,8 @@ docs/reference/geophires-request.json
 docs/reference/parameters.rst
 docs/geophires-request.json
 docs/parameters.rst
+docs/hip-ra-x-request.json
+docs/hip_ra_x_parameters.rst
 _site/
 /docs/geophires_x.rstx
 /docs/temperature.txt

docs/index.rst

@@ -8,6 +8,7 @@ Contents
    overview
    parameters
    How-to-extend-GEOPHIRES-X
+   hip_ra_x_parameters
    Monte-Carlo-User-Guide
 ..   reference/index
 

src/geophires_x_schema_generator/__init__.py

@@ -66,7 +66,7 @@ def get_parameter_sources(self) -> list[Tuple[Any, str]]:
         ]
 
     def get_schema_title(self) -> str:
-        return 'GEOPHIRES'
+        return 'GEOPHIRES-X'
 
     def get_parameters_json(self) -> Tuple[str, str]:
 
@@ -138,10 +138,11 @@ def generate_parameters_reference_rst(self) -> str:
             input_params_by_category[category][input_param_name] = input_param
 
         def get_input_params_table(category_params, category_name) -> str:
+            category_display = category_name if category_name is not None else ''
             input_rst = f"""
-{category_name}
-{'-' * len(category_name)}
-    .. list-table:: {category_name} Parameters
+{category_display}
+{'-' * len(category_display)}
+    .. list-table:: {category_display}{' ' if len(category_display) > 0 else ''}Parameters
        :header-rows: 1
 
        * - Name
@@ -176,7 +177,7 @@ def get_input_params_table(category_params, category_name) -> str:
 
         output_rst = self.get_output_params_table_rst(output_params_json)
 
-        rst = f"""Parameters
+        rst = f"""{self.get_schema_title()} Parameters
 ==========
 
 .. contents::
@@ -241,7 +242,7 @@ def _get_min_and_max(param: dict, default_val='') -> Tuple:
 class HipRaXSchemaGenerator(GeophiresXSchemaGenerator):
     def get_parameter_sources(self) -> list[Tuple[Any, str]]:
         dummy_model = HIP_RA_X()
-        return [(dummy_model, 'Default')]
+        return [(dummy_model, None)]
 
     def get_schema_title(self) -> str:
         return 'HIP-RA-X'

src/geophires_x_schema_generator/geophires-request.json

@@ -2,7 +2,7 @@
   "definitions": {},
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
-  "title": "GEOPHIRES Schema",
+  "title": "GEOPHIRES-X Schema",
   "required": [
     "Reservoir Model",
     "Reservoir Depth",

src/geophires_x_schema_generator/hip-ra-x-request.json

@@ -20,7 +20,7 @@
       "description": "Reservoir Temperature [150 dec-C]",
       "type": "number",
       "units": "degC",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 50,
       "maximum": 1000
@@ -29,7 +29,7 @@
       "description": "Rejection Temperature [25 dec-C]",
       "type": "number",
       "units": "degC",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.1,
       "maximum": 200
@@ -38,7 +38,7 @@
       "description": "Reservoir Porosity [18%]",
       "type": "number",
       "units": "%",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 100.0
@@ -47,7 +47,7 @@
       "description": "Reservoir Area [81 km2]",
       "type": "number",
       "units": "km**2",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 10000.0
@@ -56,7 +56,7 @@
       "description": "Reservoir Thickness [0.286 km]",
       "type": "number",
       "units": "kilometer",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 10000.0
@@ -65,7 +65,7 @@
       "description": "Reservoir Life Cycle [30 years]",
       "type": "integer",
       "units": "yr",
-      "category": "Default",
+      "category": null,
       "default": null,
       "minimum": 1,
       "maximum": 100
@@ -74,7 +74,7 @@
       "description": "Rock Heat Capacity [2.84E+12 kJ/km3C]",
       "type": "number",
       "units": "kJ/km**3C",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 100000000000000.0
@@ -83,7 +83,7 @@
       "description": "Specific Heat Capacity Of Water [4.18 kJ/kgC]",
       "type": "number",
       "units": "kJ/kgC",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 3.0,
       "maximum": 10.0
@@ -92,7 +92,7 @@
       "description": "Density Of Water [1.0E+12 kg/km3]",
       "type": "number",
       "units": "kg/km**3",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 100000000000.0,
       "maximum": 10000000000000.0
@@ -101,7 +101,7 @@
       "description": "Density Of Rock [2.55E+12 kg/km3]",
       "type": "number",
       "units": "kg/km**3",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 100000000000.0,
       "maximum": 10000000000000.0
@@ -110,7 +110,7 @@
       "description": "percent of heat that is recoverable from the rock in the reservoir 0.66 for high-T reservoirs,             0.43 for low-T reservoirs (Garg and Combs (2011)",
       "type": "number",
       "units": "",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 1.0
@@ -119,7 +119,7 @@
       "description": "percent of heat that is recoverable from the fluid in the reservoir 0.66 for high-T reservoirs,             0.43 for low-T reservoirs (Garg and Combs (2011)",
       "type": "number",
       "units": "",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 1.0
@@ -128,7 +128,7 @@
       "description": "percent of fluid that is recoverable from the reservoir (0.5 = 50%)",
       "type": "number",
       "units": "",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 1.0
@@ -137,7 +137,7 @@
       "description": "depth to top of reservoir (km). Calculated based on an assumed gradient                  and the reservoir temperature if no value given",
       "type": "number",
       "units": "kilometer",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.001,
       "maximum": 15.0
@@ -146,7 +146,7 @@
       "description": "pressure of the of reservoir (in mPa). Calculated assuming hydrostatic pressure and                  reservoir depth & water density if no value given",
       "type": "number",
       "units": "mPa",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 10000.0
@@ -155,7 +155,7 @@
       "description": "percent of fluid that is recoverable from the reservoir (0.75 = 75%)",
       "type": "number",
       "units": "",
-      "category": "Default",
+      "category": null,
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 1.0
@@ -164,7 +164,7 @@
       "description": "Provide a HTML output name if you want to have HTML output (no output if not provided)",
       "type": "string",
       "units": null,
-      "category": "Default",
+      "category": null,
       "default": null,
       "minimum": null,
       "maximum": null