use class for Economics.sam_economics

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -4,7 +4,7 @@
 import numpy_financial as npf
 import geophires_x.Model as Model
 from geophires_x import EconomicsSam
-from geophires_x.EconomicsSam import calculate_sam_economics
+from geophires_x.EconomicsSam import calculate_sam_economics, SamEconomics
 from geophires_x.EconomicsUtils import BuildPricingModel
 from geophires_x.OptionList import Configuration, WellDrillingCostCorrelation, EconomicModel, EndUseOptions, PlantType, \
     _WellDrillingCostCorrelationCitation
@@ -442,7 +442,7 @@ def CalculateLCOELCOHLCOC(econ, model: Model) -> tuple:
             LCOH = LCOH * 2.931  # $/Million Btu
     elif econ.econmodel.value == EconomicModel.SAM_SINGLE_OWNER_PPA:
         # Designated as nominal (as opposed to real) in parameter tooltip text
-        LCOE = econ.sam_economics.value['LCOE (nominal)']['value']
+        LCOE = econ.sam_economics.lcoe_nominal.quantity().to(convertible_unit(econ.LCOE.CurrentUnits.value)).magnitude
     else:
         # must be BICYCLE
         # average return on investment (tax and inflation adjusted)
@@ -1518,6 +1518,9 @@ def __init__(self, model: Model):
         self.annualheatincome = 0.0
         self.InputFile = ""
         self.Cplantcorrelation = 0.0
+
+        self.sam_economics: SamEconomics = None
+
         sclass = str(__class__).replace("<class \'", "")
         self.MyClass = sclass.replace("\'>", "")
         self.MyPath = os.path.abspath(__file__)
@@ -1829,14 +1832,6 @@ def __init__(self, model: Model):
             PreferredUnits=TimeUnit.YEAR,
             CurrentUnits=TimeUnit.YEAR
         )
-
-        # FIXME TODO/WIP representation in schema...
-        self.sam_economics = self.OutputParameterDict[self.sam_economics.Name] = OutputParameter(
-            'SAM Economics',
-            UnitType=Units.NONE,
-            json_parameter_type='object',
-        )
-
         self.RITCValue = self.OutputParameterDict[self.RITCValue.Name] = OutputParameter(
             Name="Investment Tax Credit Value",
             display_name='Investment Tax Credit',
@@ -2760,9 +2755,9 @@ def Calculate(self, model: Model) -> None:
             )
 
         if self.econmodel.value == EconomicModel.SAM_SINGLE_OWNER_PPA:
-            self.sam_economics.value = calculate_sam_economics(model)
-            self.ProjectNPV.value = self.sam_economics.value['NPV']['value']
-            self.ProjectIRR.value = self.sam_economics.value['IRR']['value']
+            self.sam_economics = calculate_sam_economics(model)
+            self.ProjectNPV.value = self.sam_economics.project_npv.quantity().to(convertible_unit(self.ProjectNPV.CurrentUnits)).magnitude
+            self.ProjectIRR.value = self.sam_economics.project_irr.quantity().to(convertible_unit(self.ProjectIRR.CurrentUnits)).magnitude
             # FIXME WIP VIR + MOIC
             self.ProjectVIR.value, self.ProjectMOIC.value = -1, -1
 

src/geophires_x/EconomicsSam.py

@@ -2,6 +2,7 @@
 
 import json
 import os
+from dataclasses import dataclass, field
 from functools import lru_cache
 from math import isnan
 from pathlib import Path
@@ -22,17 +23,46 @@
 
 # noinspection PyPackageRequirements
 import PySAM.Utilityrate5 as UtilityRate
+from pint.facets.plain import PlainQuantity
 from tabulate import tabulate
 
 from geophires_x import Model as Model
 from geophires_x.EconomicsSamCashFlow import _calculate_sam_economics_cash_flow
 from geophires_x.EconomicsUtils import BuildPricingModel
 from geophires_x.GeoPHIRESUtils import is_float, is_int
 from geophires_x.OptionList import EconomicModel, EndUseOptions
-from geophires_x.Parameter import Parameter
-from geophires_x.Units import convertible_unit
+from geophires_x.Parameter import Parameter, HasQuantity, OutputParameter
+from geophires_x.Units import convertible_unit, EnergyCostUnit, CurrencyUnit, Units, PercentUnit
 
-_SAM_CASH_FLOW_PROFILE_KEY = 'Cash Flow'
+
+@dataclass
+class SamEconomics:
+    sam_cash_flow_profile: list[list[Any]]
+
+    lcoe_nominal: OutputParameter = field(
+        default_factory=lambda: OutputParameter(
+            UnitType=Units.ENERGYCOST,
+            CurrentUnits=EnergyCostUnit.CENTSSPERKWH,
+        )
+    )
+    capex: OutputParameter = field(
+        default_factory=lambda: OutputParameter(
+            UnitType=Units.CURRENCY,
+            CurrentUnits=CurrencyUnit.MDOLLARS,
+        )
+    )
+    project_npv: OutputParameter = field(
+        default_factory=lambda: OutputParameter(
+            UnitType=Units.CURRENCY,
+            CurrentUnits=CurrencyUnit.MDOLLARS,
+        )
+    )
+    project_irr: OutputParameter = field(
+        default_factory=lambda: OutputParameter(
+            UnitType=Units.PERCENT,
+            CurrentUnits=PercentUnit.PERCENT,
+        )
+    )
 
 
 def validate_read_parameters(model: Model):
