Define dedicated Total CAPEX output parameter, with tooltip text, for SAM-EM isntead of changing display name of Economics.CCap.

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -9,7 +9,8 @@
 from geophires_x.EconomicsSam import calculate_sam_economics, SamEconomicsCalculations
 from geophires_x.EconomicsUtils import BuildPricingModel, wacc_output_parameter, nominal_discount_rate_parameter, \
     real_discount_rate_parameter, after_tax_irr_parameter, moic_parameter, project_vir_parameter, \
-    project_payback_period_parameter, inflation_cost_during_construction_output_parameter
+    project_payback_period_parameter, inflation_cost_during_construction_output_parameter, \
+    total_capex_parameter_output_parameter
 from geophires_x.GeoPHIRESUtils import quantity
 from geophires_x.OptionList import Configuration, WellDrillingCostCorrelation, EconomicModel, EndUseOptions, PlantType, \
     _WellDrillingCostCorrelationCitation
@@ -1831,8 +1832,10 @@ def __init__(self, model: Model):
             display_name='Total capital costs',
             UnitType=Units.CURRENCY,
             PreferredUnits=CurrencyUnit.MDOLLARS,
-            CurrentUnits=CurrencyUnit.MDOLLARS
+            CurrentUnits=CurrencyUnit.MDOLLARS,
         )
+        self.capex_total = self.OutputParameterDict[self.capex_total.Name] = total_capex_parameter_output_parameter()
+
         # noinspection SpellCheckingInspection
         self.Coam = self.OutputParameterDict[self.Coam.Name] = OutputParameter(
             Name="Total O&M Cost",
@@ -2583,10 +2586,12 @@ def Calculate(self, model: Model) -> None:
         if self.econmodel.value == EconomicModel.SAM_SINGLE_OWNER_PPA:
             self.sam_economics_calculations = calculate_sam_economics(model)
 
-            # Distinguish capex from default display name of 'Total capital costs' since SAM Economic Model doesn't
-            # subtract ITC from this value.
-            self.CCap.display_name = 'Total CAPEX'
-            self.CCap.value = self.sam_economics_calculations.capex.quantity().to(self.CCap.CurrentUnits.value).magnitude
+            # Setting capex_total distinguishes capex from CCap's display name of 'Total capital costs',
+            # since SAM Economic Model doesn't subtract ITC from this value.
+            self.capex_total.value = (self.sam_economics_calculations.capex.quantity()
+                                .to(self.capex_total.CurrentUnits.value).magnitude)
+            self.CCap.value = (self.sam_economics_calculations.capex.quantity()
+                               .to(self.CCap.CurrentUnits.value).magnitude)
 
             self.wacc.value = self.sam_economics_calculations.wacc.value
             self.nominal_discount_rate.value = self.sam_economics_calculations.nominal_discount_rate.value

src/geophires_x/EconomicsSam.py

@@ -38,6 +38,7 @@
     project_vir_parameter,
     project_payback_period_parameter,
     inflation_cost_during_construction_output_parameter,
+    total_capex_parameter_output_parameter,
 )
 from geophires_x.GeoPHIRESUtils import is_float, is_int, sig_figs, quantity
 from geophires_x.OptionList import EconomicModel, EndUseOptions
@@ -56,12 +57,7 @@ class SamEconomicsCalculations:
         )
     )
 
-    capex: OutputParameter = field(
-        default_factory=lambda: OutputParameter(
-            UnitType=Units.CURRENCY,
-            CurrentUnits=CurrencyUnit.MDOLLARS,
-        )
-    )
+    capex: OutputParameter = field(default_factory=total_capex_parameter_output_parameter)
 
     project_npv: OutputParameter = field(
         default_factory=lambda: OutputParameter(
@@ -329,7 +325,6 @@ def _get_utility_rate_parameters(m: Model) -> dict[str, Any]:
 def _get_single_owner_parameters(model: Model) -> dict[str, Any]:
     """
     TODO:
-        - Construction years
         - Break out indirect costs (instead of lumping all into direct cost):
             https://github.com/NREL/GEOPHIRES-X/issues/383
     """

src/geophires_x/EconomicsUtils.py

@@ -131,3 +131,16 @@ def inflation_cost_during_construction_output_parameter() -> OutputParameter:
         CurrentUnits=CurrencyUnit.MDOLLARS,
         ToolTipText='The calculated amount of cost escalation due to inflation over the construction period.'
     )
+
+
+def total_capex_parameter_output_parameter() -> OutputParameter:
+    return OutputParameter(
+        Name='Total CAPEX',
+        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."
+    )

src/geophires_x/Outputs.py

@@ -222,7 +222,7 @@ def PrintOutputs(self, model: Model):
                     f.write(f'      {model.economics.LCOH.display_name}:           {model.economics.LCOH.value:10.2f} {model.economics.LCOH.CurrentUnits.value}\n')
 
                 if econ.econmodel.value == EconomicModel.SAM_SINGLE_OWNER_PPA:
-                    f.write(f'      {Outputs._field_label(econ.CCap.display_name, 50)}{econ.CCap.value:10.2f} {econ.CCap.CurrentUnits.value}\n')
+                    f.write(f'      {Outputs._field_label(econ.capex_total.display_name, 50)}{econ.capex_total.value:10.2f} {econ.capex_total.CurrentUnits.value}\n')
 
                 f.write(f'      Number of production wells:                    {model.wellbores.nprod.value:10.0f}'+NL)
                 f.write(f'      Number of injection wells:                     {model.wellbores.ninj.value:10.0f}'+NL)
@@ -500,8 +500,9 @@ def PrintOutputs(self, model: Model):
                     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')
 
-                capex_label = Outputs._field_label(econ.CCap.display_name, 50)
-                f.write(f'      {capex_label}{econ.CCap.value:10.2f} {econ.CCap.CurrentUnits.value}\n')
+                capex_param = econ.CCap if econ.econmodel.value != EconomicModel.SAM_SINGLE_OWNER_PPA else econ.capex_total
+                capex_label = Outputs._field_label(capex_param.display_name, 50)
+                f.write(f'      {capex_label}{capex_param.value:10.2f} {capex_param.CurrentUnits.value}\n')
 
                 if model.economics.econmodel.value == EconomicModel.FCR:
                     f.write(f'      Annualized capital costs:                         {(model.economics.CCap.value*(1+model.economics.inflrateconstruction.value)*model.economics.FCR.value):10.2f} ' + model.economics.CCap.CurrentUnits.value + NL)