SAM-EM support for State ITC amount - WIP to adjust ITC outputs

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -1214,7 +1214,17 @@ def __init__(self, model: Model):
             PreferredUnits=PercentUnit.TENTH,
             CurrentUnits=PercentUnit.TENTH,
             ErrMessage="assume default investment tax credit rate (0)",
-            ToolTipText="Investment tax credit rate (see docs)"
+            ToolTipText="Investment tax credit rate (ITC). For SAM Economic Models, this is the federal rate."
+        )
+        self.ritc_state = self.ParameterDict[self.ritc_state.Name] = floatParameter(
+            'State Investment Tax Credit Amount',
+            DefaultValue=0.0,
+            Min=0.0,
+            Max=self.totalcapcost.Max,
+            UnitType=self.totalcapcost.UnitType,
+            PreferredUnits=self.totalcapcost.PreferredUnits,
+            CurrentUnits=self.totalcapcost.CurrentUnits,
+            ToolTipText='State investment tax credit amount (state ITC).'
         )
         self.PTR = self.ParameterDict[self.PTR.Name] = floatParameter(
             "Property Tax Rate",
@@ -2775,7 +2785,8 @@ def _warn(_msg: str) -> None:
                     self.royalty_rate_schedule,
                     self.royalty_supplemental_payments,
                     self.construction_capex_schedule,
-                    self.bond_financing_start_year
+                    self.bond_financing_start_year,
+                    self.ritc_state
                 ]
                 for sam_em_only_param in sam_em_only_params:
                     if sam_em_only_param.Provided:

src/geophires_x/EconomicsSam.py

@@ -680,6 +680,9 @@ def _get_single_owner_parameters(model: Model) -> dict[str, Any]:
     geophires_itc_tenths = Decimal(econ.RITC.value)
     ret['itc_fed_percent'] = [float(geophires_itc_tenths * Decimal(100))]
 
+    geophires_state_itc_usd = Decimal(econ.ritc_state.quantity().to(convertible_unit('USD')).magnitude)
+    ret['itc_sta_amount'] = [float(geophires_state_itc_usd)]
+
     if econ.PTCElec.Provided:
         ret['ptc_fed_amount'] = [econ.PTCElec.quantity().to(convertible_unit('USD/kWh')).magnitude]
 

src/geophires_x_schema_generator/geophires-request.json

@@ -1857,14 +1857,23 @@
       "maximum": 1.0
     },
     "Investment Tax Credit Rate": {
-      "description": "Investment tax credit rate (see docs)",
+      "description": "Investment tax credit rate (ITC). For SAM Economic Models, this is the federal rate.",
       "type": "number",
       "units": "",
       "category": "Economics",
       "default": 0.0,
       "minimum": 0.0,
       "maximum": 1.0
     },
+    "State Investment Tax Credit Amount": {
+      "description": "State investment tax credit amount (state ITC).",
+      "type": "number",
+      "units": "MUSD",
+      "category": "Economics",
+      "default": 0.0,
+      "minimum": 0.0,
+      "maximum": 100000.0
+    },
     "Property Tax Rate": {
       "description": "Property tax rate (see docs)",
       "type": "number",

tests/geophires_x_tests/test_economics_sam.py

@@ -1387,6 +1387,23 @@ def test_chp_fixed_plant_cost_requires_electrical_plant_cost_allocation_ratio(se
 
         self.assertIn('CHP Electrical Plant Cost Allocation Ratio is required', str(re.exception))
 
+    def test_state_itc_amount(self):
+        r: GeophiresXResult = GeophiresXClient().get_geophires_result(
+            ImmutableGeophiresInputParameters(
+                from_file_path=self._get_test_file_path('generic-egs-case-2_sam-single-owner-ppa.txt'),
+                params={
+                    'State Investment Tax Credit Amount': 4,
+                    'Construction Years': 1,
+                },
+            )
+        )
+
+        line_item = 'State ITC amount income ($)'
+        cash_flow_row = self._get_cash_flow_row(r.result['SAM CASH FLOW PROFILE'], line_item)
+        self.assertEqual(4_000_000, cash_flow_row[1])
+
+        # FIXME WIP assert Investment Tax Credit output field is correct state + fed
+
     @staticmethod
     def _new_model(
         input_file: Path,