@@ -63,8 +93,14 @@ def _inv_msg(param_name: str, invalid_value: Any, supported_description: str) ->
         )
 
 
+class _Quantity(HasQuantity):
+    def __init__(self, value: Any, units: str) -> None:
+        self.value = value
+        self.units = units
+
+
 @lru_cache(maxsize=12)
-def calculate_sam_economics(model: Model) -> dict[str, dict[str, Any]]:
+def calculate_sam_economics(model: Model) -> SamEconomics:
     custom_gen = CustomGeneration.new()
     grid = Grid.from_existing(custom_gen)
     utility_rate = UtilityRate.from_existing(custom_gen)
@@ -97,25 +133,16 @@ def calculate_sam_economics(model: Model) -> dict[str, dict[str, Any]]:
 
     cash_flow = _calculate_sam_economics_cash_flow(model, single_owner)
 
-    data = [
-        ('LCOE (nominal)', single_owner.Outputs.lcoe_nom, 'cents/kWh'),
-        ('IRR', single_owner.Outputs.project_return_aftertax_irr, '%'),
-        ('NPV', single_owner.Outputs.project_return_aftertax_npv * 1e-6, 'MUSD'),
-        ('CAPEX', single_owner.Outputs.adjusted_installed_cost * 1e-6, 'MUSD'),
-        (_SAM_CASH_FLOW_PROFILE_KEY, cash_flow, None),
-    ]
-
-    ret = {}
-    for e in data:
-        key = e[0]
+    def sf(_v: float) -> float:
+        return _sig_figs(_v, 5)
 
-        as_val = e[1]
-        if key != _SAM_CASH_FLOW_PROFILE_KEY:
-            as_val = {'value': _sig_figs(e[1], 5), 'unit': e[2]}
+    sam_economics: SamEconomics = SamEconomics(sam_cash_flow_profile=cash_flow)
+    sam_economics.lcoe_nominal.value = sf(single_owner.Outputs.lcoe_nom)
+    sam_economics.project_irr.value = sf(single_owner.Outputs.project_return_aftertax_irr)
+    sam_economics.project_npv.value = sf(single_owner.Outputs.project_return_aftertax_npv * 1e-6)
+    sam_economics.capex.value = single_owner.Outputs.adjusted_installed_cost * 1e-6
 
-        ret[key] = as_val
-
-    return ret
+    return sam_economics
 
 
 def get_sam_cash_flow_profile_tabulated_output(model: Model, **tabulate_kw_args) -> str:
@@ -143,7 +170,7 @@ def get_entry_display(entry: Any) -> str:
                 return entry_display
         return entry
 
-    profile_display = model.economics.sam_economics.value[_SAM_CASH_FLOW_PROFILE_KEY].copy()
+    profile_display = model.economics.sam_economics.sam_cash_flow_profile.copy()
     for i in range(len(profile_display)):
         for j in range(len(profile_display[i])):
             profile_display[i][j] = get_entry_display(profile_display[i][j])

tests/geophires_x_tests/test_economics_sam.py

@@ -16,7 +16,6 @@
 from geophires_x.EconomicsSam import (
     calculate_sam_economics,
     _sig_figs,
-    _SAM_CASH_FLOW_PROFILE_KEY,
     get_sam_cash_flow_profile_tabulated_output,
     _ppa_pricing_model,
 )
@@ -137,7 +136,7 @@ def test_cash_flow(self):
         m: Model = EconomicsSamTestCase._new_model(Path(self._egs_test_file_path()))
 
         sam_econ = calculate_sam_economics(m)
-        cash_flow = sam_econ[_SAM_CASH_FLOW_PROFILE_KEY]
+        cash_flow = sam_econ.sam_cash_flow_profile
         self.assertIsNotNone(cash_flow)
 
         print(
@@ -234,7 +233,7 @@ def test_property_tax_rate(self):
         )
 
         sam_econ = calculate_sam_economics(m)
-        cash_flow = sam_econ[_SAM_CASH_FLOW_PROFILE_KEY]
+        cash_flow = sam_econ.sam_cash_flow_profile
 
         def get_row(name: str):
             return EconomicsSamTestCase._get_cash_flow_row(cash_flow, name)
@@ -249,7 +248,7 @@ def assert_incentives(params, expected_ibi_usd):
             m: Model = EconomicsSamTestCase._new_model(self._egs_test_file_path(), additional_params=params)
 
             sam_econ = calculate_sam_economics(m)
-            cash_flow = sam_econ[_SAM_CASH_FLOW_PROFILE_KEY]
+            cash_flow = sam_econ.sam_cash_flow_profile
 
             def get_row(name: str):
                 return EconomicsSamTestCase._get_cash_flow_row(cash_flow, name)
@@ -283,7 +282,7 @@ def assert_ptc(params, expected_ptc_usd_per_kWh):
             m: Model = EconomicsSamTestCase._new_model(self._egs_test_file_path(), additional_params=params)
 
             sam_econ = calculate_sam_economics(m)
-            cash_flow = sam_econ[_SAM_CASH_FLOW_PROFILE_KEY]
+            cash_flow = sam_econ.sam_cash_flow_profile
 
             def get_row(name: str):
                 return EconomicsSamTestCase._get_cash_flow_row(cash_flow, name)