Merge pull request #95 from softwareengineerprogrammer/well-diameter-outputs

Well diameter outputs, surface plant cost, non-SAM-EM Inflation costs during construction [v3.9.48]

Author: softwareengineerprogrammer

.bumpversion.cfg

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

README.rst

@@ -58,9 +58,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.47.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.9.48.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.47...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.48...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X

docs/conf.py

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

setup.py

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

src/geophires_x/AGSWellBores.py

@@ -1028,6 +1028,8 @@ def Calculate(self, model: Model) -> None:
             # (b/c we are not generating electricity) = thermosiphon is happening!
             self.PumpingPower.value = [max(x, 0.) for x in self.PumpingPower.value]
 
+        self._sync_output_params_from_input_params()
+
         model.logger.info(f'complete {str(__class__)}: {sys._getframe().f_code.co_name}')
 
     def __str__(self):

src/geophires_x/Economics.py

@@ -139,8 +139,8 @@ def total_capex_parameter_output_parameter() -> OutputParameter:
         UnitType=Units.CURRENCY,
         CurrentUnits=CurrencyUnit.MDOLLARS,
         PreferredUnits=CurrencyUnit.MDOLLARS,
-        ToolTipText="The total capital expenditure (CAPEX) required to construct the plant. "
-                    "This value includes all direct and indirect costs, contingency, and any cost escalation from "
-                    "inflation during construction. It is used as the total installed cost input for "
-                    "SAM Economic Models."
+        ToolTipText='The total capital expenditure (CAPEX) required to construct the plant. '
+                    'This value includes all direct and indirect costs, and contingency. '
+                    'For SAM Economic models, it also includes any cost escalation from inflation during construction. '
+                    'It is used as the total installed cost input for SAM Economic Models.'
     )

src/geophires_x/EconomicsUtils.py

@@ -274,6 +274,20 @@ def PrintOutputs(self, model: Model):
                 acf_label = Outputs._field_label(acf.display_name, 49)
                 f.write(f'      {acf_label}{acf.value:10.2f} {acf.CurrentUnits.value}\n')
 
+                display_inflation_costs_in_economic_parameters: bool = (
+                    econ.econmodel.value in [EconomicModel.BICYCLE,
+                                             EconomicModel.FCR,
+                                             EconomicModel.STANDARDIZED_LEVELIZED_COST]
+                    and
+                    econ.inflation_cost_during_construction.value != 0.
+                )
+                if display_inflation_costs_in_economic_parameters:
+                    # Inflation cost is displayed here for economic models that don't treat inflation cost as a
+                    # capital cost
+                    icc: OutputParameter = econ.inflation_cost_during_construction
+                    icc_label = Outputs._field_label(icc.display_name, 49)
+                    f.write(f'      {icc_label}{icc.value:10.2f} {icc.CurrentUnits.value}\n')
+
                 f.write(f'      Project lifetime:                              {model.surfaceplant.plant_lifetime.value:10.0f} {model.surfaceplant.plant_lifetime.CurrentUnits.value}\n')
                 f.write(f'      Capacity factor:                                 {model.surfaceplant.utilization_factor.value * 100:10.1f} %\n')
 
@@ -327,8 +341,8 @@ def PrintOutputs(self, model: Model):
                     f.write('      User-provided production well temperature drop\n')
                     f.write(f'      Constant production well temperature drop:       {model.wellbores.tempdropprod.value:10.1f} ' + model.wellbores.tempdropprod.PreferredUnits.value + NL)
                 f.write(f'      Flowrate per production well:                    {model.wellbores.prodwellflowrate.value:10.1f} ' + model.wellbores.prodwellflowrate.CurrentUnits.value + NL)
-                f.write(f'      Injection well casing ID:                          {model.wellbores.injwelldiam.value:10.3f} ' + model.wellbores.injwelldiam.CurrentUnits.value + NL)
-                f.write(f'      Production well casing ID:                         {model.wellbores.prodwelldiam.value:10.3f} ' + model.wellbores.prodwelldiam.CurrentUnits.value + NL)
+                f.write(f'      {model.wellbores.injection_well_casing_inner_diameter.display_name}:                          {model.wellbores.injection_well_casing_inner_diameter.value:10.3f} {model.wellbores.injection_well_casing_inner_diameter.CurrentUnits.value}\n')
+                f.write(f'      {model.wellbores.production_well_casing_inner_diameter.display_name}:                         {model.wellbores.production_well_casing_inner_diameter.value:10.3f} {model.wellbores.production_well_casing_inner_diameter.CurrentUnits.value}\n')
                 f.write(f'      {model.wellbores.redrill.display_name}:                    {model.wellbores.redrill.value:10.0f}\n')
                 if model.surfaceplant.enduse_option.value in [EndUseOptions.ELECTRICITY, EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT, EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICITY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICITY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICITY]:
                     f.write('      Power plant type:                                       ' + str(model.surfaceplant.plant_type.value.value) + NL)
@@ -497,8 +511,8 @@ def PrintOutputs(self, model: Model):
                         #  expenditure.
                         pass
 
-                if is_sam_econ_model:
-                    # TODO calculate & display for other economic models
+                display_inflation_during_construction_in_capital_costs = is_sam_econ_model
+                if display_inflation_during_construction_in_capital_costs:
                     icc_label = Outputs._field_label(econ.inflation_cost_during_construction.display_name, 47)
                     f.write(f'         {icc_label}{econ.inflation_cost_during_construction.value:10.2f} {econ.inflation_cost_during_construction.CurrentUnits.value}\n')
 

src/geophires_x/Outputs.py

@@ -286,6 +286,8 @@ def Calculate(self, model: Model) -> None:
         # (b/c we are not generating electricity) = thermosiphon is happening!
         self.PumpingPower.value = [max(x, 0.) for x in self.PumpingPower.value]
 
+        self._sync_output_params_from_input_params()
+
         model.logger.info(f'complete {str(__class__)}: {sys._getframe().f_code.co_name}')
 
     def CalculateNonverticalPressureDrop(self, model, value, time_max, al):