finish integrating capacity/utilization factor, including resolution of a few incidental nits discovered in the course of implementation

Author: softwareengineerprogrammer

src/geophires_x/EconomicsSam.py

@@ -84,7 +84,7 @@ def calculate_sam_economics(model: Model) -> dict[str, dict[str, Any]]:
                     module.value(k, v)
 
     for k, v in _get_custom_gen_parameters(model).items():
-        single_owner.value(k, v)
+        custom_gen.value(k, v)
 
     for k, v in _get_utility_rate_parameters(model).items():
         single_owner.value(k, v)
@@ -151,7 +151,8 @@ def _get_custom_gen_parameters(model: Model) -> dict[str, Any]:
     # fmt:off
     ret: dict[str, Any] = {
         # Project lifetime
-        'analysis_period': model.surfaceplant.plant_lifetime.value
+        'analysis_period': model.surfaceplant.plant_lifetime.value,
+        'user_capacity_factor': _pct(model.surfaceplant.utilization_factor),
     }
     # fmt:on
 
@@ -178,8 +179,7 @@ def _get_single_owner_parameters(model: Model) -> dict[str, Any]:
 
     ret: dict[str, Any] = {}
 
-    def pct(econ_value: Parameter) -> float:
-        return econ_value.quantity().to(convertible_unit('%')).magnitude
+    ret['analysis_period'] = model.surfaceplant.plant_lifetime.value
 
     itc = econ.RITCValue.value
     total_capex_musd = econ.CCap.value + itc
@@ -189,7 +189,7 @@ def pct(econ_value: Parameter) -> float:
     opex_musd = econ.Coam.value
     ret['om_fixed'] = [opex_musd * 1e6]
     # GEOPHIRES assumes O&M fixed costs are not affected by inflation
-    ret['om_fixed_escal'] = -1.0 * pct(econ.RINFL)
+    ret['om_fixed_escal'] = -1.0 * _pct(econ.RINFL)
 
     # TODO construction years
 
@@ -198,8 +198,6 @@ def pct(econ_value: Parameter) -> float:
     # Note generation profile is generated relative to the max in _get_utility_rate_parameters
     ret['system_capacity'] = _get_max_net_generation_MW(model) * 1e3
 
-    # TODO utilization factor = nominal capacity factor
-
     geophires_ctr_tenths = Decimal(econ.CTR.value)
     fed_ratio = 0.75
     fed_rate_tenths = geophires_ctr_tenths * (Decimal(fed_ratio))
@@ -217,7 +215,7 @@ def pct(econ_value: Parameter) -> float:
         ret['ptc_fed_term'] = econ.PTCDuration.quantity().to(convertible_unit('yr')).magnitude
 
         if econ.PTCInflationAdjusted.value:
-            ret['ptc_fed_escal'] = pct(econ.RINFL)
+            ret['ptc_fed_escal'] = _pct(econ.RINFL)
 
     # 'Property Tax Rate'
     geophires_ptr_tenths = Decimal(econ.PTR.value)
@@ -232,24 +230,26 @@ def pct(econ_value: Parameter) -> float:
     )
 
     # Debt/equity ratio ('Fraction of Investment in Bonds' parameter)
-    ret['debt_percent'] = pct(econ.FIB)
+    ret['debt_percent'] = _pct(econ.FIB)
 
     # Interest rate
-    ret['real_discount_rate'] = pct(econ.discountrate)
+    ret['real_discount_rate'] = _pct(econ.discountrate)
 
     # Project lifetime
     ret['term_tenor'] = model.surfaceplant.plant_lifetime.value
-    ret['term_int_rate'] = pct(econ.BIR)
+    ret['term_int_rate'] = _pct(econ.BIR)
 
     # TODO 'Inflated Equity Interest Rate' (may not have equivalent in SAM...?)
 
     ret['ibi_oth_amount'] = (econ.OtherIncentives.quantity() + econ.TotalGrant.quantity()).to('USD').magnitude
 
-    ret['user_capacity_factor'] = model.surfaceplant.utilization_factor.value
-
     return ret
 
 
+def _pct(econ_value: Parameter) -> float:
+    return econ_value.quantity().to(convertible_unit('%')).magnitude
+
+
 def _ppa_pricing_model(
     plant_lifetime: int, start_price: float, end_price: float, escalation_start_year: int, escalation_rate: float
 ) -> list:

tests/base_test_case.py

@@ -3,6 +3,8 @@
 import os.path
 import unittest
 
+from geophires_x_client import _get_logger
+
 
 class BaseTestCase(unittest.TestCase):
     maxDiff = None
