miscellaneous minor code cleanup

Author: softwareengineerprogrammer

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 #   pre-commit install --install-hooks
 # To update the versions:
 #   pre-commit autoupdate
-exclude: '^(\.tox|ci/templates|\.bumpversion\.cfg|src/geophires_x(?!/(GEOPHIRESv3|EconomicsSam|EconomicsSamCashFlow|EconomicsUtils|EconomicsSamPreRevenue)\.py))(/|$)'
+exclude: '^(\.tox|ci/templates|\.bumpversion\.cfg|src/geophires_x(?!/(GEOPHIRESv3|EconomicsSam|EconomicsSamCashFlow|EconomicsUtils|EconomicsSamPreRevenue|SurfacePlantUtils)\.py))(/|$)'
 # Note the order is intentional to avoid multiple passes of the hooks
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit

src/geophires_x/EconomicsSam.py

@@ -27,7 +27,10 @@
 from tabulate import tabulate
 
 from geophires_x import Model as Model
-from geophires_x.EconomicsSamCashFlow import _calculate_sam_economics_cash_flow, _SAM_CASH_FLOW_NAN_STR
+from geophires_x.EconomicsSamCashFlow import (
+    _calculate_sam_economics_cash_flow_operational_years,
+    _SAM_CASH_FLOW_NAN_STR,
+)
 from geophires_x.EconomicsUtils import (
     BuildPricingModel,
     wacc_output_parameter,
@@ -106,7 +109,7 @@ def sam_cash_flow_profile(self) -> list[list[Any]]:
         ret: list[list[Any]] = self._sam_cash_flow_profile_operational_years.copy()
         col_count = len(self._sam_cash_flow_profile_operational_years[0])
 
-        # TODO support/insert calendar year line item
+        # TODO support/insert calendar year line item https://github.com/NREL/GEOPHIRES-X/issues/439
 
         pre_revenue_years_to_insert = self._pre_revenue_years_count - 1
 
@@ -148,7 +151,6 @@ def _get_row(row_name__: str) -> list[Any]:
             raise ValueError(f'Could not find row with name {row_name__}')
 
         after_tax_cash_flow: list[float] = (
-            # _get_row('After-tax net cash flow [construction] ($)')
             self.pre_revenue_costs_and_cash_flow.pre_revenue_cash_flow_profile_dict[_AFTER_TAX_NET_CASH_FLOW_ROW_NAME]
             + _get_row('Total after-tax returns ($)')[self._pre_revenue_years_count :]
         )
@@ -330,7 +332,7 @@ def calculate_sam_economics(model: Model) -> SamEconomicsCalculations:
     for module in modules:
         module.execute()
 
-    cash_flow_operational_years = _calculate_sam_economics_cash_flow(model, single_owner)
+    cash_flow_operational_years = _calculate_sam_economics_cash_flow_operational_years(model, single_owner)
 
     def sf(_v: float, num_sig_figs: int = 5) -> float:
         return sig_figs(_v, num_sig_figs)

src/geophires_x/EconomicsSamCashFlow.py

@@ -18,17 +18,16 @@
 
 
 @lru_cache(maxsize=12)
-def _calculate_sam_economics_cash_flow(model: Model, single_owner: Singleowner) -> list[list[Any]]:
+def _calculate_sam_economics_cash_flow_operational_years(model: Model, single_owner: Singleowner) -> list[list[Any]]:
     log = model.logger
 
     _soo = single_owner.Outputs
 
     profile = []
 
-    # TODO this and/or related logic will need to be adjusted when multiple construction years are supported
-    #  https://github.com/NREL/GEOPHIRES-X/issues/406
-    # FIXME WIP update above comment for impl
-    total_duration = model.surfaceplant.plant_lifetime.value + 1  # + model.surfaceplant.construction_years.value
+    total_duration = model.surfaceplant.plant_lifetime.value + 1
+    # Note we do not include construction years in total_duration because we only calculating cash flow for operational
+    # years.
 
     # Prefix with 'Year ' partially as workaround for tabulate applying float formatting to ints, possibly related
     # to https://github.com/astanin/python-tabulate/issues/18

src/geophires_x/EconomicsUtils.py

@@ -82,7 +82,7 @@ def project_payback_period_parameter() -> OutputParameter:
         CurrentUnits=TimeUnit.YEAR,
         ToolTipText='The time at which cumulative cash flow reaches zero. '
         'For projects that never pay back, the calculated value will be "N/A". '
-        'For SAM Economic Models, total after-tax returns are used to calculate cumulative cash flow.',
+        'For SAM Economic Models, after-tax net cash flow is used to calculate the cumulative cash flow.',
     )
 
 
@@ -94,9 +94,8 @@ def after_tax_irr_parameter() -> OutputParameter:
         PreferredUnits=PercentUnit.PERCENT,
         ToolTipText='The After-tax IRR (internal rate of return) is the nominal discount rate that corresponds to '
         'a net present value (NPV) of zero for PPA SAM Economic models. '
-        'See https://samrepo.nrelcloud.org/help/mtf_irr.html. If SAM calculates After-tax IRR as NaN, '
-        'numpy-financial.irr (https://numpy.org/numpy-financial/latest/irr.html) '
-        'is used to calculate the value from SAM\'s total after-tax returns.',
+        # TODO describe backfilled calculation using After-tax net cash flow
+        'See https://samrepo.nrelcloud.org/help/mtf_irr.html.',
     )
 
 

src/geophires_x/Parameter.py

@@ -438,7 +438,6 @@ def _is_int(o: Any) -> bool:
             return float_n == int_n
 
     is_positional_parameter = ' ' in ParameterReadIn.Name and _is_int(ParamToModify.Name.split(' ')[-1])
-    #if ' ' in ParamToModify.Name:
     if is_positional_parameter:
         New_val = float(ParameterReadIn.sValue)
         # Some list parameters are read in with enumerated parameter names;  in these cases we use the last

src/geophires_x_schema_generator/geophires-result.json

@@ -123,7 +123,7 @@
         },
         "After-tax IRR": {
           "type": "number",
-          "description": "The After-tax IRR (internal rate of return) is the nominal discount rate that corresponds to a net present value (NPV) of zero for PPA SAM Economic models. See https://samrepo.nrelcloud.org/help/mtf_irr.html. If SAM calculates After-tax IRR as NaN, numpy-financial.irr (https://numpy.org/numpy-financial/latest/irr.html) is used to calculate the value from SAM's total after-tax returns.",
+          "description": "The After-tax IRR (internal rate of return) is the nominal discount rate that corresponds to a net present value (NPV) of zero for PPA SAM Economic models. See https://samrepo.nrelcloud.org/help/mtf_irr.html.",
           "units": "%"
         },
         "Project VIR=PI=PIR": {
@@ -139,7 +139,7 @@
         "Fixed Charge Rate (FCR)": {},
         "Project Payback Period": {
           "type": "number",
-          "description": "The time at which cumulative cash flow reaches zero. For projects that never pay back, the calculated value will be \"N/A\". For SAM Economic Models, total after-tax returns are used to calculate cumulative cash flow.",
+          "description": "The time at which cumulative cash flow reaches zero. For projects that never pay back, the calculated value will be \"N/A\". For SAM Economic Models, after-tax net cash flow is used to calculate the cumulative cash flow.",
           "units": "yr"
         },
         "CHP: Percent cost allocation for electrical plant": {},