templatize reservoir params table

Author: softwareengineerprogrammer

docs/Fervo_Project_Red.md.jinja

@@ -63,13 +63,13 @@ The baseline data for this evaluation was extracted from Figure 5 of Fervo Energ
 
 The GEOPHIRES Gringarten model utilizes a multiple parallel fracture geometry. The critical inputs defining this geometry for the Project Red simulation are detailed below:
 
-| Parameter | Input Value | Derivation Notes |
+| Parameter | Input{{ nbsp }}Value | Derivation Notes |
 | :--- | :--- | :--- |
-| **Number of Fractures** | `{{ input_params['Number of Fractures'] }}` | Fervo estimates between 75 and 100 fractures were created. This value is de-rated in the model to account for the physical reality of imperfect flow distribution and uneven utilization across the entire stimulated rock volume. |
-| **Fracture Shape** | `{{ input_params['Fracture Shape'] }}` | Rectangular geometry (Shape 4), representing standard transverse hydraulic fractures along a horizontal wellbore. |
-| **Fracture Height** | `{{ input_params['Fracture Height'] }}` | Estimated vertical propagation of the stimulated fracture network. |
-| **Fracture Width** | `{{ input_params['Fracture Width'] }}` | Set to match the distance between the injection and production wellbores, assuming a dipole flow field directly connecting the laterals. |
-| **Fracture Separation** | `{{ input_params['Fracture Separation'] }}` | The modeled physical spacing between individual transverse fractures along the lateral section. |
+| **Number of Fractures** | `{{ input_params['Number of Fractures'] }}` | {{ input_params_comments['Number of Fractures'] }} |
+| **Fracture Shape** | `{{ input_params['Fracture Shape'] }}` | {{ input_params_comments['Fracture Shape'] }} |
+| **Fracture Height** | `{{ input_params['Fracture Height'] }}` | {{ input_params_comments['Fracture Height'] }} |
+| **Fracture Width** | `{{ input_params['Fracture Width'] }}` | {{ input_params_comments['Fracture Width'] }} |
+| **Fracture Separation** | `{{ input_params['Fracture Separation'] }}` | {{ input_params_comments['Fracture Separation'] }} |
 
 *Note: These parameters represent a simplified, homogenized analytical equivalent of a highly complex, heterogeneous subsurface fracture network.*
 

src/geophires_docs/__init__.py

@@ -2,6 +2,7 @@
 
 import json
 import os
+import re
 from pathlib import Path
 from typing import Any
 
@@ -11,6 +12,8 @@
 from geophires_x_client import GeophiresXClient
 from geophires_x_client import GeophiresXResult
 
+_NON_BREAKING_SPACE = '\xa0'
+
 
 def _get_file_path(file_name) -> Path:
     return Path(os.path.join(os.path.abspath(os.path.dirname(__file__)), file_name))
