Normalize CAPEX schedule sum to 1.0.

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -1180,8 +1180,8 @@ def __init__(self, model: Model):
             ToolTipText=f'A list of fractions of the total overnight CAPEX spent in each construction year. '
                         f'For example, for 3 construction years with 10% in the first year, 40% in the second, '
                         f'and 50% in the third, provide {construction_capex_schedule_name} = 0.1,0.4,0.5. '
-                        f'If the length of the provided schedule does not match the number of construction years, '
-                        f'it will be interpolated to match the number of construction years.'
+                        f'The schedule will be automatically interpolated to match the number of construction years '
+                        f'and normalized to sum to 1.0.'
         )
 
         default_bond_financing_start_year = 0

src/geophires_x/EconomicsSam.py

@@ -160,7 +160,7 @@ def _get_row(row_name__: str) -> list[Any]:
         return ret
 
 
-def validate_read_parameters(model: Model):
+def validate_read_parameters(model: Model) -> None:
     def _inv_msg(param_name: str, invalid_value: Any, supported_description: str) -> str:
         return (
             f'Invalid {param_name} ({invalid_value}) for '
@@ -193,28 +193,46 @@ def _inv_msg(param_name: str, invalid_value: Any, supported_description: str) ->
 
     econ = model.economics
 
-    construction_years = model.surfaceplant.construction_years.value
-    capex_schedule = econ.construction_capex_schedule.value
-    capex_schedule_len = len(capex_schedule)
-    if capex_schedule_len != construction_years:
-        econ.construction_capex_schedule.value = adjust_phased_schedule_to_new_length(
-            econ.construction_capex_schedule.value, construction_years
-        )
-        msg = (
-            f'{econ.construction_capex_schedule.Name} ({econ.construction_capex_schedule}) '
-            f'length ({capex_schedule_len}) '
-            f'does not match construction years ({construction_years}). '
-            f'It has been adjusted to: {econ.construction_capex_schedule.value}'
-        )
-        model.logger.warning(msg)
+    econ.construction_capex_schedule.value = _validate_construction_capex_schedule(
+        econ.construction_capex_schedule,
+        model.surfaceplant.construction_years.value,
+        model.logger,
+    )
 
+    construction_years = model.surfaceplant.construction_years.value
     if abs(econ.bond_financing_start_year.value) >= construction_years:
         raise ValueError(
             f'{econ.bond_financing_start_year.Name} ({econ.bond_financing_start_year.value}) may not be earlier than '
             f'first {model.surfaceplant.construction_years.Name[:-1]} ({-1*(construction_years-1)}). '
         )
 
 
+def _validate_construction_capex_schedule(
+    econ_capex_schedule: listParameter, construction_years: int, model_logger
+) -> list[float]:
+    capex_schedule: list[float] = econ_capex_schedule.value.copy()
+
+    adjust_schedule_reasons: list[str] = []
+    if sum(capex_schedule) != 1.0:
+        adjust_schedule_reasons.append(f'does not sum to 1.0 (sums to {sum(capex_schedule)})')
+
+    capex_schedule_len = len(capex_schedule)
+    if capex_schedule_len != construction_years:
+        adjust_schedule_reasons.append(
+            f'length ({capex_schedule_len}) does not match ' f'construction years ({construction_years})'
+        )
+
+    if len(adjust_schedule_reasons) > 0:
+        capex_schedule = adjust_phased_schedule_to_new_length(econ_capex_schedule.value, construction_years)
+        msg = f'{econ_capex_schedule.Name} ({econ_capex_schedule}) '
+        msg += ' and '.join(adjust_schedule_reasons)
+        msg += f'. It has been adjusted to: {capex_schedule}'
+
+        model_logger.warning(msg)
+
+    return capex_schedule
+
+
 @lru_cache(maxsize=12)
 def calculate_sam_economics(model: Model) -> SamEconomicsCalculations:
     custom_gen = CustomGeneration.new()

src/geophires_x/EconomicsSamPreRevenue.py

@@ -235,7 +235,11 @@ def adjust_phased_schedule_to_new_length(original_schedule: list[float], new_len
 
     original_len = len(original_schedule)
     if original_len == new_length:
-        return original_schedule
+        # Even if lengths match, we must normalize to ensure sum is 1.0
+        total = sum(original_schedule)
+        if total == 0:
+            return [1.0 / new_length] * new_length
+        return [x / total for x in original_schedule]
 
     if original_len == 1:
         # Interpolation is not possible with a single value; return a constant schedule

tests/geophires_x_tests/test_economics_sam.py

@@ -9,6 +9,7 @@
 
 import numpy as np
 import numpy_financial as npf
+from geophires_x.Parameter import listParameter
 
 from base_test_case import BaseTestCase
 
@@ -23,6 +24,7 @@
     _get_fed_and_state_tax_rates,
     SamEconomicsCalculations,
     _get_royalty_rate_schedule,
+    _validate_construction_capex_schedule,
 )
 from geophires_x.GeoPHIRESUtils import sig_figs, quantity, is_float
 
@@ -290,6 +292,36 @@ def _sum(cf_row_name: str, abs_val: bool = False) -> float:
             _floats(self._get_cash_flow_row(cy4_cf, 'Issuance of equity ($)'))[0],
         )
 
+    def test_validate_construction_capex_schedule(self):
+        model_logger = self._new_model(self._egs_test_file_path()).logger
+
+        def _sched(sched: list[float]) -> listParameter:
+            construction_capex_schedule_name = 'Construction CAPEX Schedule'
+            schedule_param = listParameter(
+                construction_capex_schedule_name,
+                DefaultValue=[1.0],
+                Min=0.0,
+                Max=1.0,
+                ToolTipText=construction_capex_schedule_name,
+            )
+            schedule_param.value = sched
+            return schedule_param
+
+        half_half = [0.5, 0.5]
+        self.assertListEqual(half_half, _validate_construction_capex_schedule(_sched(half_half), 2, model_logger))
+
+        with self.assertLogs(level='WARNING') as logs:
+            quarters = [0.25] * 4
+            self.assertListEqual(half_half, _validate_construction_capex_schedule(_sched(quarters), 2, model_logger))
+            self.assertHasLogRecordWithMessage(
+                logs, 'has been adjusted to: [0.5, 0.5]', treat_substring_match_as_match=True
+            )
+
+        double_ones = [1.0, 1.0]
+        with self.assertLogs(level='WARNING') as logs2:
+            self.assertListEqual(half_half, _validate_construction_capex_schedule(_sched(double_ones), 2, model_logger))
+            self.assertHasLogRecordWithMessage(logs2, 'does not sum to 1.0', treat_substring_match_as_match=True)
+
     def assertAlmostEqualWithinSigFigs(self, expected: float | int, actual: float | int, num_sig_figs: int = 3):
         """
         TODO move to parent class (BaseTestCase)