Unit test for MC HIP-RA-X NREL#180

Author: softwareengineerprogrammer

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(')', '')

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

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

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()