Merge pull request NREL#297 from softwareengineerprogrammer/main

softwareengineerprogrammer · web-flow · commit 487e39369717 · 2024-10-03T10:19:11.000-07:00
Fix "Total Nonvertical Length" parameter name; HIP-RA-X unitless result field parsing
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.5.5
+current_version = 3.5.7
 commit = True
 tag = True
 
diff --git a/.cookiecutterrc b/.cookiecutterrc
@@ -54,7 +54,7 @@ default_context:
     sphinx_doctest: "no"
     sphinx_theme: "sphinx-py3doc-enhanced-theme"
     test_matrix_separate_coverage: "no"
-    version: 3.5.5
+    version: 3.5.7
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"
diff --git a/.gitignore b/.gitignore
@@ -14,6 +14,7 @@ requirements.txt
 *.lock
 *.json
 all_messages_conf.log
+HDR.out
 
 # C extensions
 *.so
diff --git a/README.rst b/README.rst
@@ -51,9 +51,9 @@ Free software: `MIT license <LICENSE>`__
     :alt: Supported implementations
     :target: https://pypi.org/project/geophires-x
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.5.5.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.5.7.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.5.5...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.5.7...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,7 @@
 year = '2024'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.5.5'
+version = release = '3.5.7'
 
 pygments_style = 'trac'
 templates_path = ['./templates']
diff --git a/setup.py b/setup.py
@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name='geophires-x',
-    version='3.5.5',
+    version='3.5.7',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(
diff --git a/src/geophires_x/AGSOutputs.py b/src/geophires_x/AGSOutputs.py
@@ -222,12 +222,12 @@ def PrintOutputs(self, model: Model):
 
         except BaseException as ex:
             tb = sys.exc_info()[2]
+            msg = "Error: GEOPHIRES Failed to write the output file.  Exiting....Line %i" % tb.tb_lineno
             print(str(ex))
-            print("Error: GEOPHIRES Failed to write the output file.  Exiting....Line %i" % tb.tb_lineno)
+            print(msg)
             model.logger.critical(str(ex))
-            model.logger.critical(
-                "Error: GEOPHIRES Failed to write the output file.  Exiting....Line %i" % tb.tb_lineno)
+            model.logger.critical(msg)
             traceback.print_exc()
-            sys.exit()
+            raise RuntimeError(msg)
 
         model.logger.info(f'Complete {str(__class__)}: {sys._getframe().f_code.co_name}')
diff --git a/src/geophires_x/Parameter.py b/src/geophires_x/Parameter.py
@@ -731,7 +731,7 @@ def _parameter_with_currency_units_converted_back_to_preferred_units(param: Para
 
     else:
         raise AttributeError(
-            f'Unit/unit type ({param.CurrentUnits}/{param.UnitType} for {param.Name} '
+            f'Unit/unit type ({param.CurrentUnits}/{param.UnitType}) for {param.Name} '
             f'is not a recognized currency unit'
         )
 
diff --git a/src/geophires_x/WellBores.py b/src/geophires_x/WellBores.py
@@ -1004,15 +1004,15 @@ def __init__(self, model: Model):
 
         # Input data for subsurface condition
         self.Nonvertical_length = self.ParameterDict[self.Nonvertical_length.Name] = floatParameter(
-            "Total Nonvertical Length",
+            "Nonvertical Length per Multilateral Section",
             DefaultValue=1000.0,
             Min=50.0,
             Max=20000.0,
             UnitType=Units.LENGTH,
             PreferredUnits=LengthUnit.METERS,
             CurrentUnits=LengthUnit.METERS,
             Required=True,
-            ErrMessage="assume default Total nonvertical length (1000 m)"
+            ErrMessage="assume default Nonvertical Length per Multilateral Section (1000 m)"
         )
 
         self.nonverticalwellborediameter = self.ParameterDict[self.nonverticalwellborediameter.Name] = floatParameter(
@@ -1228,7 +1228,26 @@ def read_parameters(self, model: Model) -> None:
         # and if you do, do it before or after you call you own version of this method. If you do, you can also choose
         # to call this method from you class, which can modify all these superclass parameters in your class.
 
+
         if len(model.InputParameters) > 0:
+
+            # See https://github.com/NREL/GEOPHIRES-X/issues/278?title=Total+Nonvertical+Length+is+actually+per+section
+            deprecated_nonvertical_length_param_name = 'Total Nonvertical Length'
+            if deprecated_nonvertical_length_param_name in model.InputParameters:
+                model.logger.warning(
+                    f'"{deprecated_nonvertical_length_param_name}" parameter name is deprecated, '
+                    f'use "{self.Nonvertical_length.Name}" instead')
+
+                if self.Nonvertical_length.Name not in model.InputParameters:
+                    model.InputParameters[self.Nonvertical_length.Name] = model.InputParameters[
+                        deprecated_nonvertical_length_param_name]
+                else:
+                    model.logger.warning(
+                        f'Ignoring value of "{deprecated_nonvertical_length_param_name}" '
+                        f'because it is set by "{self.Nonvertical_length.Name}" instead')
+
+                del model.InputParameters[deprecated_nonvertical_length_param_name]
+
             # loop through all the parameters that the user wishes to set, looking for parameters that match this object
             for item in self.ParameterDict.items():
                 ParameterToModify = item[1]
diff --git a/src/geophires_x/__init__.py b/src/geophires_x/__init__.py
@@ -1 +1 @@
-__version__ = '3.5.5'
+__version__ = '3.5.7'
diff --git a/src/geophires_x_schema_generator/geophires-request.json b/src/geophires_x_schema_generator/geophires-request.json
@@ -30,7 +30,7 @@
     "Closed-loop Configuration",
     "Well Geometry Configuration",
     "Heat Transfer Fluid",
-    "Total Nonvertical Length",
+    "Nonvertical Length per Multilateral Section",
     "Circulation Pump Efficiency",
     "Utilization Factor",
     "Plant Lifetime",
@@ -893,7 +893,7 @@
         }
       ]
     },
