Parse reservoir volume calculation note in GeophiresXResult

Author: softwareengineerprogrammer

src/geophires_x_client/geophires_x_result.py

@@ -27,6 +27,12 @@ def __init__(self, field_name: str):
         self.field_name: str = field_name
 
 
+class _UnlabeledStringField:
+    def __init__(self, field_name: str, marker_prefixes: list[str]):
+        self.field_name: str = field_name
+        self.marker_prefixes = marker_prefixes
+
+
 class GeophiresXResult:
     _RESULT_FIELDS_BY_CATEGORY = MappingProxyType(
         {
@@ -173,7 +179,15 @@ class GeophiresXResult:
                 'Fracture area',
                 'Number of fractures',
                 'Fracture separation',
-                # TODO reservoir volume note
+                _UnlabeledStringField(
+                    'Reservoir volume calculation note',
+                    [
+                        'Reservoir volume calculated',
+                        'Number of fractures calculated',
+                        'Fracture separation calculated',
+                        'Reservoir volume provided as input',
+                    ],
+                ),
                 'Reservoir volume',
                 'Reservoir impedance',
                 'Reservoir hydrostatic pressure',
@@ -377,6 +391,10 @@ def __init__(self, output_file_path, logger_name=None):
             for field in fields:
                 if isinstance(field, _EqualSignDelimitedField):
                     self.result[category][field.field_name] = self._get_equal_sign_delimited_field(field.field_name)
+                elif isinstance(field, _UnlabeledStringField):
+                    self.result[category][field.field_name] = self._get_unlabeled_string_field(
+                        field.field_name, field.marker_prefixes
+                    )
                 else:
                     is_string_field = isinstance(field, _StringValueField)
                     field_name = field.field_name if is_string_field else field
@@ -596,6 +614,27 @@ def _get_equal_sign_delimited_field(self, field_name):
         self._logger.error(f'Unexpected error extracting equal sign-delimited field {field_name}')  # Shouldn't happen
         return None
 
+    def _get_unlabeled_string_field(self, field_name: str, marker_prefixes: list[str]):
+        matching_lines = set(filter(lambda line: any(m in line for m in marker_prefixes), self._lines))
+
+        if len(matching_lines) == 0:
+            self._logger.debug(f'Unlabeled string field not found: {field_name}')
+            return None
+
+        if len(matching_lines) > 1:
+            self._logger.warning(
+                f'Found multiple ({len(matching_lines)}) entries for unlabeled string field: '
+                f'{field_name}\n\t{matching_lines}'
+            )
+
+        matching_line = matching_lines.pop()
+        for marker_prefix in marker_prefixes:
+            if marker_prefix in matching_line:
+                return matching_line.strip()
+
+        self._logger.error(f'Unexpected error extracting unlabeled string  field {field_name}')  # Shouldn't happen
+        return None
+
     @property
     def power_generation_profile(self):
         return self.result['POWER GENERATION PROFILE']

tests/geophires_x_client_tests/test_geophires_x_result.py

@@ -15,3 +15,12 @@ def test_get_sam_cash_flow_row_name_unit_split(self) -> None:
             with self.subTest(msg=case[0]):
                 actual = GeophiresXResult._get_sam_cash_flow_row_name_unit_split(case[0])
                 self.assertListEqual(actual, case[1])
+
+    def test_reservoir_volume_calculation_note(self):
+        r: GeophiresXResult = GeophiresXResult(self._get_test_file_path('../examples/example2.out'))
+        field_name = 'Reservoir volume calculation note'
+        self.assertIn(field_name, r.result['RESERVOIR PARAMETERS'])
+        self.assertEqual(
+            r.result['RESERVOIR PARAMETERS'][field_name],
+            'Number of fractures calculated with reservoir volume and fracture separation as input',
+        )