Limit construction years = 1

Author: softwareengineerprogrammer

docs/SAM-Economic-Models.md

@@ -2,6 +2,8 @@
 
 ## SAM Single-Owner PPA
 
+### Parameters
+
 | GEOPHIRES Parameter(s)                               | SAM Category                                           | SAM Input(s)                                                                     | SAM Module(s)                     | SAM Parameter Name(s)                                        | Comment                                                                                                                                                                                                          |
 |------------------------------------------------------|--------------------------------------------------------|----------------------------------------------------------------------------------|-----------------------------------|--------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `Max Net Electricity Production`                     | Generation Profile                                     | `Nameplate capacity`                                                             | `Singleowner`                     | `system_capacity`                                            |                                                                                                                                                                                                                  |
@@ -21,3 +23,8 @@
 | `Other Incentives` + `One-time Grants Etc`           | Incentives → Investment Based Incentive (IBI)          | `Other`  → `Amount ($)`                                                          | `Singleowner`                     | `ibi_oth_amount`                                             |                                                                                                                                                                                                                  |
 
 [Implementation in source code](https://github.com/softwareengineerprogrammer/GEOPHIRES/blob/274786e6799d32dad3f42a2a04297818b811f24c/src/geophires_x/EconomicsSam.py#L135-L195)
+
+### Limitations
+
+1. Only Electricity end-use is supported
+2. Only 1 construction year is supported

src/geophires_x/Economics.py

@@ -4,7 +4,8 @@
 import numpy as np
 import numpy_financial as npf
 import geophires_x.Model as Model
-from geophires_x.EconomicsSam import calculate_sam_economics, _SAM_CASH_FLOW_PROFILE_KEY
+from geophires_x import EconomicsSam
+from geophires_x.EconomicsSam import calculate_sam_economics
 from geophires_x.OptionList import Configuration, WellDrillingCostCorrelation, EconomicModel, EndUseOptions, PlantType, \
     _WellDrillingCostCorrelationCitation
 from geophires_x.Parameter import intParameter, floatParameter, OutputParameter, ReadParameter, boolParameter, \
@@ -1947,13 +1948,8 @@ def _warn(_msg: str) -> None:
                     if ParameterToModify.Name == "Economic Model":
                         em: EconomicModel = EconomicModel.from_input_string(ParameterReadIn.sValue)
 
-                        if (em == EconomicModel.SAM_SINGLE_OWNER_PPA
-                                and model.surfaceplant.enduse_option.value != EndUseOptions.ELECTRICITY):
-                            raise RuntimeError(f'Invalid End-Use Option '
-                                               f'({model.surfaceplant.enduse_option.value.value}) for '
-                                               f'{EconomicModel.SAM_SINGLE_OWNER_PPA.name} economic model. '
-                                               f'{EconomicModel.SAM_SINGLE_OWNER_PPA.name} only supports '
-                                               f'{EndUseOptions.ELECTRICITY.name} End-Use Option.')
+                        if em == EconomicModel.SAM_SINGLE_OWNER_PPA:
+                            EconomicsSam.validate_read_parameters(model)
 
                         self.econmodel.value = em
 

src/geophires_x/EconomicsSam.py

@@ -27,13 +27,42 @@
 from geophires_x import Model as Model
 from geophires_x.EconomicsSamCashFlow import _calculate_sam_economics_cash_flow
 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
 
 _SAM_CASH_FLOW_PROFILE_KEY = 'Cash Flow'
 _GEOPHIRES_TO_SAM_PRICING_MODEL_RATE_CONVERSION_CONSTANT = 0.745
 
 
+def validate_read_parameters(model: Model):
+    def _inv_msg(param_name: str, invalid_value: Any, supported_description: str) -> str:
+        return (
+            f'Invalid {param_name} ({invalid_value}) for '
+            f'{EconomicModel.SAM_SINGLE_OWNER_PPA.name} economic model. '
+            f'{EconomicModel.SAM_SINGLE_OWNER_PPA.name} only supports '
+            f'{supported_description}.'
+        )
+
+    if model.surfaceplant.enduse_option.value != EndUseOptions.ELECTRICITY:
+        raise ValueError(
+            _inv_msg(
+                model.surfaceplant.enduse_option.Name,
+                model.surfaceplant.enduse_option.value.value,
+                f'{EndUseOptions.ELECTRICITY.name} End-Use Option',
+            )
+        )
+
+    if model.surfaceplant.construction_years.value != 1:
+        raise ValueError(
+            _inv_msg(
+                model.surfaceplant.construction_years.Name,
+                model.surfaceplant.construction_years.value,
+                f'{model.surfaceplant.construction_years.Name}  = 1',
+            )
+        )
+
+
 @lru_cache(maxsize=12)
 def calculate_sam_economics(model: Model) -> dict[str, dict[str, Any]]:
     custom_gen = CustomGeneration.new()
@@ -126,7 +155,12 @@ def get_entry_display(entry: Any) -> str:
 
 
 def _get_custom_gen_parameters(model: Model) -> dict[str, Any]:
-    ret: dict[str, Any] = {'analysis_period': model.surfaceplant.plant_lifetime.value}
+    # fmt:off
+    ret: dict[str, Any] = {
+        # Project lifetime
+        'analysis_period': model.surfaceplant.plant_lifetime.value
+    }
+    # fmt:on
 
     return ret
 
@@ -164,10 +198,10 @@ def pct(econ_value: Parameter) -> float:
     # GEOPHIRES assumes O&M fixed costs are not affected by inflation
     ret['om_fixed_escal'] = -1.0 * pct(econ.RINFL)
 
-    # TODO project lifetime
-
     # TODO construction years
 
+    # TODO 'Inflation Rate During Construction'
+
     # Note generation profile is generated relative to the max in _get_utility_rate_parameters
     ret['system_capacity'] = _get_max_net_generation_MW(model) * 1e3
 
@@ -205,6 +239,7 @@ def pct(econ_value: Parameter) -> float:
     # Interest rate
     ret['real_discount_rate'] = pct(econ.discountrate)
 
+    # Project lifetime
     ret['term_tenor'] = model.surfaceplant.plant_lifetime.value
     ret['term_int_rate'] = pct(econ.BIR)
 

tests/geophires_x_tests/test_economics_sam.py

@@ -150,10 +150,17 @@ def _get_cash_flow_row(cash_flow, name):
         )[1:]
 
     def test_only_electricity_end_use_supported(self):
-        with self.assertRaises(RuntimeError) as re:
+        with self.assertRaises(RuntimeError) as e:
             self._get_result({'End-Use Option': 2})
 
-        self.assertIn('Invalid End-Use Option (Direct-Use Heat)', str(re.exception))
+        self.assertIn('Invalid End-Use Option (Direct-Use Heat)', str(e.exception))
+
+    def test_only_1_construction_year_supported(self):
+        with self.assertRaises(RuntimeError) as e:
+            self._get_result({'Construction Years': 2})
+
+        self.assertIn('Invalid Construction Years (2)', str(e.exception))
+        self.assertIn('SAM_SINGLE_OWNER_PPA only supports Construction Years  = 1.', str(e.exception))
 
     def test_property_tax_rate(self):
         pt_rate = 0.01