@@ -17,10 +19,19 @@ def _get_test_file_content(self, test_file_name):
     def _list_test_files_dir(self, test_files_dir: str):
         return os.listdir(self._get_test_file_path(test_files_dir))  # noqa: PTH208
 
-    def assertAlmostEqualWithinPercentage(self, expected, actual, msg=None, percent=5):
+    def assertAlmostEqualWithinPercentage(self, expected, actual, msg: str | None = None, percent=5):
+        if msg is not None and not isinstance(msg, str):
+            raise ValueError(f'msg must be a string (you may have meant to pass percent={msg})')
+
         if isinstance(expected, numbers.Real):
             self.assertAlmostEqual(expected, actual, msg=msg, delta=abs(percent / 100.0 * expected))
         else:
+            if isinstance(expected, list) and isinstance(actual, list):
+                suggest = f'self.assertListAlmostEqual({expected}, {actual}, msg={msg}, percent={percent})'
+                suggest = f'Got 2 lists, you probably meant to call:\n\t{suggest}'
+                log = _get_logger(__name__)
+                log.warning(suggest)
+
             self.assertEqual(expected, actual, msg)
 
     def assertDictAlmostEqual(self, expected, actual, msg=None, places=7, percent=None):

tests/geophires_x_tests/test_economics_sam.py

@@ -116,13 +116,13 @@ def get_row(name: str) -> list[float]:
 
         sam_gen_profile = get_row('Electricity to grid net (kWh)')
 
-        # Discrepancy is probably due to windowing and/or rounding effects
-        #   (TODO to investigate further when time permits)
-        allowed_delta_percent = 15
+        # Discrepancy is probably due to windowing and/or rounding effects,
+        #  may merit further investigation when time permits.
+        allowed_delta_percent = 5
         self.assertAlmostEqualWithinPercentage(
             geophires_avg_net_gen_GWh,
             np.average(sam_gen_profile) * 1e-6,
-            allowed_delta_percent,
+            percent=allowed_delta_percent,
         )
 
         elec_idx = r.result['HEAT AND/OR ELECTRICITY EXTRACTION AND GENERATION PROFILE'][0].index(
@@ -343,6 +343,22 @@ def get_row(name: str):
             {'Production Tax Credit Electricity': 0.04, 'Production Tax Credit Duration': 9}, shortened_term_expected
         )
 
+    def test_capacity_factor(self):
+        r_90 = self._get_result({'Utilization Factor': 0.9})
+        cash_flow_90 = r_90.result['SAM CASH FLOW PROFILE']
+
+        r_20 = self._get_result({'Utilization Factor': 0.2})
+        cash_flow_20 = r_20.result['SAM CASH FLOW PROFILE']
+
+        etg = 'Electricity to grid (kWh)'
+
+        etg_90 = EconomicsSamTestCase._get_cash_flow_row(cash_flow_90, etg)
+        etg_20 = EconomicsSamTestCase._get_cash_flow_row(cash_flow_20, etg)
+
+        etg_20_expected = [(etg_90_entry / 0.9) * 0.2 for etg_90_entry in etg_90]
+
+        self.assertListAlmostEqual(etg_20_expected, etg_20, percent=1)
+
     def test_clean_profile(self):
         profile = [
             ['foo', 1, 2, 3],

tests/test_base_test_case.py

@@ -25,6 +25,25 @@ def test_assertAlmostEqualWithinPercentage(self):
         with self.assertRaises(AssertionError):
             self.assertListAlmostEqual([1, 2, 3], [1.1, 2.2, 3.3], percent=5)
 
+    def test_assertAlmostEqualWithinPercentage_bad_arguments(self):
+        with self.assertRaises(ValueError) as msg_type_error:
+            self.assertAlmostEqualWithinPercentage(100, 100, 10)
+
+            self.assertIn(str(msg_type_error), '(you may have meant to pass percent=10)')
+
+        def assertHasLogRecordWithMessage(logs_, message):
+            assert message in [record.message for record in logs_.records]
+
+        with self.assertLogs(level='INFO') as logs:
+            with self.assertRaises(AssertionError):
+                self.assertAlmostEqualWithinPercentage([1, 2, 3], [1.1, 2.2, 3.3], percent=10.5)
+
+            assertHasLogRecordWithMessage(
+                logs,
+                'Got 2 lists, you probably meant to call:\n\t'
+                'self.assertListAlmostEqual([1, 2, 3], [1.1, 2.2, 3.3], msg=None, percent=10.5)',
+            )
+
 
 if __name__ == '__main__':
     unittest.main()