handle comment parameters

Author: softwareengineerprogrammer

src/geophires_docs/__init__.py

@@ -8,6 +8,7 @@
 
 from pint.facets.plain import PlainQuantity
 
+from geophires_x.ParameterUtils import COMMENT_PARAMETER_NAME_PREFIX
 from geophires_x_client import GeophiresInputParameters
 from geophires_x_client import GeophiresXClient
 from geophires_x_client import GeophiresXResult
@@ -77,7 +78,7 @@ def _get_input_parameters_dict(  # TODO consolidate with FervoProjectCape5TestCa
             ret[field] = fieldValue.strip()
 
         if include_line_comments and field.startswith('#'):
-            ret[f'_COMMENT-{comment_idx}'] = line.strip()
+            ret[f'{COMMENT_PARAMETER_NAME_PREFIX}{comment_idx}'] = line.strip()
             comment_idx += 1
 
         # TODO preserve newlines

src/geophires_docs/generate_fervo_project_cape_5_md.py

@@ -24,6 +24,7 @@
 from geophires_docs import _get_project_root
 from geophires_x.GeoPHIRESUtils import is_int
 from geophires_x.GeoPHIRESUtils import sig_figs
+from geophires_x.ParameterUtils import COMMENT_PARAMETER_NAME_PREFIX
 from geophires_x_client import GeophiresInputParameters
 from geophires_x_client import GeophiresXResult
 from geophires_x_client import ImmutableGeophiresInputParameters
@@ -219,7 +220,7 @@ def get_fpc_category_parameters_table_md(
 
     table_entries = []
     for param_name, param_val_comment in input_params_dict.items():
-        if param_name.startswith(('#', '_COMMENT-')):
+        if param_name.startswith(('#', COMMENT_PARAMETER_NAME_PREFIX)):
             continue
 
         if param_name in parameters_to_exclude:

src/geophires_x/ParameterUtils.py

@@ -9,6 +9,8 @@
 
 _log = logging.getLogger(__name__)
 
+COMMENT_PARAMETER_NAME_PREFIX = '_COMMENT-'
+
 
 def expand_schedule_dsl(
     schedule_strings: list[str | float], total_years: int, allow_schedule_length_to_exceed_total_years: bool = False

src/geophires_x_client/geophires_input_parameters.py

@@ -16,6 +16,8 @@
 
 from typing_extensions import override
 
+from geophires_x.ParameterUtils import COMMENT_PARAMETER_NAME_PREFIX
+
 
 class EndUseOption(Enum):
     """
@@ -248,8 +250,12 @@ def _row_entries(param_name: str, param_value_raw: str) -> list[str]:
             units_entry = ''
             comment_entry = ''
 
-            if parse_units_and_comments:
+            if param_name.startswith(COMMENT_PARAMETER_NAME_PREFIX):
+                comment_entry = param_value_raw
+                value_entry = ''
+            elif parse_units_and_comments:
                 # TODO consolidate with other codebase parameter parsing logic...
+
                 param_schema = request_schema['properties'].get(param_name, {param_name: {}})
                 is_array_type = param_schema.get('type') == 'array'
 

tests/geophires_x_tests/test_fervo_project_cape_5.py

@@ -12,6 +12,7 @@
 from geophires_x.GeoPHIRESUtils import quantity
 from geophires_x.GeoPHIRESUtils import sig_figs
 from geophires_x.Parameter import HasQuantity
+from geophires_x.ParameterUtils import COMMENT_PARAMETER_NAME_PREFIX
 from geophires_x_client import GeophiresInputParameters
 from geophires_x_client import GeophiresXClient
 from geophires_x_client import GeophiresXResult
@@ -85,7 +86,7 @@ def _get_input_parameters(
                 ret[field] = fieldValue.strip()
 
             if include_line_comments and field.startswith('#'):
-                ret[f'_COMMENT-{comment_idx}'] = line.strip()
+                ret[f'{COMMENT_PARAMETER_NAME_PREFIX}{comment_idx}'] = line.strip()
                 comment_idx += 1
 
             # TODO preserve newlines

tests/input-parameters-with-parsed-units-and-comments.csv

@@ -1,3 +1,4 @@
+INPUT PARAMETERS,_COMMENT-0,,,,# My parameters
 INPUT PARAMETERS,Reservoir Depth,,3000,m,
 INPUT PARAMETERS,Gradient 1,,50,degC/km,
 INPUT PARAMETERS,End-Use Option,,1,,Direct-Use Heat

tests/test_geophires_x_client.py

@@ -671,6 +671,7 @@ def test_csv_with_input_parameters(self):
     def test_csv_with_input_parameters_parse_units_and_comments(self):
         csv_input_with_units_and_comments = ImmutableGeophiresInputParameters(
             params={
+                '_COMMENT-0': '# My parameters',
                 'Reservoir Depth': '3000 m',
                 'Gradient 1': 50,
                 'End-Use Option': '1, -- Direct-Use Heat',