Merge branch 'main' into fervo-case-study

Author: malcolm-dsider

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.4.25
+current_version = 3.4.28
 commit = True
 tag = True
 

.cookiecutterrc

@@ -54,7 +54,7 @@ default_context:
     sphinx_doctest: "no"
     sphinx_theme: "sphinx-py3doc-enhanced-theme"
     test_matrix_separate_coverage: "no"
-    version: 3.4.25
+    version: 3.4.28
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023, NREL
+Copyright (c) 2023-2024, NREL
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

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.25.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.4.28.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.25...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.28...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -65,7 +65,7 @@ Getting Started
 Web Interface
 -------------
 
-A web interface is available at `tinyurl.com/geophires <https://tinyurl.com/geophires>`__
+A web interface is available at `bit.ly/GEOPHIRES <https://bit.ly/GEOPHIRES>`__
 
 Installation
 ------------

docs/conf.py

@@ -18,7 +18,7 @@
 year = '2023'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.4.25'
+version = release = '3.4.28'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

setup.py

@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name='geophires-x',
-    version='3.4.25',
+    version='3.4.28',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(

src/geophires_monte_carlo/MC_GeoPHIRES3.py

@@ -218,12 +218,14 @@ def work_package(pass_list: list):
         shutil.copyfile(result.output_file_path, tmp_output_file)
     elif args.Code_File.endswith('HIP_RA.py'):
         hip_ra_client: HipRaClient = HipRaClient()
-        result: HipRaResult = hip_ra_client.get_hip_ra_result(HipRaInputParameters(from_file_path=Path(tmp_input_file)))
+        result: HipRaResult = hip_ra_client.get_hip_ra_result(
+            HipRaInputParameters(file_path_or_params_dict=Path(tmp_input_file))
+        )
         shutil.copyfile(result.output_file_path, tmp_output_file)
     elif args.Code_File.endswith('hip_ra_x.py'):
         hip_ra_x_client: HipRaXClient = HipRaXClient()
         result: HipRaResult = hip_ra_x_client.get_hip_ra_result(
-            HipRaInputParameters(from_file_path=Path(tmp_input_file))
+            HipRaInputParameters(file_path_or_params_dict=Path(tmp_input_file))
         )
         shutil.copyfile(result.output_file_path, tmp_output_file)
     else:
@@ -358,6 +360,7 @@ def main(command_line_args=None):
         if 'MC_OUTPUT_FILE' in args and args.MC_OUTPUT_FILE is not None
         else str(Path(Path(args.Input_file).parent, 'MC_Result.txt').absolute())
     )
+    code_file_name = Path(args.Code_File).name
     python_path = 'python'
     html_path = ''
 
@@ -450,6 +453,14 @@ def main(command_line_args=None):
     results_pd = pd.read_csv(output_file)
     df = pd.DataFrame(results_pd)
 
+    if len(results) < 1:
+        # TODO surface actual exceptions instead of giving this generic message
+        raise RuntimeError(
+            'No MC results generated, '
+            f'this is likely caused by {code_file_name} throwing an exception '
+            f'when run with your input file.'
+        )
+
     # Compute the stats along the specified axes.
     mins = np.nanmin(results, 0)
     maxs = np.nanmax(results, 0)

src/geophires_x/AGSWellBores.py

@@ -773,12 +773,12 @@ def CalculateNonverticalPressureDrop(self, model:Model, time_operation: float, t
             # nonvertical wellbore fluid conditions based on current temperature
             rhowater = density_water_kg_per_m3(
                 self.NonverticalProducedTemperature.value[year],
-                pressure=model.reserv.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.InputDepth.quantity().to('m').magnitude)
+                pressure=model.reserv.lithostatic_pressure()
             )
 
             muwater = viscosity_water_Pa_sec(
                 self.NonverticalProducedTemperature.value[year],
-                pressure=model.reserv.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.InputDepth.quantity().to('m').magnitude)
+                pressure=model.reserv.lithostatic_pressure()
             )
             vhoriz = self.q_circulation / rhowater / (math.pi / 4. * self.nonverticalwellborediameter.value ** 2)
 