@@ -82,6 +85,31 @@ def _get_input_parameters_dict(  # TODO consolidate with FervoProjectCape5TestCa
     return ret
 
 
+def _get_input_parameters_comments_dict(_params: GeophiresInputParameters) -> dict[str, str]:
+    ret: dict[str, str] = {}
+
+    with open(_get_file_path('../geophires_x_schema_generator/geophires-request.json'), encoding='utf-8') as f:
+        request_schema = json.loads(f.read())
+
+    input_params_with_comments: dict[str, Any] = _get_input_parameters_dict(_params, include_parameter_comments=True)
+    for k, v in input_params_with_comments.items():
+        comment: str = ''
+
+        if v is not None and isinstance(v, str) and ',' in v:
+            if k in request_schema['properties'] and request_schema['properties'][k]['type'] == 'array':
+                comment = v.split(', --', maxsplit=1)[1]
+            else:
+                comment = v.split(',', maxsplit=1)[1]
+                # Strip ' --' and optional whitespace from the start of the comment
+                comment = re.sub(r'^\s*--\s*', '', comment)
+
+            comment = comment.strip()
+
+        ret[k] = comment
+
+    return ret
+
+
 def _get_full_profile(
     input_and_result: tuple[GeophiresInputParameters, GeophiresXResult], profile_key: str
 ) -> list[PlainQuantity]:

src/geophires_docs/generate_fervo_project_cape_5_md.py

@@ -15,6 +15,7 @@
 from jinja2 import FileSystemLoader
 from pint.facets.plain import PlainQuantity
 
+from geophires_docs import _NON_BREAKING_SPACE
 from geophires_docs import _PROJECT_ROOT
 from geophires_docs import _get_fpc5_input_file_path
 from geophires_docs import _get_fpc5_result_file_path
@@ -31,7 +32,6 @@
 _current_project_root: Path | None = None
 
 _log = _get_logger(__name__)
-_NON_BREAKING_SPACE = '\xa0'
 
 
 def _get_schema(schema_file_name: str) -> dict[str, Any]:

src/geophires_docs/generate_fervo_project_red_2026_docs.py

@@ -10,8 +10,10 @@
 from scipy.interpolate import interp1d
 from scipy.ndimage import maximum_filter
 
+from geophires_docs import _NON_BREAKING_SPACE
 from geophires_docs import _PROJECT_ROOT
 from geophires_docs import _get_full_production_temperature_profile
+from geophires_docs import _get_input_parameters_comments_dict
 from geophires_docs import _get_input_parameters_dict
 from geophires_docs import _get_logger
 from geophires_x_client import GeophiresInputParameters
@@ -401,12 +403,21 @@ def generate_fervo_project_red_2026_md(
 
     result_values: dict[str, Any] = {}  # get_result_values(result)
 
+    def _get_input_params_dict_with_nbsp() -> dict[str, Any]:
+        input_params_dict: dict[str, Any] = _get_input_parameters_dict(input_params)
+
+        for k, v in input_params_dict.items():
+            if isinstance(v, str):
+                input_params_dict[k] = v.replace(' ', _NON_BREAKING_SPACE)
+
+        return input_params_dict
+
     # noinspection PyDictCreation
     template_values = {
-        # **get_fpc5_input_parameter_values(input_params, result),
-        # **_get_input_parameters_dict(input_params),
-        'input_params': _get_input_parameters_dict(input_params),
+        'input_params': _get_input_params_dict_with_nbsp(),
+        'input_params_comments': _get_input_parameters_comments_dict(input_params),
         **result_values,
+        'nbsp': _NON_BREAKING_SPACE,
     }
 
     docs_dir = project_root / 'docs'

tests/examples/Fervo_Project_Red-2026.out

@@ -6,8 +6,8 @@ Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.13.1
  Simulation Date: 2026-04-21
- Simulation Time:  08:54
- Calculation Time:      1.015 sec
+ Simulation Time:  09:24
+ Calculation Time:      1.008 sec
 
                            ***SUMMARY OF RESULTS***
 

tests/examples/Fervo_Project_Red-2026.txt

@@ -16,11 +16,11 @@ Reservoir Thermal Conductivity, 2.7
 Number of Segments, 1
 Gradient 1, 76
 
-Number of Fractures, 65, -- Paper estimates between 75 and 100; value is de-rated to account for imperfect flow across fractured surface area
-Fracture Shape, 4, -- per the paper
-Fracture Height, 300 foot, -- per the paper
-Fracture Width, 365 foot, -- per the paper (distance between wellbores assumes a dipole flow field)
-Fracture Separation, 10
+Number of Fractures, 65, -- Fervo estimates between 75 and 100 fractures were created. This value is de-rated in the model to account for the physical reality of imperfect flow distribution and uneven utilization across the entire stimulated rock volume.
+Fracture Shape, 4, -- Rectangular geometry (Shape 4), representing standard transverse hydraulic fractures along a horizontal wellbore.
+Fracture Height, 300 foot, -- Estimated vertical propagation of the stimulated fracture network.
+Fracture Width, 365 foot, -- Set to match the distance between the injection and production wellbores, assuming a dipole flow field directly connecting the laterals.
+Fracture Separation, 10, -- The modeled physical spacing between individual transverse fractures along the lateral section.
 
 Plant Outlet Pressure, 1500 psi, -- per the paper
 
@@ -33,7 +33,6 @@ Number of Multilateral Sections, 2, -- Two parallel horizontal sections
 Nonvertical Length per Multilateral Section, 3250 feet, -- per the paper
 
 Well Drilling Cost Correlation, 10, -- per the drill cost paper - works out to $400/ft
-Horizontal Well Drilling Cost Correlation, 10, -- per the drill cost paper - works out to $400/ft
 
 Production Flow Rate per Well, 36, -- per https://fervoenergy.com/enhanced-geothermal-has-been-proven-at-scale-heres-what-two-years-of-production-data-show/
 Production Wellhead Pressure, 225 psi, -- per https://fervoenergy.com/enhanced-geothermal-has-been-proven-at-scale-heres-what-two-years-of-production-data-show/