generate params table from baseline txt input file

Author: softwareengineerprogrammer

docs/Fervo_Project_Cape_HIIP_Analysis.md.jinja

@@ -23,13 +23,16 @@ All modeling assumptions represent the independent interpretation of the author
 
 **HIP-RA-X Evaluation:**
 HIP-RA-X mathematically aligns perfectly with the SEC's thermal energy physics. Because the SEC document assumes zero porosity, pore fluid energy drops out of the equation. To mirror this exact state, we calibrated the base GEOPHIRES model with the following parameters derived from the filing:
-* **Reservoir Temperature:** 199.0 °C (Explicitly cited as the ORC design intake temperature).
-* **Rejection Temperature:** 80.0 °C (Fixed by D&M to match the produced water injection temperature).
-* **Reservoir Porosity:** 0.0 % (Matches the "little to no porosity" description).
-* **Reservoir Area:** 48.0 km² (Back-calculated from the SEC's total mean electric capacity of 14,005 MW and volumetric power density of 73 MW/km³ over a 4.0 km depth range).
-* **Reservoir Thickness:** 4.0 km (Matches the base accumulation depth bound).
-* **Density Of Reservoir Rock:** 2.8e12 kg/km³ (GEOPHIRES Cape Station baseline).
-* **Rock Heat Capacity:** 2.212e12 kJ/km³°C (GEOPHIRES Cape Station baseline).
+
+{{ baseline_input_params_table_md }}
+
+{#* **Reservoir Temperature:** 199.0 °C (Explicitly cited as the ORC design intake temperature).#}
+{#* **Rejection Temperature:** 80.0 °C (Fixed by D&M to match the produced water injection temperature).#}
+{#* **Reservoir Porosity:** 0.0 % (Matches the "little to no porosity" description).#}
+{#* **Reservoir Area:** 48.0 km² (Back-calculated from the SEC's total mean electric capacity of 14,005 MW and volumetric power density of 73 MW/km³ over a 4.0 km depth range).#}
+{#* **Reservoir Thickness:** 4.0 km (Matches the base accumulation depth bound).#}
+{#* **Density Of Reservoir Rock:** 2.8e12 kg/km³ (GEOPHIRES Cape Station baseline).#}
+{#* **Rock Heat Capacity:** 2.212e12 kJ/km³°C (GEOPHIRES Cape Station baseline).#}
 
 ### Estimation Methodology
 

src/geophires_docs/__init__.py

@@ -11,6 +11,7 @@
 from geophires_x_client import GeophiresInputParameters
 from geophires_x_client import GeophiresXClient
 from geophires_x_client import GeophiresXResult
+from hip_ra import HipRaInputParameters
 
 _NON_BREAKING_SPACE = '\xa0'
 
@@ -63,7 +64,9 @@ def error(self, msg):
 
 
 def _get_input_parameters_dict(  # TODO consolidate with FervoProjectCape5TestCase._get_input_parameters
-    _params: GeophiresInputParameters, include_parameter_comments: bool = False, include_line_comments: bool = False
+    _params: GeophiresInputParameters | HipRaInputParameters,
+    include_parameter_comments: bool = False,
+    include_line_comments: bool = False,
 ) -> dict[str, Any]:
     comment_idx = 0
     ret: dict[str, Any] = {}
@@ -85,7 +88,7 @@ def _get_input_parameters_dict(  # TODO consolidate with FervoProjectCape5TestCa
     return ret
 
 
-def _get_input_parameters_comments_dict(_params: GeophiresInputParameters) -> dict[str, str]:
+def _get_input_parameters_comments_dict(_params: GeophiresInputParameters | HipRaInputParameters) -> dict[str, str]:
     ret: dict[str, str] = {}
 
     with open(_get_file_path('../geophires_x_schema_generator/geophires-request.json'), encoding='utf-8') as f:

src/geophires_docs/generate_fpc_hiip_analysis_doc.py

@@ -4,7 +4,10 @@
 
 from jinja2 import Environment
 from jinja2 import FileSystemLoader
+from tabulate import tabulate
 
+from geophires_docs import _get_input_parameters_dict
+from geophires_docs import _get_logger
 from geophires_monte_carlo import GeophiresMonteCarloClient
 from geophires_monte_carlo import MonteCarloRequest
 from geophires_monte_carlo import MonteCarloResult
@@ -13,13 +16,35 @@
 from hip_ra_x import HipRaXClient
 from hip_ra_x import HipRaXResult
 
-_log = logging.getLogger(__name__)
+_log = _get_logger(__name__)
 
 _PROJECT_ROOT = Path(__file__).resolve().parent.parent.parent
 _BUILD_DIR = _PROJECT_ROOT / 'build' / 'fpc_hiip_analysis'
 _IMAGES_DIR = _PROJECT_ROOT / 'docs' / '_images'
 
 
+def _get_baseline_input_params_table_md(baseline_input_params):
+    params_dict = _get_input_parameters_dict(baseline_input_params, include_parameter_comments=True)
+
+    table = []
+
+    for k, v_c in params_dict.items():
+        v = v_c.split(',')[0].strip()
+        c = v_c.split(',')[1].replace(' -- ', '').strip()
+
+        # Prevent tabulate from trying to convert boolean strings to float
+        if v.lower() in ('true', 'false'):
+            v = f' {v}'
+
+        if c == '':
+            # c = ' .. N/A'
+            continue  # omit commentless params for now
+
+        table.append([k, v, c])
+
+    return tabulate(table, ['Parameter', 'Value', 'Comment'], tablefmt='github', floatfmt='')
+
+
 def generate_fpc_hiip_analysis_doc():
     _BUILD_DIR.mkdir(parents=True, exist_ok=True)
     _IMAGES_DIR.mkdir(parents=True, exist_ok=True)
@@ -30,9 +55,8 @@ def generate_fpc_hiip_analysis_doc():
 
     _log.info('Running deterministic HIP-RA-X baseline...')
     client = HipRaXClient()
-    det_result: HipRaXResult = client.get_hip_ra_x_result(
-        HipRaInputParameters(file_path_or_params_dict=base_input_path)
-    )
+    det_input_params: HipRaInputParameters = HipRaInputParameters(file_path_or_params_dict=base_input_path)
+    det_result: HipRaXResult = client.get_hip_ra_x_result(det_input_params)
 
     det_stored_heat_kj = det_result.result['SUMMARY OF RESULTS']['Stored Heat (reservoir)']['value']
     det_elec_mw = det_result.result['SUMMARY OF RESULTS']['Producible Electricity (reservoir)']['value']
@@ -94,7 +118,10 @@ def generate_fpc_hiip_analysis_doc():
     _log.info('Rendering Markdown documentation...')
     docs_dir = _PROJECT_ROOT / 'docs'
 
+    baseline_input_params_table_md = _get_baseline_input_params_table_md(det_input_params)
+
     template_values = {
+        'baseline_input_params_table_md': baseline_input_params_table_md,
         'det_stored_heat_15j': f'{det_stored_heat_15j:,.0f}',
         'det_elec_mw': f'{det_elec_mw:,.0f}',
         'mc_stored_heat_mean_15j': f'{mc_stored_heat_mean_15j:,.0f}',

src/hip_ra/__init__.py

@@ -36,6 +36,10 @@ def as_file_path(self) -> Path:
     def output_file_path(self) -> Path:
         return self._output_file_path
 
+    def as_text(self):
+        with open(self.as_file_path(), encoding='UTF-8') as f:
+            return f.read()
+
 
 class HipRaResult:
     def __init__(self, output_file_path):

tests/hip_ra_x_tests/test_hip_ra_x.py

@@ -58,13 +58,13 @@ def get_output_file_for_example(example_file: Path):
                     expected_result = HipRaResult(expected_result_output_file_path)
                     self.assertDictEqual(expected_result.result, result.result)
 
+                    # TODO
+                    # self.assertFileContentsEqual(expected_result_output_file_path, result.output_file_path)
+
                     x_result = client.get_hip_ra_x_result(HipRaInputParameters(input_file_path))
                     expected_x_result = HipRaXResult.from_hip_ra_result(expected_result)
                     self.assertDictEqual(expected_x_result.result, x_result.result)
 
-                    # TODO
-                    # self.assertFileContentsEqual(expected_result_output_file_path, result.output_file_path)
-
     def test_print_output_to_console(self):
         def get_stdout_from_running(print_output_to_console: bool | int) -> str:
             params = {