Merge pull request #79 from softwareengineerprogrammer/immutable-geophires-input-parameters

Client caching fix (ImmutableGeophiresInputParameters); Fervo_Project_Cape-4 Multilaterals & Reservoir Volume

Author: softwareengineerprogrammer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.9.19
+current_version = 3.9.26
 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.9.19
+    version: 3.9.26
     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.9.19.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.9.26.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.19...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.26...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X

docs/Fervo_Project_Cape-4.md

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

docs/conf.py

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

setup.py

@@ -1125,17 +1125,17 @@ def __init__(self, model: Model):
             ErrMessage="assume default peaking boiler efficiency (85%)",
             ToolTipText="Peaking boiler efficiency"
         )
-        self._default_peaking_boiler_cost_USD_per_kw = 65
-        self.peaking_boiler_cost_per_kw = self.ParameterDict[self.peaking_boiler_cost_per_kw.Name] = floatParameter(
-            "Peaking Boiler Cost per KW",
-            DefaultValue=self._default_peaking_boiler_cost_USD_per_kw,
+        self._default_peaking_boiler_cost_USD_per_kW = 65
+        self.peaking_boiler_cost_per_kW = self.ParameterDict[self.peaking_boiler_cost_per_kW.Name] = floatParameter(
+            "Peaking Boiler Cost per kW",
+            DefaultValue=self._default_peaking_boiler_cost_USD_per_kW,
             Min=0,
             Max=1000,
             UnitType=Units.ENERGYCOST,
             PreferredUnits=EnergyCostUnit.DOLLARSPERKW,
             CurrentUnits=EnergyCostUnit.DOLLARSPERKW,
             Required=False,
-            ToolTipText="Peaking boiler cost per KW of maximum peaking boiler demand"
+            ToolTipText="Peaking boiler cost per kW of maximum peaking boiler demand"
         )
         self.dhpipingcostrate = self.ParameterDict[self.dhpipingcostrate.Name] = floatParameter(
             "District Heating Piping Cost Rate",
@@ -1633,18 +1633,29 @@ def __init__(self, model: Model):
                         f'Provide {self.ccexplfixed.Name} to override the default correlation and set your own cost.'
         )
 
+        # noinspection SpellCheckingInspection
         self.Cwell = self.OutputParameterDict[self.Cwell.Name] = OutputParameter(
             Name="Wellfield cost",
             display_name='Drilling and completion costs',
             UnitType=Units.CURRENCY,
             PreferredUnits=CurrencyUnit.MDOLLARS,
             CurrentUnits=CurrencyUnit.MDOLLARS,
 
-            # See TODO re:parameterizing indirect costs at src/geophires_x/Economics.py:652
-            #    (https://github.com/NREL/GEOPHIRES-X/issues/383)
+            # TODO https://github.com/NREL/GEOPHIRES-X/issues/383?title=Parameterize+indirect+cost+factor
             ToolTipText="Includes total drilling and completion cost of all injection and production wells and "
                         "laterals, plus 5% indirect costs."
         )
+        self.drilling_and_completion_costs_per_well = self.OutputParameterDict[
+            self.drilling_and_completion_costs_per_well.Name] = OutputParameter(
+            Name='Drilling and completion costs per well',
+            UnitType=Units.CURRENCY,
+            PreferredUnits=CurrencyUnit.MDOLLARS,
+            CurrentUnits=CurrencyUnit.MDOLLARS,
+
+            # TODO https://github.com/NREL/GEOPHIRES-X/issues/383?title=Parameterize+indirect+cost+factor
+            ToolTipText='Includes total drilling and completion cost per well, '
+                        'including injection and production wells and laterals, plus 5% indirect costs.'
+        )
         self.Coamwell = self.OutputParameterDict[self.Coamwell.Name] = OutputParameter(
             Name="O&M Wellfield cost",
             display_name='Wellfield maintenance costs',
@@ -1722,9 +1733,9 @@ def __init__(self, model: Model):
             UnitType=Units.CURRENCY,
             PreferredUnits=CurrencyUnit.MDOLLARS,
             CurrentUnits=CurrencyUnit.MDOLLARS,
-            ToolTipText=f'Default cost: ${self._default_peaking_boiler_cost_USD_per_kw}/KW '
+            ToolTipText=f'Default cost: ${self._default_peaking_boiler_cost_USD_per_kW}/KW '
                         f'of maximum peaking boiler demand. '
-                        f'Provide {self.peaking_boiler_cost_per_kw.Name} override the default.'
+                        f'Provide {self.peaking_boiler_cost_per_kW.Name} override the default.'
         )
 
         self.dhdistrictcost = self.OutputParameterDict[self.dhdistrictcost.Name] = OutputParameter(
@@ -2313,7 +2324,9 @@ def Calculate(self, model: Model) -> None:
             else:
                 self.cost_lateral_section.value = 0.0
             # cost of the well field
-            # 1.05 for 5% indirect costs - see TODO re:parameterizing at src/geophires_x/Economics.py:652
+
+            # 1.05 for 5% indirect costs
+            # TODO https://github.com/NREL/GEOPHIRES-X/issues/383?title=Parameterize+indirect+cost+factor
             self.Cwell.value = 1.05 * ((self.cost_one_production_well.value * model.wellbores.nprod.value) +
                                           (self.cost_one_injection_well.value * model.wellbores.ninj.value) +
                                           self.cost_lateral_section.value)
@@ -2685,7 +2698,7 @@ def calculate_plant_costs(self, model:Model) -> None:
                     model.surfaceplant.HeatExtracted.value) * 1000.
 
                 # add 65$/KW for peaking boiler
-                self.peakingboilercost.value = (self.peaking_boiler_cost_per_kw.quantity()
+                self.peakingboilercost.value = (self.peaking_boiler_cost_per_kW.quantity()
                                                 .to('USD / kilowatt').magnitude
                                                 * model.surfaceplant.max_peaking_boiler_demand.value / 1000)
 
@@ -2972,6 +2985,7 @@ def calculate_cashflow(self, model: Model) -> None:
             for i in range(1, model.surfaceplant.plant_lifetime.value + model.surfaceplant.construction_years.value, 1):
                 self.TotalCummRevenue.value[i] = self.TotalCummRevenue.value[i-1] + self.TotalRevenue.value[i]
 
+    # noinspection SpellCheckingInspection
     def _calculate_derived_outputs(self, model: Model) -> None:
         """
         Subclasses should call _calculate_derived_outputs at the end of their Calculate methods to populate output
@@ -2988,5 +3002,11 @@ def _calculate_derived_outputs(self, model: Model) -> None:
             self.real_discount_rate.value = self.discountrate.quantity().to(convertible_unit(
                 self.real_discount_rate.CurrentUnits)).magnitude
 
+        if hasattr(self, 'Cwell') and hasattr(model.wellbores, 'nprod') and hasattr(model.wellbores, 'ninj'):
+            self.drilling_and_completion_costs_per_well.value = (
+                self.Cwell.value /
+                (model.wellbores.nprod.value + model.wellbores.ninj.value)
+            )
+
     def __str__(self):
         return "Economics"

src/geophires_x/Economics.py

@@ -38,10 +38,10 @@
     project_vir_parameter,
     project_payback_period_parameter,
 )
-from geophires_x.GeoPHIRESUtils import is_float, is_int
+from geophires_x.GeoPHIRESUtils import is_float, is_int, sig_figs
 from geophires_x.OptionList import EconomicModel, EndUseOptions
 from geophires_x.Parameter import Parameter, OutputParameter, floatParameter
-from geophires_x.Units import convertible_unit, EnergyCostUnit, CurrencyUnit, Units, PercentUnit
+from geophires_x.Units import convertible_unit, EnergyCostUnit, CurrencyUnit, Units
 
 
 @dataclass
@@ -162,7 +162,7 @@ def calculate_sam_economics(model: Model) -> SamEconomicsCalculations:
     cash_flow = _calculate_sam_economics_cash_flow(model, single_owner)
 
     def sf(_v: float, num_sig_figs: int = 5) -> float:
-        return _sig_figs(_v, num_sig_figs)
+        return sig_figs(_v, num_sig_figs)
 
     sam_economics: SamEconomicsCalculations = SamEconomicsCalculations(sam_cash_flow_profile=cash_flow)
     sam_economics.lcoe_nominal.value = sf(single_owner.Outputs.lcoe_nom)
@@ -435,21 +435,3 @@ def _ppa_pricing_model(
 
 def _get_max_total_generation_kW(model: Model) -> float:
     return np.max(model.surfaceplant.ElectricityProduced.quantity().to(convertible_unit('kW')).magnitude)
-
-
-def _sig_figs(val: float | list | tuple, num_sig_figs: int) -> float:
-    """
-    TODO move to utilities, probably
-    """
-
-    if val is None:
-        return None
-
-    if isinstance(val, list) or isinstance(val, tuple):
-        return [_sig_figs(v, num_sig_figs) for v in val]
-
-    try:
-        return float('%s' % float(f'%.{num_sig_figs}g' % val))  # pylint: disable=consider-using-f-string
-    except TypeError:
-        # TODO warn
-        return val

src/geophires_x/EconomicsSam.py

@@ -642,3 +642,16 @@ def is_float(o: Any) -> bool:
     else:
         return True
 
+
+def sig_figs(val: float | list | tuple, num_sig_figs: int) -> float:
+    if val is None:
+        return None
+
+    if isinstance(val, list) or isinstance(val, tuple):
+        return [sig_figs(v, num_sig_figs) for v in val]
+
+    try:
+        return float('%s' % float(f'%.{num_sig_figs}g' % val))  # pylint: disable=consider-using-f-string
+    except TypeError:
+        # TODO warn
+        return val

src/geophires_x/GeoPHIRESUtils.py

@@ -458,7 +458,8 @@ def PrintOutputs(self, model: Model):
                         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)
+                        cpw_label = Outputs._field_label(econ.drilling_and_completion_costs_per_well.display_name, 47)
+                        f.write(f'         {cpw_label}{econ.drilling_and_completion_costs_per_well.value:10.2f} {econ.Cwell.CurrentUnits.value}\n')
                     f.write(f'         {econ.Cstim.display_name}:                             {econ.Cstim.value:10.2f} {econ.Cstim.CurrentUnits.value}\n')
                     f.write(f'         Surface power plant costs:                     {model.economics.Cplant.value:10.2f} ' + model.economics.Cplant.CurrentUnits.value + NL)
                     if model.surfaceplant.plant_type.value == PlantType.ABSORPTION_CHILLER: