Implemement SAM economic model MOIC NREL#390

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -6,7 +6,7 @@
 from geophires_x import EconomicsSam
 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
+    real_discount_rate_parameter, after_tax_irr_parameter, moic_parameter
 from geophires_x.OptionList import Configuration, WellDrillingCostCorrelation, EconomicModel, EndUseOptions, PlantType, \
     _WellDrillingCostCorrelationCitation
 from geophires_x.Parameter import intParameter, floatParameter, OutputParameter, ReadParameter, boolParameter, \
@@ -1844,13 +1844,7 @@ def __init__(self, model: Model):
             PreferredUnits=PercentUnit.TENTH,
             CurrentUnits=PercentUnit.TENTH
         )
-        self.ProjectMOIC = self.OutputParameterDict[self.ProjectMOIC.Name] = OutputParameter(
-            "Project MOIC",
-            ToolTipText="Project Multiple of Invested Capital",
-            UnitType=Units.PERCENT,
-            PreferredUnits=PercentUnit.TENTH,
-            CurrentUnits=PercentUnit.TENTH
-        )
+        self.ProjectMOIC = self.OutputParameterDict[self.ProjectMOIC.Name] = moic_parameter()
         self.ProjectPaybackPeriod = self.OutputParameterDict[self.ProjectPaybackPeriod.Name] = OutputParameter(
             "Project Payback Period",
             UnitType=Units.TIME,
@@ -2802,13 +2796,14 @@ def Calculate(self, model: Model) -> None:
             self.after_tax_irr.value = self.sam_economics_calculations.after_tax_irr.quantity().to(
                 convertible_unit(self.ProjectIRR.CurrentUnits)).magnitude
 
-            self.ProjectVIR.value = non_calculated_output_placeholder_val  # TODO SAM VIR
-            self.ProjectMOIC.value = non_calculated_output_placeholder_val  # TODO SAM MOIC
+            self.ProjectMOIC.value = self.sam_economics_calculations.moic.value
 
-        # Calculate the project payback period
+            # TODO SAM economic models VIR https://github.com/NREL/GEOPHIRES-X/issues/390
+            # self.ProjectVIR.value = non_calculated_output_placeholder_val
 
+        # Calculate the project payback period
         if self.econmodel.value == EconomicModel.SAM_SINGLE_OWNER_PPA:
-            # TODO SAM project payback period
+            # TODO TODO SAM economic models Payback period https://github.com/NREL/GEOPHIRES-X/issues/390
             self.ProjectPaybackPeriod.value = non_calculated_output_placeholder_val
         else:
             self.ProjectPaybackPeriod.value = 0.0  # start by assuming the project never pays back

src/geophires_x/EconomicsSam.py

@@ -34,6 +34,7 @@
     wacc_output_parameter,
     nominal_discount_rate_parameter,
     after_tax_irr_parameter,
+    moic_parameter,
 )
 from geophires_x.GeoPHIRESUtils import is_float, is_int
 from geophires_x.OptionList import EconomicModel, EndUseOptions
@@ -72,6 +73,8 @@ class SamEconomicsCalculations:
 
     wacc: OutputParameter = field(default_factory=wacc_output_parameter)
 
+    moic: OutputParameter = field(default_factory=moic_parameter)
+
 
 def validate_read_parameters(model: Model):
     def _inv_msg(param_name: str, invalid_value: Any, supported_description: str) -> str:
@@ -171,20 +174,16 @@ def sf(_v: float, num_sig_figs: int = 5) -> float:
         model, single_owner
     )
 
+    sam_economics.moic.value = _calculate_moic(cash_flow, model)
+
     return sam_economics
 
 
 def _get_after_tax_irr_pct(single_owner: Singleowner, cash_flow: list[list[Any]], model: Model) -> float:
     after_tax_irr_pct = single_owner.Outputs.project_return_aftertax_irr
     if math.isnan(after_tax_irr_pct):
         try:
-
-            def cash_flow_profile_row(row_name: str) -> list[Any]:
-                return next(  # type: ignore[no-any-return]
-                    row for row in cash_flow if len(row) > 0 and row[0] == row_name
-                )[1:]
-
-            after_tax_returns_cash_flow = cash_flow_profile_row('Total after-tax returns ($)')
+            after_tax_returns_cash_flow = _cash_flow_profile_row(cash_flow, 'Total after-tax returns ($)')
             after_tax_irr_pct = npf.irr(after_tax_returns_cash_flow) * 100.0
             model.logger.info(f'After-tax IRR was NaN, calculated with numpy-financial: {after_tax_irr_pct}%')
         except Exception as e:
@@ -193,6 +192,10 @@ def cash_flow_profile_row(row_name: str) -> list[Any]:
     return after_tax_irr_pct
 
 
+def _cash_flow_profile_row(cash_flow: list[list[Any]], row_name: str) -> list[Any]:
+    return next(row for row in cash_flow if len(row) > 0 and row[0] == row_name)[1:]  # type: ignore[no-any-return]
+
+
 def _calculate_nominal_discount_rate_and_wacc(model: Model, single_owner: Singleowner) -> tuple[float]:
     """
     Calculation per SAM Help -> Financial Parameters -> Commercial -> Commercial Loan Parameters -> WACC
@@ -214,6 +217,18 @@ def _calculate_nominal_discount_rate_and_wacc(model: Model, single_owner: Single
     return nominal_discount_rate_pct, wacc_pct
 
 
+def _calculate_moic(cash_flow: list[list[Any]], model) -> float | None:
+    try:
+        total_capital_invested_USD = _cash_flow_profile_row(cash_flow, 'Issuance of equity ($)')[0]
+        total_value_received_from_investment_USD = np.sum(
+            _cash_flow_profile_row(cash_flow, 'Total pre-tax returns ($)')
+        )
+        return total_value_received_from_investment_USD / total_capital_invested_USD
+    except Exception as e:
+        model.logger.error(f'Encountered exception calculating MOIC: {e}')
+        return None
+
+
 def get_sam_cash_flow_profile_tabulated_output(model: Model, **tabulate_kw_args) -> str:
     """
     Note model must have already calculated economics for this to work (used in Outputs)

src/geophires_x/EconomicsUtils.py

@@ -37,6 +37,18 @@ def BuildPricingModel(plantlifetime: int, StartPrice: float, EndPrice: float,
     return Price
 
 
+def moic_parameter() -> OutputParameter:
+    return OutputParameter(
+        "Project MOIC",
+        ToolTipText='Project Multiple of Invested Capital. For SAM Economic Models, this is calculated as the '
+                    'cash flow profile Issuance of equity (total capital invested) divided by the sum of '
+                    'Total pre-tax returns (total value received).',
+        UnitType=Units.PERCENT,
+        PreferredUnits=PercentUnit.TENTH,
+        CurrentUnits=PercentUnit.TENTH
+    )
+
+
 def after_tax_irr_parameter() -> OutputParameter:
     return OutputParameter(
         Name='After-tax IRR',

src/geophires_x/Outputs.py

@@ -286,11 +286,13 @@ def PrintOutputs(self, model: Model):
                 f.write(f'      {irr_field_label}{irr_display_value} {irr_output_param.CurrentUnits.value}\n')
 
                 if econ.econmodel.value != EconomicModel.SAM_SINGLE_OWNER_PPA:
-                    # VIR, MOIC, and Payback period not currently supported by SAM economic model(s)
-
+                    # TODO SAM economic models VIR https://github.com/NREL/GEOPHIRES-X/issues/390
                     f.write(f'      {econ.ProjectVIR.display_name}:                              {econ.ProjectVIR.value:10.2f}\n')
-                    f.write(f'      {econ.ProjectMOIC.display_name}:                                    {econ.ProjectMOIC.value:10.2f}\n')
 
+                f.write(f'      {econ.ProjectMOIC.display_name}:                                    {econ.ProjectMOIC.value:10.2f}\n')
+
+                if econ.econmodel.value != EconomicModel.SAM_SINGLE_OWNER_PPA:
+                    # TODO TODO SAM economic models Payback period https://github.com/NREL/GEOPHIRES-X/issues/390
                     payback_period_val = model.economics.ProjectPaybackPeriod.value
                     project_payback_period_display = f'{payback_period_val:10.2f} {econ.ProjectPaybackPeriod.PreferredUnits.value}' \
                         if payback_period_val > 0.0 else 'N/A'

src/geophires_x_schema_generator/geophires-result.json

@@ -115,7 +115,7 @@
         },
         "Project MOIC": {
           "type": "number",
-          "description": "Project Multiple of Invested Capital",
+          "description": "Project Multiple of Invested Capital. For SAM Economic Models, this is calculated as the cash flow profile Issuance of equity (total capital invested) divided by the sum of Total pre-tax returns (total value received).",
           "units": ""
         },
         "Fixed Charge Rate (FCR)": {},

tests/examples/Fervo_Project_Cape-4.out

@@ -4,10 +4,10 @@
 
 Simulation Metadata
 ----------------------
- GEOPHIRES Version: 3.9.13
- Simulation Date: 2025-05-30
- Simulation Time:  09:38
- Calculation Time:      1.052 sec
+ GEOPHIRES Version: 3.9.14
+ Simulation Date: 2025-06-03
+ Simulation Time:  08:48
+ Calculation Time:      1.054 sec
 
                            ***SUMMARY OF RESULTS***
 
@@ -33,6 +33,7 @@ Simulation Metadata
       Capacity factor:                                       90.0 %
       Project NPV:                                         869.26 MUSD
       After-tax IRR:                                        18.80 %
+      Project MOIC:                                          2.83
       Estimated Jobs Created:                                 1196
 
                           ***ENGINEERING PARAMETERS***

tests/examples/example_SAM-single-owner-PPA-2.out

@@ -4,10 +4,10 @@
 
 Simulation Metadata
 ----------------------
- GEOPHIRES Version: 3.9.12
- Simulation Date: 2025-05-29
- Simulation Time:  08:52
- Calculation Time:      0.878 sec
+ GEOPHIRES Version: 3.9.14
+ Simulation Date: 2025-06-03
+ Simulation Time:  08:48
+ Calculation Time:      0.875 sec
 
                            ***SUMMARY OF RESULTS***
 
@@ -33,6 +33,7 @@ Simulation Metadata
       Capacity factor:                                       90.0 %
       Project NPV:                                        2877.00 MUSD
       After-tax IRR:                                        59.73 %
+      Project MOIC:                                         12.36
       Estimated Jobs Created:                                 976
 
                           ***ENGINEERING PARAMETERS***

tests/examples/example_SAM-single-owner-PPA.out

@@ -4,10 +4,10 @@
 
 Simulation Metadata
 ----------------------
- GEOPHIRES Version: 3.9.12
- Simulation Date: 2025-05-29
- Simulation Time:  08:55
- Calculation Time:      1.052 sec
+ GEOPHIRES Version: 3.9.14
+ Simulation Date: 2025-06-03
+ Simulation Time:  08:48
+ Calculation Time:      1.039 sec
 
                            ***SUMMARY OF RESULTS***
 
@@ -33,6 +33,7 @@ Simulation Metadata
       Capacity factor:                                       90.0 %
       Project NPV:                                         124.91 MUSD
       After-tax IRR:                                        22.33 %
+      Project MOIC:                                          4.15
       Estimated Jobs Created:                                 125
 
                           ***ENGINEERING PARAMETERS***