-    "Total Nonvertical Length": {
+    "Nonvertical Length per Multilateral Section": {
       "description": "",
       "type": "number",
       "units": "meter",
diff --git a/src/hip_ra/__init__.py b/src/hip_ra/__init__.py
@@ -44,14 +44,12 @@ def __init__(self, output_file_path):
     def _parse_fields(self):
         with open(self.output_file_path) as f:
             text = f.read()
-            pattern = re.compile(r'(.+?):\s+([0-9eE.+-]+)\s*(.+)+?')
+            pattern = re.compile(r'(.+?):\s+([0-9eE.+-]+)\s*(\S+)*?\n')
 
             matches = re.findall(pattern, text)
 
             result = {
-                key.strip(): (
-                    {'value': float(value), 'unit': unit.strip()} if unit else {'value': float(value), 'unit': None}
-                )
+                key.strip(): {'value': float(value), 'unit': unit.strip() if unit else None}
                 for key, value, unit in matches
             }
 
diff --git a/tests/hip_ra_x_tests/hip-result_test-result-parsing-3.out b/tests/hip_ra_x_tests/hip-result_test-result-parsing-3.out
@@ -0,0 +1,40 @@
+                               *********************
+                               ***HIP CASE REPORT***
+                               *********************
+
+      ***SUMMARY OF INPUTS***
+      Reservoir Temperature:       250.00 degC
+      Rejection Temperature:        60.00 degC
+      Reservoir Porosity:           18.00 %
+      Reservoir Area:               55.00 km**2
+      Reservoir Thickness:           0.25 kilometer
+      Reservoir Life Cycle:         25.00 yr
+      Rock Heat Capacity:        2.84e+12 kJ/km**3C
+      Fluid Specific Heat Capacity:       4.34 kJ/kgC
+      Density Of Reservoir Fluid:   8.62e+11 kg/km**3
+      Density Of Reservoir Rock:   2.55e+12 kg/km**3
+      Recoverable Fluid Factor:       0.50
+      Recoverable Heat from Rock:       0.75
+
+      ***SUMMARY OF RESULTS***
+      Reservoir Pressure:           76.82 MPa
+      Reservoir Depth:               7.83 kilometer
+      Reservoir Volume (reservoir):      13.75 km**3
+      Reservoir Volume (rock):      11.28 km**3
+      Recoverable Volume (recoverable fluid):       1.24 km**3
+      Stored Heat (reservoir):   5.40e+15 kJ
+      Stored Heat (rock):        4.56e+15 kJ
+      Stored Heat (fluid):       8.41e+14 kJ
+      Mass of Reservoir (rock):   2.88e+13 kilogram
+      Mass of Reservoir (fluid):   6.86e+12 kilogram
+      Specific Enthalpy (reservoir):     377.60 kJ/kg
+      Specific Enthalpy (rock):     211.61 kJ/kg
+      Specific Enthalpy (fluid):     166.00 kJ/kg
+      Recovery Factor (reservoir):      13.90 %
+      Available Heat (reservoir):   1.14e+15 kJ
+      Producible Heat (reservoir):   7.51e+14 kJ
+      Producible Heat/Unit Area (reservoir):   1.37e+13 kJ/km**2
+      Producible Heat/Unit Volume (reservoir):   5.46e+13 kJ/km**3
+      Producible Electricity (reservoir):     577.44 MW
+      Producible Electricity/Unit Area (reservoir):      10.50 MW/km**2
+      Producible Electricity/Unit Volume (reservoir):      42.00 MW/km**3
diff --git a/tests/hip_ra_x_tests/test_hip_ra_x.py b/tests/hip_ra_x_tests/test_hip_ra_x.py
@@ -115,6 +115,13 @@ def test_result_parsing_2(self):
             },
         )
 
