Merge pull request NREL#347 from softwareengineerprogrammer/main

Carbon Revenue Profile + Electricity annual revenue profile fix [v3.7.21]

Author: softwareengineerprogrammer

.bumpversion.cfg

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

CHANGELOG.rst

@@ -18,6 +18,12 @@ GEOPHIRES-X (2023-2025)
 
 3.7.6: Fixes bugs pertaining to specifying non-CLGS laterals and display of per-lateral costs.
 
+3.7.21:
+
+1. Carbon Revenue Profile (CCUS Profile `replacement <https://github.com/NREL/GEOPHIRES-X/issues/141>`__) added to client result.
+
+2. Electricity annual revenue profile data `issue <https://github.com/NREL/GEOPHIRES-X/issues/342>`__ resolved.
+
 3.6
 ^^^
 

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.16.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.7.21.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.7.16...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.7.21...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -334,7 +334,7 @@ Example-specific web interface deeplinks are listed in the Link column.
      - `example1.txt <tests/examples/example1.txt>`__
      - `.out <tests/examples/example1.out>`__
      - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example1>`__
-   * - Example 1 with Addons
+   * - Example 1 with Add-Ons
      - `example1_addons.txt <tests/examples/example1_addons.txt>`__
      - `.out <tests/examples/example1_addons.out>`__
      - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example1_addons>`__

docs/conf.py

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

setup.py

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

src/geophires_x/Economics.py

