Merge pull request NREL#336 from softwareengineerprogrammer/main

Fix lateral cost output, add missing result fields [v3.7.13]

Author: softwareengineerprogrammer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.7.6
+current_version = 3.7.13
 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.7.6
+    version: 3.7.13
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

README.rst

@@ -56,9 +56,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.7.6.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.7.13.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.7.6...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.7.13...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -298,6 +298,9 @@ The capital and O&M costs for the different geothermal system components (explor
 well drilling, surface plant, etc.) are either provided by the user or calculated with built-in
 correlations.
 
+For more information on the theoretical basis for GEOPHIRES see
+`GEOPHIRES v2.0: updated geothermal techno‐economic simulation tool (Beckers & McCabe, 2019) <References/Beckers%202019%20GEOPHIRES%20v2.pdf>`__.
+
 Parameters
 ----------
 
@@ -496,9 +499,6 @@ Extending GEOPHIRES-X
 Additional Documentation
 ------------------------
 
-Theoretical basis for GEOPHIRES:  `GEOPHIRES v2.0: updated geothermal techno‐economic simulation tool <References/Beckers%202019%20GEOPHIRES%20v2.pdf>`__;
-accompanying `GEOPHIRES v2.0 user manual <References/GEOPHIRES%20v2.0%20User%20Manual.pdf>`__.
-
 Additional materials can be found in `/References </References>`__.
 
 

docs/conf.py

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

setup.py

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

src/geophires_x/Outputs.py

@@ -1742,8 +1742,11 @@ def PrintOutputs(self, model: Model):
                         f.write(f'      Number of fractures:                              {model.reserv.fracnumbcalc.value:10.2f}' + NL)
                         f.write(f'      Fracture separation:                              {model.reserv.fracsepcalc.value:10.2f} ' + model.reserv.fracsep.CurrentUnits.value + NL)
                     f.write(f'      Reservoir volume:                              {model.reserv.resvolcalc.value:10.0f} ' + model.reserv.resvol.CurrentUnits.value + NL)
+
                     if model.wellbores.impedancemodelused.value:
-                        f.write(f'      Reservoir impedance:                              {model.wellbores.impedance.value/1000:10.2f} ' + model.wellbores.impedance.CurrentUnits.value + NL)
+                        # See note re: unit conversion:
+                        # https://github.com/NREL/GEOPHIRES-X/blob/d51eb8d1dc8b21c7a79c4d35f296d740347658e0/src/geophires_x/WellBores.py#L1280-L1282
+                        f.write(f'      Reservoir impedance:                              {model.wellbores.impedance.value/1000:10.4f} {model.wellbores.impedance.CurrentUnits.value}\n')
                     else:
                         if model.wellbores.overpressure_percentage.Provided:
                             # write the reservoir pressure as an average in the overpressure case
@@ -1803,14 +1806,14 @@ def PrintOutputs(self, model: Model):
                 f.write(NL)
                 if not model.economics.totalcapcost.Valid:
                     f.write(f'         Drilling and completion costs:                 {model.economics.Cwell.value:10.2f} ' + model.economics.Cwell.CurrentUnits.value + NL)
-                    if round(econ.cost_one_production_well.value, 4) != round(econ.cost_one_injection_well.value, 4) and \
-                            model.economics.cost_one_injection_well.value != -1:
-                        f.write(f'             Drilling and completion costs per production well:   {econ.cost_one_production_well.value:10.2f} ' + econ.cost_one_production_well.CurrentUnits.value + NL)
-                        f.write(f'             Drilling and completion costs per injection well:    {econ.cost_one_injection_well.value:10.2f} ' + econ.cost_one_injection_well.CurrentUnits.value + NL)
-                    elif econ.cost_lateral_section.value > 0.0:
+                    if econ.cost_lateral_section.value > 0.0:
                         f.write(f'             Drilling and completion costs per vertical production well:   {econ.cost_one_production_well.value:10.2f} ' + econ.cost_one_production_well.CurrentUnits.value + NL)
                         f.write(f'             Drilling and completion costs per vertical injection well:    {econ.cost_one_injection_well.value:10.2f} ' + econ.cost_one_injection_well.CurrentUnits.value + NL)
                         f.write(f'             {econ.cost_per_lateral_section.Name}:       {econ.cost_per_lateral_section.value:10.2f} {econ.cost_lateral_section.CurrentUnits.value}\n')