+    def test_result_parsing_3(self):
+        result = HipRaResult(self._get_test_file_path('hip-result_test-result-parsing-3.out'))
+        self.assertIsNone(result.result['Recoverable Fluid Factor']['unit'])
+        self.assertEqual(result.result['Recoverable Fluid Factor']['value'], 0.50)
+        self.assertEqual(result.result['Producible Heat/Unit Area (reservoir)']['value'], 1.37e13)
+        self.assertEqual(result.result['Producible Heat/Unit Area (reservoir)']['unit'], 'kJ/km**2')
+
     def test_calculate_reservoir_volume(self):
         """Calculates the volume of the reservoir"""
 
diff --git a/tests/multilateral-section-nonvertical-length.txt b/tests/multilateral-section-nonvertical-length.txt
@@ -0,0 +1,42 @@
+Is AGS, True
+Has Nonvertical Section, True
+Multilaterals Cased, True
+Well Geometry Configuration, 1, -- --U-loop (could be Eavor style)
+Plant Lifetime, 40, -- -Years
+Water Thermal Conductivity, 0.65
+Nonvertical Wellbore Diameter, 0.23495, -- ---m
+Cylindrical Reservoir Radius of Effect Factor, 5.0
+Closed Loop Calculation Start Year, 0.1
+Number of Multilateral Sections, 6
+Well Drilling Cost Correlation, 3, -- - [-] Use built-in well drilling cost correlation #3 = vertical open-hole, large diameter
+Horizontal Well Drilling Cost Correlation, 1, -- - [-] Use built-in well drilling cost correlation #3 = vertical open-hole, large diameter
+Reservoir Impedance, 1E-4, -- --assume a very low reservoir impedance since the working fluid is never in contact with the reservoir
+Production Flow Rate per Well, 110, -- - [kg/s]
+Injection Temperature, 60, -- ---C
+Gradient 1, 26.25, -- -[deg.C/km]
+Reservoir Depth, 10.0, -- --km
+Cylindrical Reservoir Input Depth, 10, -- ---km
+Cylindrical Reservoir Output Depth, 10, -- ----km
+Cylindrical Reservoir Length, 10, -- --km
+Reservoir Model, 0, -- -simple cylinder reservoir model
+Number of Production Wells, 1, -- -[-]
+Number of Injection Wells, 1, -- -[-]
+Ramey Production Wellbore Model, 0, -- - Should be 0 (disable) or 1 (enable)
+Production Wellbore Temperature Drop, 0, -- - [deg.C]
+Maximum Temperature, 375, -- - [deg.C]
+Reservoir Volume Option, 4, -- - Should be 1 2 3 or 4. See manual for details.
+Reservoir Volume, 1e9, -- - [m3] (required for reservoir volume option 3 and 4
+Reservoir Heat Capacity, 1050, -- - [J/kg/K]
+End-Use Option, 1, -- - [-] Electricity
+Power Plant Type, 1, -- - [1] Subcritical ORC
+Circulation Pump Efficiency, 0.8, -- - [-]
+Plant Outlet Pressure, 68.95
+Economic Model, 3, -- - Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) or 3 (Bicycle model).
+Fraction of Investment in Bonds, 0.65, -- - [-] Required if Bicycle model is selected. See manual for details.
+Inflated Bond Interest Rate, 0.07, -- - [-] Required if Bicycle model is selected. See manual for details.
+Inflated Equity Interest Rate, 0.12, -- - [-] Required if Bicycle model is selected. See manual for details.
+Inflation Rate, 0.025, -- - [-] Required if Bicycle model is selected. See manual for details.
+Combined Income Tax Rate, 0.392, -- - [-] Required if Bicycle model is selected. See manual for details.
+Gross Revenue Tax Rate, 0, -- - [-] Required if Bicycle model is selected. See manual for details.
+Reservoir Stimulation Capital Cost, 0, -- - [M$/injection well] Reservoir stimulation capital cost per injection well
+Print Output to Console, 1, -- - [-] Should be 0 (don't print results to console) or 1 (print results to console)
diff --git a/tests/test_geophires_x.py b/tests/test_geophires_x.py
@@ -485,3 +485,41 @@ def test_convert_output_psi_to_kpa(self):
         )
 
         # TODO validate output values (for now we are just testing an exception isn't thrown)