@@ -1523,8 +1523,8 @@ def __init__(self, model: Model):
         self.CarbonPrice = self.OutputParameterDict[self.CarbonPrice.Name] = OutputParameter(
             "Carbon Price Model",
             UnitType=Units.COSTPERMASS,
-            PreferredUnits=CostPerMassUnit.DOLLARSPERTONNE,
-            CurrentUnits=CostPerMassUnit.DOLLARSPERTONNE
+            PreferredUnits=CostPerMassUnit.DOLLARSPERLB,
+            CurrentUnits=CostPerMassUnit.DOLLARSPERLB
         )
 
         self.LCOC = self.OutputParameterDict[self.LCOC.Name] = OutputParameter(
@@ -2804,19 +2804,19 @@ def Calculate(self, model: Model) -> None:
             self.ElecRevenue.value, self.ElecCummRevenue.value = CalculateRevenue(
                 model.surfaceplant.plant_lifetime.value, model.surfaceplant.construction_years.value,
                 model.surfaceplant.NetkWhProduced.value, self.ElecPrice.value)
-            self.TotalRevenue.value = self.ElecRevenue.value
+            self.TotalRevenue.value = self.ElecRevenue.value.copy()
             #self.TotalCummRevenue.value = self.ElecCummRevenue.value
         elif model.surfaceplant.enduse_option.value == EndUseOptions.HEAT and model.surfaceplant.plant_type.value not in [PlantType.ABSORPTION_CHILLER]:
             self.HeatRevenue.value, self.HeatCummRevenue.value = CalculateRevenue(
                 model.surfaceplant.plant_lifetime.value, model.surfaceplant.construction_years.value,
                 model.surfaceplant.HeatkWhProduced.value, self.HeatPrice.value)
-            self.TotalRevenue.value = self.HeatRevenue.value
+            self.TotalRevenue.value = self.HeatRevenue.value.copy()
             #self.TotalCummRevenue.value = self.HeatCummRevenue.value
         elif model.surfaceplant.enduse_option.value == EndUseOptions.HEAT and model.surfaceplant.plant_type.value in [PlantType.ABSORPTION_CHILLER]:
             self.CoolingRevenue.value, self.CoolingCummRevenue.value = CalculateRevenue(
                 model.surfaceplant.plant_lifetime.value, model.surfaceplant.construction_years.value,
                 model.surfaceplant.cooling_kWh_Produced.value, self.CoolingPrice.value)
-            self.TotalRevenue.value = self.CoolingRevenue.value
+            self.TotalRevenue.value = self.CoolingRevenue.value.copy()
             #self.TotalCummRevenue.value = self.CoolingCummRevenue.value
         elif model.surfaceplant.enduse_option.value in [EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT,
                                                         EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICITY,

src/geophires_x/EconomicsAddOns.py

@@ -46,51 +46,62 @@ def __init__(self, model: Model):
         self.MyClass = sclass.replace("\'>", "")
         self.MyPath = os.path.abspath(__file__)
 
+        def multi_addon_tooltip_text(param_name: str) -> str:
+            return (f'If using multiple add-ons: either (1) specify this value as an array or '
+                    f'(2) use multiple parameters suffixed with a number '
+                    f'e.g. \'{param_name} 1\', \'{param_name} 2\', etc.')
+
         self.AddOnNickname = self.ParameterDict[self.AddOnNickname.Name] = listParameter(
             "AddOn Nickname",
             UnitType=Units.NONE,
             Min=0.0,
-            Max=1000.0
+            Max=1000.0,
+            ToolTipText=multi_addon_tooltip_text("AddOn Nickname")
         )
         self.AddOnCAPEX = self.ParameterDict[self.AddOnCAPEX.Name] = listParameter(
             "AddOn CAPEX",
             Min=0.0,
             Max=1000.0,
             UnitType=Units.CURRENCY,
             PreferredUnits=CurrencyUnit.MDOLLARS,
-            CurrentUnits=CurrencyUnit.MDOLLARS
+            CurrentUnits=CurrencyUnit.MDOLLARS,
+            ToolTipText=multi_addon_tooltip_text("AddOn CAPEX")
         )
         self.AddOnOPEXPerYear = self.ParameterDict[self.AddOnOPEXPerYear.Name] = listParameter(
             "AddOn OPEX",
             Min=0.0,
             Max=1000.0,
             UnitType=Units.CURRENCYFREQUENCY,
             PreferredUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
-            CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR
+            CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
+            ToolTipText=f'Annual operating cost. {multi_addon_tooltip_text("AddOn OPEX")}'
         )
         self.AddOnElecGainedPerYear = self.ParameterDict[self.AddOnElecGainedPerYear.Name] = listParameter(
             "AddOn Electricity Gained",
             Min=0.0,
             Max=1000.0,
             UnitType=Units.ENERGYFREQUENCY,
             PreferredUnits=EnergyFrequencyUnit.KWPERYEAR,
-            CurrentUnits=EnergyFrequencyUnit.KWPERYEAR
+            CurrentUnits=EnergyFrequencyUnit.KWPERYEAR,
+            ToolTipText=f'Annual electricity gained. {multi_addon_tooltip_text("AddOn Electricity Gained")}'
         )
         self.AddOnHeatGainedPerYear = self.ParameterDict[self.AddOnHeatGainedPerYear.Name] = listParameter(
             "AddOn Heat Gained",
             Min=0.0,
             Max=1000.0,
             UnitType=Units.ENERGYFREQUENCY,
             PreferredUnits=EnergyFrequencyUnit.KWPERYEAR,
-            CurrentUnits=EnergyFrequencyUnit.KWPERYEAR
+            CurrentUnits=EnergyFrequencyUnit.KWPERYEAR,
+            ToolTipText=f'Annual heat gained. {multi_addon_tooltip_text("AddOn Heat Gained")}'
         )
         self.AddOnProfitGainedPerYear = self.ParameterDict[self.AddOnProfitGainedPerYear.Name] = listParameter(
             "AddOn Profit Gained",
             Min=0.0,
             Max=1000.0,
             UnitType=Units.CURRENCYFREQUENCY,
             PreferredUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
-            CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR
+            CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
+            ToolTipText=f'Annual profit gained. {multi_addon_tooltip_text("AddOn Profit Gained")}'
         )
 
         # local variables that need initialization
@@ -99,7 +110,7 @@ def __init__(self, model: Model):
             "AddOn CAPEX Total",
             UnitType=Units.CURRENCY,
             PreferredUnits=CurrencyUnit.MDOLLARS,
-            CurrentUnits=CurrencyUnit.MDOLLARS
+            CurrentUnits=CurrencyUnit.MDOLLARS,
         )
         self.AddOnOPEXTotalPerYear = self.OutputParameterDict[self.AddOnOPEXTotalPerYear.Name] = OutputParameter(
             "AddOn OPEX Total Per Year",
@@ -242,7 +253,7 @@ def read_parameters(self, model: Model) -> None:
             if key.startswith("AddOn Profit Gained"):
                 val = float(model.InputParameters[key].sValue)
                 self.AddOnProfitGainedPerYear.value.append(val)  # this assumes they put the values in the file in consecutive fashion
-        model.logger.info("complete " + str(__class__) + ": " + sys._getframe().f_code.co_name)
+        model.logger.info(f"complete {__class__!s}: {sys._getframe().f_code.co_name}")
 
     def Calculate(self, model: Model) -> None:
         """