include singh et al. params in doc

Author: softwareengineerprogrammer

docs/Fervo_Project_Cape-4.md.jinja

@@ -139,7 +139,12 @@ in source code for the complete results.
 
 #### Production Temperature Comparison with Singh et al., 2025
 
-Figure 18 of Singh et al. (2025) illustrates reservoir modeling that informed the Cape Station field implementation. The following table compares the average production temperature profile from the "700 ft bench spacing" scenario in Singh et al. (2025) with an analogous GEOPHIRES simulation using the case study’s reservoir engineering parameters.
+Figure 18 of Singh et al. (2025) illustrates reservoir modeling that informed the Cape Station field implementation.
+An equivalent GEOPHIRES simulation was run using the case study's reservoir engineering parameters, with the following modifications to match the Singh et al. (2025) scenario:
+
+{{ reservoir_engineering_reference_simulation_params_table_md }}
+
+The following table compares the average production temperature profile from the "700 ft bench spacing" scenario in Singh et al. (2025) with the GEOPHIRES simulation.
 
 {# @formatter:off #}
 | Reservoir Engineering Reference Base Case Simulation | Case Study Equivalent Simulation |

src/geophires_docs/generate_fervo_project_cape_4_docs.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import Any
+
 from geophires_docs import _PROJECT_ROOT
 from geophires_docs import generate_fervo_project_cape_4_md
 from geophires_docs.generate_fervo_project_cape_4_graphs import generate_fervo_project_cape_4_graphs
@@ -8,17 +10,18 @@
 from geophires_x_client import GeophiresXResult
 from geophires_x_client import ImmutableGeophiresInputParameters
 
+_SINGH_ET_AL_BASE_SIMULATION_PARAMETERS: dict[str, Any] = {
+    'Number of Production Wells': 4,
+    'Maximum Drawdown': 1,
+    'Plant Lifetime': 15,
+}
 
 # fmt:off
 def get_singh_et_al_base_simulation_result(base_input_params: GeophiresInputParameters) \
         -> tuple[GeophiresInputParameters,GeophiresXResult]:
     singh_et_al_base_simulation_input_params = ImmutableGeophiresInputParameters(
         from_file_path=base_input_params.as_file_path(),
-        params={
-            'Number of Production Wells': 4,
-            'Maximum Drawdown': 1,
-            'Plant Lifetime': 15,
-        },
+        params=_SINGH_ET_AL_BASE_SIMULATION_PARAMETERS,
     )
     # fmt:on
 
@@ -43,7 +46,11 @@ def generate_fervo_project_cape_4_docs():
         _PROJECT_ROOT / 'docs/_images'
     )
 
-    generate_fervo_project_cape_4_md.generate_fervo_project_cape_4_md(input_params,result)
+    generate_fervo_project_cape_4_md.generate_fervo_project_cape_4_md(
+        input_params,
+        result,
+        _SINGH_ET_AL_BASE_SIMULATION_PARAMETERS
+    )
 
 
 if __name__ == '__main__':

src/geophires_docs/generate_fervo_project_cape_4_md.py

@@ -145,7 +145,7 @@ def generate_fpc4_economics_parameters_table_md(input_params: GeophiresInputPara
 
 
 def get_fpc4_category_parameters_table_md(
-    input_params: GeophiresInputParameters, category_name: str, parameters_to_exclude: list[str] | None
+    input_params: GeophiresInputParameters, category_name: str | None, parameters_to_exclude: list[str] | None = None
 ) -> str:
     if parameters_to_exclude is None:
         parameters_to_exclude = []
@@ -169,7 +169,7 @@ def get_fpc4_category_parameters_table_md(
             continue
 
         category = _get_parameter_category(param_name)
-        if category == category_name:
+        if category_name is None or category == category_name:
             param_val_comment_split = param_val_comment.split(
                 # ',',
                 ',' if _get_parameter_schema_type(param_name) != 'array' else ', ',
@@ -372,7 +372,26 @@ def _total_fracture_surface_area_per_well_m2(result: GeophiresXResult) -> float:
     )
 
 
-def generate_fervo_project_cape_4_md(input_params: GeophiresInputParameters, result: GeophiresXResult) -> None:
+def generate_res_eng_reference_sim_params_table_md(
+    base_case_input_params: GeophiresInputParameters, res_eng_reference_sim_params: dict[str, Any]
+) -> str:
+    return get_fpc4_category_parameters_table_md(
+        ImmutableGeophiresInputParameters(
+            # from_file_path=base_case_input_params.as_file_path(),
+            params=res_eng_reference_sim_params
+        ),
+        None,
+    )
+
+
+def generate_fervo_project_cape_4_md(
+    input_params: GeophiresInputParameters,
+    result: GeophiresXResult,
+    res_eng_reference_sim_params: dict[str, Any] | None = None,
+) -> None:
+    if res_eng_reference_sim_params is None:
+        res_eng_reference_sim_params = {}
+
     # noinspection PyDictCreation
     template_values = {**get_fpc4_input_parameter_values(input_params, result), **get_result_values(result)}
 
@@ -381,6 +400,10 @@ def generate_fervo_project_cape_4_md(input_params: GeophiresInputParameters, res
     template_values['well_bores_parameters_table_md'] = generate_fpc4_well_bores_parameters_table_md(input_params)
     template_values['economics_parameters_table_md'] = generate_fpc4_economics_parameters_table_md(input_params)
 
+    template_values['reservoir_engineering_reference_simulation_params_table_md'] = (
+        generate_res_eng_reference_sim_params_table_md(input_params, res_eng_reference_sim_params)
+    )
+
     docs_dir = _PROJECT_ROOT / 'docs'
 
     # Set up Jinja environment