+
+    def test_multilateral_section_nonvertical_length(self):
+        def s(r):
+            del r.result['metadata']
+            del r.result['Simulation Metadata']
+            return r
+
+        deprecated_param = s(
+            GeophiresXClient().get_geophires_result(
+                GeophiresInputParameters(
+                    from_file_path=self._get_test_file_path(Path('multilateral-section-nonvertical-length.txt')),
+                    params={'Total Nonvertical Length': 6000.0},
+                )
+            )
+        )
+
+        non_deprecated_param = s(
+            GeophiresXClient().get_geophires_result(
+                GeophiresInputParameters(
+                    from_file_path=self._get_test_file_path(Path('multilateral-section-nonvertical-length.txt')),
+                    params={'Nonvertical Length per Multilateral Section': 6000.0},
+                )
+            )
+        )
+
+        self.assertDictEqual(deprecated_param.result, non_deprecated_param.result)
+
+        both_params = s(
+            GeophiresXClient().get_geophires_result(
+                GeophiresInputParameters(
+                    from_file_path=self._get_test_file_path(Path('multilateral-section-nonvertical-length.txt')),
+                    params={'Nonvertical Length per Multilateral Section': 6000.0, 'Total Nonvertical Length': 4000.0},
+                )
+            )
+        )
+
+        # deprecated is ignored if both are present.
+        self.assertDictEqual(both_params.result, non_deprecated_param.result)

Original file line number	Diff line number	Diff line change
`@@ -731,7 +731,7 @@ def _parameter_with_currency_units_converted_back_to_preferred_units(param: Para`
`731`	`731`
`732`	`732`	`else:`
`733`	`733`	`raise AttributeError(`
`734`		`- f'Unit/unit type ({param.CurrentUnits}/{param.UnitType} for {param.Name} '`
	`734`	`+ f'Unit/unit type ({param.CurrentUnits}/{param.UnitType}) for {param.Name} '`
`735`	`735`	`f'is not a recognized currency unit'`
`736`	`736`	`)`
`737`	`737`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '3.5.5'`
	`1`	`+__version__ = '3.5.7'`