@@ -859,15 +859,15 @@ def Calculate(self, model: Model) -> None:
                 # MIR figure out how to calculate year and extract Tini from reserv Tresoutput array
                 year = math.trunc(self.time_operation.value / self.al)
                 self.NonverticalProducedTemperature.value[year] = inverselaplace(
-                    self, 16, 0, model.reserv.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.InputDepth.quantity().to('m').magnitude))
+                    self, 16, 0, model.reserv.lithostatic_pressure())
                 # update alpha_fluid value based on next temperature of reservoir
 
                 self.alpha_fluid = self.WaterThermalConductivity.value / density_water_kg_per_m3(
                     self.NonverticalProducedTemperature.value[year],
-                    pressure=model.reserv.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.InputDepth.quantity().to('m').magnitude)
+                    pressure=model.reserv.lithostatic_pressure()
                 ) / heat_capacity_water_J_per_kg_per_K(
                     self.NonverticalProducedTemperature.value[year],
-                    pressure=model.reserv.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.InputDepth.quantity().to('m').magnitude)
+                    pressure=model.reserv.lithostatic_pressure()
                 ) * 24.0 * 3600.0
                 self.time_operation.value += self.al
 
@@ -881,7 +881,7 @@ def Calculate(self, model: Model) -> None:
             self.ProdTempDrop.value = self.tempdropprod.value
             model.reserv.cpwater.value = heat_capacity_water_J_per_kg_per_K(
                 self.NonverticalProducedTemperature.value[0],
-                pressure=model.reserv.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.InputDepth.quantity().to('m').magnitude)
+                pressure=model.reserv.lithostatic_pressure()
             )
             if self.rameyoptionprod.value:
                 self.ProdTempDrop.value = RameyCalc(model.reserv.krock.value,
@@ -904,13 +904,13 @@ def Calculate(self, model: Model) -> None:
             if self.productionwellpumping.value:
                 self.rhowaterinj = density_water_kg_per_m3(
                     model.reserv.Tsurf.value,
-                    pressure=model.reserv.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.InputDepth.quantity().to('m').magnitude)
+                    pressure=model.reserv.lithostatic_pressure()
                 ) * np.linspace(1, 1,
                                 len(self.ProducedTemperature.value))
 
                 self.rhowaterprod = density_water_kg_per_m3(
                     model.reserv.Trock.value,
-                    pressure=model.reserv.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.InputDepth.quantity().to('m').magnitude)
+                    pressure=model.reserv.lithostatic_pressure()
                 ) * np.linspace(1, 1, len(self.ProducedTemperature.value))
 
                 self.DPProdWell.value, f3, vprod, self.rhowaterprod = WellPressureDrop(model,
@@ -1015,13 +1015,13 @@ def Calculate(self, model: Model) -> None:
 
             rho_water = density_water_kg_per_m3(
                 self.Tout[0],
-                pressure = model.reserv.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.InputDepth.quantity().to('m').magnitude),
+                pressure = model.reserv.lithostatic_pressure(),
             )
 
 
             model.reserv.cpwater.value = heat_capacity_water_J_per_kg_per_K(
                 self.Tout[0],
-                pressure=model.reserv.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.InputDepth.quantity().to('m').magnitude),
+                pressure=model.reserv.lithostatic_pressure(),
             )  # Need this for surface plant output calculation
 
             # set pumping power to zero for all times, assuming that the thermosphere wil always

src/geophires_x/CylindricalReservoir.py

@@ -98,7 +98,7 @@ def __init__(self, model: Model):
             UnitType=Units.PERCENT,
             PreferredUnits=PercentUnit.TENTH,
             CurrentUnits=PercentUnit.TENTH,
-            ErrMessage="assume default cyclindrical reservoir radius of effect reduction factor (0.1)",
+            ErrMessage="assume default cylindrical reservoir radius of effect reduction factor (0.1)",
             ToolTipText="The radius of effect reduction factor - to account for the fact that we cannot extract 100%"
                         + " of the heat in the cylinder.",
         )