+                    elif round(econ.cost_one_production_well.value, 4) != round(econ.cost_one_injection_well.value, 4) and \
+                            model.economics.cost_one_injection_well.value != -1:
+                        f.write(f'             Drilling and completion costs per production well:   {econ.cost_one_production_well.value:10.2f} ' + econ.cost_one_production_well.CurrentUnits.value + NL)
+                        f.write(f'             Drilling and completion costs per injection well:    {econ.cost_one_injection_well.value:10.2f} ' + econ.cost_one_injection_well.CurrentUnits.value + NL)
                     else:
                         f.write(f'         Drilling and completion costs per well:        {model.economics.Cwell.value/(model.wellbores.nprod.value+model.wellbores.ninj.value):10.2f} ' + model.economics.Cwell.CurrentUnits.value + NL)
                     f.write(f'         Stimulation costs:                             {model.economics.Cstim.value:10.2f} ' + model.economics.Cstim.CurrentUnits.value + NL)

src/geophires_x/WellBores.py

@@ -749,17 +749,17 @@ def __init__(self, model: Model):
             CurrentUnits=LengthUnit.INCHES,
             Required=True,
             ErrMessage="assume default injection well diameter (8 inch)",
-            ToolTipText="Inner diameter of production wellbore (assumed constant along the wellbore) to calculate \
-            frictional pressure drop and wellbore heat transmission with Rameys model"
+            ToolTipText="Inner diameter of production wellbore (assumed constant along the wellbore) to calculate "
+                        "frictional pressure drop and wellbore heat transmission with Rameys model"
         )
         self.rameyoptionprod = self.ParameterDict[self.rameyoptionprod.Name] = boolParameter(
             "Ramey Production Wellbore Model",
             DefaultValue=True,
             UnitType=Units.NONE,
             Required=True,
             ErrMessage="assume default production wellbore model (Ramey model active)",
-            ToolTipText="Select whether to use Rameys model to estimate the geofluid temperature drop in the \
-            production wells"
+            ToolTipText="Select whether to use Rameys model to estimate the geofluid temperature drop in the "
+                        "production wells"
         )
         self.tempdropprod = self.ParameterDict[self.tempdropprod.Name] = floatParameter(
             "Production Wellbore Temperature Drop",
@@ -796,16 +796,20 @@ def __init__(self, model: Model):
         )
         self.impedance = self.ParameterDict[self.impedance.Name] = floatParameter(
             "Reservoir Impedance",
+
+            # Note default/input value units are converted as a special case in read_parameters; see
+            # https://github.com/NREL/GEOPHIRES-X/blob/d51eb8d1dc8b21c7a79c4d35f296d740347658e0/src/geophires_x/WellBores.py#L1280-L1282
             DefaultValue=1000.0,
+
             Min=1E-4,
             Max=1E4,
             UnitType=Units.IMPEDANCE,
             PreferredUnits=ImpedanceUnit.GPASPERM3,
             CurrentUnits=ImpedanceUnit.GPASPERM3,
             ErrMessage="assume default reservoir impedance (0.1 GPa*s/m^3)",
-            ToolTipText="Reservoir resistance to flow per well-pair. For EGS-type reservoirs when the injection well \
-            is in hydraulic communication with the production well, this parameter specifies the overall pressure drop \
-            in the reservoir between injection well and production well (see docs)"
+            ToolTipText="Reservoir resistance to flow per well-pair. For EGS-type reservoirs when the injection well "
+                        "is in hydraulic communication with the production well, this parameter specifies the overall "
+                        "pressure drop in the reservoir between injection well and production well (see docs)"
         )
         self.wellsep = self.ParameterDict[self.wellsep.Name] = floatParameter(
             "Well Separation",
@@ -839,8 +843,8 @@ def __init__(self, model: Model):
             PreferredUnits=PressureUnit.KPASCAL,
             CurrentUnits=PressureUnit.KPASCAL,
             ErrMessage="calculate reservoir hydrostatic pressure using built-in correlation",
-            ToolTipText="Reservoir hydrostatic far-field pressure.  Default value is calculated with built-in modified \
-            Xie-Bloomfield-Shook equation (DOE, 2016)."
+            ToolTipText="Reservoir hydrostatic far-field pressure.  Default value is calculated with built-in modified "
+                        "Xie-Bloomfield-Shook equation (DOE, 2016)."
         )
         self.ppwellhead = self.ParameterDict[self.ppwellhead.Name] = floatParameter(
             "Production Wellhead Pressure",
@@ -862,8 +866,8 @@ def __init__(self, model: Model):
             PreferredUnits=InjectivityIndexUnit.KGPERSECPERBAR,
             CurrentUnits=InjectivityIndexUnit.KGPERSECPERBAR,
             ErrMessage="assume default injectivity index (10 kg/s/bar)",
-            ToolTipText="Injectivity index defined as ratio of injection well flow rate over injection well outflow \
-            pressure drop (flowing bottom hole pressure - hydrostatic reservoir pressure)."
+            ToolTipText="Injectivity index defined as ratio of injection well flow rate over injection well outflow "
+                        "pressure drop (flowing bottom hole pressure - hydrostatic reservoir pressure)."
         )
         self.PI = self.ParameterDict[self.PI.Name] = floatParameter(
             "Productivity Index",
@@ -874,8 +878,8 @@ def __init__(self, model: Model):
             PreferredUnits=ProductivityIndexUnit.KGPERSECPERBAR,
             CurrentUnits=ProductivityIndexUnit.KGPERSECPERBAR,
             ErrMessage="assume default productivity index (10 kg/s/bar)",
-            ToolTipText="Productivity index defined as ratio of production well flow rate over production well inflow \
-            pressure drop (see docs)"
+            ToolTipText="Productivity index defined as ratio of production well flow rate over production well inflow "
+                        "pressure drop (see docs)"
         )
         self.maxdrawdown = self.ParameterDict[self.maxdrawdown.Name] = floatParameter(
             "Maximum Drawdown",
@@ -886,10 +890,10 @@ def __init__(self, model: Model):
             PreferredUnits=PercentUnit.TENTH,
             CurrentUnits=PercentUnit.TENTH,
             ErrMessage="assume default maximum drawdown (1)",
-            ToolTipText="Maximum allowable thermal drawdown before redrilling of all wells into new reservoir \
-            (most applicable to EGS-type reservoirs with heat farming strategies). E.g. a value of 0.2 means that \
-            all wells are redrilled after the production temperature (at the wellhead) has dropped by 20% of \
-            its initial temperature"
+            ToolTipText="Maximum allowable thermal drawdown before redrilling of all wells into new reservoir "
+                        "(most applicable to EGS-type reservoirs with heat farming strategies). E.g. a value of 0.2 "
+                        "means that all wells are redrilled after the production temperature (at the wellhead) has "
+                        "dropped by 20% of its initial temperature"
         )
         self.IsAGS = self.ParameterDict[self.IsAGS.Name] = boolParameter(
             "Is AGS",
@@ -946,7 +950,8 @@ def __init__(self, model: Model):
             PreferredUnits=PressureUnit.KPASCAL,
             CurrentUnits=PressureUnit.KPASCAL,
             Required=False,
-            ErrMessage="assume there is not an injection reservoir, so there is no injection reservoir initial pressure",
+            ErrMessage="assume there is not an injection reservoir, so there is no injection reservoir initial "
+                       "pressure",
             ToolTipText="enter the depth of the injection reservoir initial pressure (use lithostatic pressure)"
         )
         self.injection_reservoir_inflation_rate = self.ParameterDict[self.injection_reservoir_inflation_rate.Name] = floatParameter(
@@ -956,7 +961,8 @@ def __init__(self, model: Model):
             CurrentUnits=Inflation_RateUnit.KPASCALPERYEAR,
             Required=False,
             ErrMessage="assume there is not an injection reservoir, so there is no injection reservoir inflation rate",
-            ToolTipText="enter the rate at which the pressure increases per year in the injection reservoir (1000 kPa/yr)"
+            ToolTipText="enter the rate at which the pressure increases per year in the injection reservoir "
+                        "(1000 kPa/yr)"
         )
         # This is a alias for "Well Geometry Configuration" - putting it here for backwards compatibility
         self.Configuration = self.ParameterDict[self.Configuration.Name] = intParameter(
@@ -1275,7 +1281,8 @@ def read_parameters(self, model: Model) -> None:
                     # impedance: impedance per well pair (input as GPa*s/m^3 and converted to KPa/kg/s
                     # (assuming 1000 for density; density will be corrected for later))
                     elif ParameterToModify.Name == "Reservoir Impedance":
-                        # shift it by a constant to make the units right, per line 619 of GEOPHIRES 2
+                        # shift it by a constant to make the units right, per line 619 of GEOPHIRES 2:
+                        # https://github.com/NREL/GEOPHIRES-v2/blob/08485b98ae02aeb7a5acd972f906b2ea81ae2647/GEOPHIRESv2.py#L610-L619
                         self.impedance.value = self.impedance.value * (1E6 / 1E3)
                         self.impedancemodelused.value = True
                         if self.impedance.Provided is False:

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.7.6'
+__version__ = '3.7.13'

src/geophires_x_client/geophires_x_result.py

@@ -143,10 +143,15 @@ class GeophiresXResult:
                 # TODO moved to power generation profile, parse from there
                 #  'Annual Thermal Drawdown (%/year)',
                 'Bottom-hole temperature',
+                'Well separation: fracture diameter',
                 'Well separation: fracture height',
-                'Fracture area',
                 'Fracture width',
+                'Fracture area',
+                'Number of fractures',
+                'Fracture separation',
+                # TODO reservoir volume note
                 'Reservoir volume',
+                'Reservoir impedance',
                 'Reservoir hydrostatic pressure',
                 'Average reservoir pressure',
                 'Plant outlet pressure',
@@ -166,10 +171,16 @@ class GeophiresXResult:
                 'Initial Production Temperature',
                 'Average Reservoir Heat Extraction',
                 _EqualSignDelimitedField('Production Wellbore Heat Transmission Model'),
+                _EqualSignDelimitedField('Wellbore Heat Transmission Model'),
                 'Average Production Well Temperature Drop',
+                'Total Average Pressure Drop',
+                'Average Injection Well Pressure Drop',
+                'Average Production Pressure',  # AGS
+                'Average Reservoir Pressure Drop',
+                'Average Production Well Pressure Drop',
+                'Average Buoyancy Pressure Drop',
                 'Average Injection Well Pump Pressure Drop',
                 'Average Production Well Pump Pressure Drop',
-                'Average Production Pressure',
                 'Average Heat Production',
                 'First Year Heat Production',
                 'Average Net Electricity Production',
@@ -187,7 +198,6 @@ class GeophiresXResult:
                 'Average Annual Heat Supplied',
                 'Minimum Annual Heat Supplied',
                 'Average Round-Trip Efficiency',
-                'Total Average Pressure Drop',
             ],
             'CAPITAL COSTS (M$)': [
                 'Drilling and completion costs',
@@ -477,7 +487,7 @@ def normalize_spaces(matched_line):
         return {'value': self._parse_number(str_val, field=f'field "{field_name}"'), 'unit': unit}
 
     def _get_equal_sign_delimited_field(self, field_name):
-        metadata_marker = f'{field_name} = '
+        metadata_marker = f'  {field_name} = '
         matching_lines = set(filter(lambda line: metadata_marker in line, self._lines))
 
         if len(matching_lines) == 0:

src/geophires_x_schema_generator/__init__.py

@@ -27,6 +27,7 @@
 from geophires_x.SUTRAReservoir import SUTRAReservoir
 from geophires_x.SUTRAWellBores import SUTRAWellBores
 from geophires_x.TDPReservoir import TDPReservoir
+from geophires_x.TOUGH2Reservoir import TOUGH2Reservoir
 from hip_ra_x.hip_ra_x import HIP_RA_X
 
 
@@ -60,6 +61,7 @@ def get_parameter_sources(self) -> list:
             (CylindricalReservoir(dummy_model), 'Reservoir'),
             (SBTReservoir(dummy_model), 'Reservoir'),
             (SUTRAReservoir(dummy_model), 'Reservoir'),
+            (TOUGH2Reservoir(dummy_model), 'Reservoir'),
             (dummy_model.wellbores, 'Well Bores'),
             (AGSWellBores(dummy_model), 'Well Bores'),
             (SBTWellbores(dummy_model), 'Well Bores'),