Merge pull request NREL#182 from softwareengineerprogrammer/main

softwareengineerprogrammer · web-flow · commit 42e19537d13f · 2024-04-11T15:39:30.000-04:00
Unit test for MC HIP-RA-X
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.4.22
+current_version = 3.4.24
 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.4.22
+    version: 3.4.24
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"
diff --git a/README.rst b/README.rst
@@ -47,9 +47,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.4.22.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.4.24.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.22...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.24...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 = '2023'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.4.22'
+version = release = '3.4.24'
 
 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.4.22',
+    version='3.4.24',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(
@@ -73,7 +73,7 @@ def read(*names, **kwargs):
         'pandas',
         'matplotlib',
         # Used by Adv*/AGS extensions; may break tox pypy jobs if those are re-enabled
-        'h5py',
+        'h5py==3.10.0',  # TODO resolve apparent h5py==3.11.0 build compatibility issues on some platforms
         'scipy',
         'iapws',
         'coolprop',
diff --git a/src/geophires_monte_carlo/MC_GeoPHIRES3.py b/src/geophires_monte_carlo/MC_GeoPHIRES3.py
@@ -96,7 +96,7 @@ def Write_HTML_Output(
     for index, row in df.iterrows():
         data = row.values[0 : len(outputs)]
 
-        # have to deal with the special case where thr last column is actually
+        # have to deal with the special case where the last column is actually
         # a compound string with multiple columns in it that looks like this:
         # ' (Gradient 1:47.219846973456924;Reservoir Temperature:264.7789623351493;...)'
         str_to_parse = str(row.values[len(outputs)]).strip().replace('(', '').replace(')', '')
diff --git a/src/geophires_x/Reservoir.py b/src/geophires_x/Reservoir.py
@@ -625,9 +625,11 @@ def read_parameters(self, model: Model) -> None:
                         position = int(parts[1]) - 1
                         model.reserv.gradient.value[position] = ParameterToModify.value
                         if model.reserv.gradient.value[position] > 1.0:
+                            # TODO refactor to avoid heuristic-based unit conversions
                             model.reserv.gradient.value[position] = model.reserv.gradient.value[
                                                                         position] / 1000.0  # convert C/m
                             model.reserv.gradient.CurrentUnits = TemperatureGradientUnit.DEGREESCPERM
+
                         if model.reserv.gradient.value[position] < 1e-6:
                             # convert 0 C/m gradients to very small number, avoids divide by zero errors later
                             model.reserv.gradient.value[position] = 1e-6
diff --git a/src/geophires_x/__init__.py b/src/geophires_x/__init__.py
@@ -1 +1 @@
-__version__ = '3.4.22'
+__version__ = '3.4.24'
diff --git a/src/geophires_x_schema_generator/.gitignore b/src/geophires_x_schema_generator/.gitignore
@@ -0,0 +1 @@
+parameters.rst
diff --git a/tests/geophires_monte_carlo_tests/HIP-RA-X_example1.txt b/tests/geophires_monte_carlo_tests/HIP-RA-X_example1.txt
@@ -0,0 +1,6 @@
+Reservoir Temperature, 250.0
+Rejection Temperature, 60.0
+Reservoir Porosity, 10.0
+Reservoir Area, 55.0
+Reservoir Thickness, 0.25
+Reservoir Life Cycle, 25
diff --git a/tests/geophires_monte_carlo_tests/MC_HIP-RA-X_Settings_file.txt b/tests/geophires_monte_carlo_tests/MC_HIP-RA-X_Settings_file.txt
@@ -0,0 +1,8 @@
+INPUT, Formation Porosity, uniform, 9.0, 28.0
+INPUT, Reservoir Area, uniform, 50.0, 120.0
+INPUT, Reservoir Thickness, uniform, 0.122, 0.299
+INPUT, Reservoir Temperature, uniform, 130, 170
+INPUT, Rejection Temperature, uniform, 20, 33
+OUTPUT, Producible Heat (reservoir)
+OUTPUT, Producible Electricity (reservoir)
+ITERATIONS, 10
diff --git a/tests/geophires_monte_carlo_tests/test_geophires_monte_carlo.py b/tests/geophires_monte_carlo_tests/test_geophires_monte_carlo.py
@@ -138,6 +138,37 @@ def test_hip_ra_monte_carlo(self):
             self.assertLess(json_result['Producible Electricity']['median'], 1000)
             self.assertGreater(json_result['Producible Electricity']['median'], 20)
 
+    def test_hip_ra_x_monte_carlo(self):
+        client = GeophiresMonteCarloClient()
+
+        result: MonteCarloResult = client.get_monte_carlo_result(
+            MonteCarloRequest(
+                SimulationProgram.HIP_RA_X,
+                self._get_arg_file_path('HIP-RA-X_example1.txt'),
+                self._get_arg_file_path('MC_HIP-RA-X_Settings_file.txt'),
+                self._get_arg_file_path('MC_HIP-RA-X_Result.txt'),
+            )
+        )
+        self.assertIsNotNone(result)
+        self.assertIsNotNone(result.output_file_path)
+
+        with open(result.output_file_path) as f:
+            result_content = '\n'.join(f.readlines())
+            self.assertIn('Electricity', result_content)
+
+        with open(result.json_output_file_path) as f:
+            json_result = json.loads(f.read())
+            self.assertIn('Producible Electricity (reservoir)', json_result)
+
+            # Note: it is possible, though unlikely, for the test to incorrectly fail (i.e. a false negative)
+            # if the random values generated happen to give valid results that are outside this range.
+            # If you experience intermittent test failures from the below lines (that are unrelated to HIP-RA code
+            # changes), then it probably means the expected range or settings file need to be adjusted to 'guarantee'
+            # the results can be confidently asserted. (Such as in
+            # https://github.com/NREL/GEOPHIRES-X/pull/178/commits/ec4db42fca5a90715ceb5143e18315d5f3d782b7)
+            self.assertLess(json_result['Producible Electricity (reservoir)']['median'], 1000)
+            self.assertGreater(json_result['Producible Electricity (reservoir)']['median'], 20)
+
     def _get_arg_file_path(self, arg_file):
         test_dir: Path = Path(os.path.abspath(__file__)).parent
         return Path(test_dir, arg_file).absolute()

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '3.4.22'`
	`1`	`+__version__ = '3.4.24'`