@@ -246,20 +246,17 @@ def Calculate(self, model: Model) -> None:
                                                  ) / 1e15  # 10^15 J
         self.cpwater.value = heat_capacity_water_J_per_kg_per_K(
             model.wellbores.Tinj.value * 0.5 + (self.Trock.value * 0.9 + model.wellbores.Tinj.value * 0.1) * 0.5,
-            pressure=self.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.depth.quantity().to('m').magnitude)
+            pressure=self.lithostatic_pressure()
         )
         self.rhowater.value = density_water_kg_per_m3(
             model.wellbores.Tinj.value * 0.5 + (self.Trock.value * 0.9 + model.wellbores.Tinj.value * 0.1) * 0.5,
-            pressure=self.lithostatic_pressure(model.reserv.rhorock.value, model.reserv.depth.quantity().to('m').magnitude)
+            pressure=self.lithostatic_pressure()
         )
 
         model.logger.info(f'complete {str(__class__)}: {sys._getframe().f_code.co_name}')
 
-    #def lithostatic_pressure(self) -> PlainQuantity:
-        """
-        @override
+    def lithostatic_pressure(self) -> PlainQuantity:
+        """@override"""
 
-        Standard reservoir implementation uses depth but CylindricalReservoir sets depth to total drilled length
-        """
-        def lithostatic_pressure(self, rho_rock_kg_per_m3: float, depth_m: float) -> PlainQuantity:
-            return quantity(static_pressure_MPa(rho_rock_kg_per_m3, depth_m), 'MPa')
+        return quantity(static_pressure_MPa(self.rhorock.quantity().to('kg/m**3').magnitude,
+                                            self.InputDepth.quantity().to('m').magnitude), 'MPa')

src/geophires_x/Reservoir.py

@@ -286,7 +286,7 @@ def __init__(self, model: Model):
         self.fracnumb = self.ParameterDict[self.fracnumb.Name] = intParameter(
             "Number of Fractures",
             DefaultValue=10,
-            AllowableRange=list(range(1, 21, 1)),
+            AllowableRange=list(range(1, 150, 1)),
             UnitType=Units.NONE,
             ErrMessage="assume default number of fractures (10)",
             ToolTipText="Number of identical parallel fractures in EGS fracture-based reservoir model."
@@ -749,14 +749,12 @@ def Calculate(self, model: Model) -> None:
             # calculate reservoir water properties
             self.cpwater.value = heat_capacity_water_J_per_kg_per_K(
                 model.wellbores.Tinj.value * 0.5 + (self.Trock.value * 0.9 + model.wellbores.Tinj.value * 0.1) * 0.5,
-                pressure=self.lithostatic_pressure(self.rhorock.quantity().to('kg/m**3').magnitude,
-                                            self.depth.quantity().to('m').magnitude)
+                pressure=self.lithostatic_pressure()
             )
 
             self.rhowater.value = density_water_kg_per_m3(
                 model.wellbores.Tinj.value * 0.5 + (self.Trock.value * 0.9 + model.wellbores.Tinj.value * 0.1) * 0.5,
-                pressure=self.lithostatic_pressure(self.rhorock.quantity().to('kg/m**3').magnitude,
-                                            self.depth.quantity().to('m').magnitude)
+                pressure=self.lithostatic_pressure()
             )
 
             # temperature gain in injection wells
@@ -768,7 +766,8 @@ def Calculate(self, model: Model) -> None:
 
         model.logger.info(f'complete {str(__class__)}: {sys._getframe().f_code.co_name}')
 
-    def lithostatic_pressure(self, rho_rock_kg_per_m3: float, depth_m: float) -> PlainQuantity:
-        return quantity(static_pressure_MPa(rho_rock_kg_per_m3, depth_m), 'MPa')
+    def lithostatic_pressure(self) -> PlainQuantity:
+        return quantity(static_pressure_MPa(self.rhorock.quantity().to('kg/m**3').magnitude,
+                                            self.depth.quantity().to('m').magnitude), 'MPa')