WIP - wiring up S-DAC carbon extracted line item in ENERGY cash flow category

Author: softwareengineerprogrammer

src/geophires_x/EconomicsS_DAC_GT.py

@@ -1,6 +1,8 @@
 import sys
 import os
 import numpy as np
+
+from geophires_x.EconomicsUtils import carbon_extracted_annually_output_parameter
 from geophires_x.Parameter import floatParameter, OutputParameter, ReadParameter, intParameter
 from geophires_x.Units import *
 from geophires_x.OptionList import EndUseOptions
@@ -360,12 +362,8 @@ def __init__(self, model: Model):
             PreferredUnits=CurrencyUnit.DOLLARS,
             CurrentUnits=CurrencyUnit.DOLLARS
         )
-        self.CarbonExtractedAnnually = self.OutputParameterDict[self.CarbonExtractedAnnually.Name] = OutputParameter(
-            Name="Tonnes per Year CO2 extracted",
-            UnitType=Units.MASSPERTIME,
-            PreferredUnits=MassPerTimeUnit.TONNEPERYEAR,
-            CurrentUnits=MassPerTimeUnit.TONNEPERYEAR
-        )
+        self.CarbonExtractedAnnually = self.OutputParameterDict[self.CarbonExtractedAnnually.Name] = \
+            carbon_extracted_annually_output_parameter()
         self.S_DAC_GTCummCarbonExtracted = self.OutputParameterDict[
             self.S_DAC_GTCummCarbonExtracted.Name] = OutputParameter(
             Name="Running Carbon Capture",

src/geophires_x/EconomicsSam.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import copy
 import json
 import logging
 import os
@@ -277,6 +278,11 @@ def sf(_v: float, num_sig_figs: int = 5) -> float:
     sam_economics.nominal_discount_rate.value, sam_economics.wacc.value = _calculate_nominal_discount_rate_and_wacc_pct(
         model, single_owner
     )
+
+    # noinspection SpellCheckingInspection
+    if hasattr(model.economics, 'DoSDACGTCalculations') and model.economics.DoSDACGTCalculations.value:
+        sam_economics.s_dac_carbon_extracted_annually = copy.deepcopy(model.sdacgteconomics.CarbonExtractedAnnually)
+
     sam_economics.moic.value = _calculate_moic(sam_economics.sam_cash_flow_profile, model)
     sam_economics.project_vir.value = _calculate_project_vir(sam_economics.sam_cash_flow_profile, model)
     sam_economics.project_payback_period.value = _calculate_project_payback_period(

src/geophires_x/EconomicsSamCalculations.py

@@ -22,6 +22,7 @@
     investment_tax_credit_output_parameter,
     lcoh_output_parameter,
     lcoc_output_parameter,
+    carbon_extracted_annually_output_parameter,
 )
 from geophires_x.GeoPHIRESUtils import is_float, quantity, is_int
 from geophires_x.Parameter import OutputParameter
@@ -83,6 +84,7 @@ class SamEconomicsCalculations:
     investment_tax_credit: OutputParameter = field(default_factory=investment_tax_credit_output_parameter)
 
     capacity_payment_revenue_sources: list[CapacityPaymentRevenueSource] = field(default_factory=list)
+    s_dac_carbon_extracted_annually: OutputParameter = field(default_factory=carbon_extracted_annually_output_parameter)
 
     @property
     def _pre_revenue_years_count(self) -> int:
@@ -169,6 +171,8 @@ def _get_row(row_name__: str) -> list[Any]:
 
         ret = self._insert_capacity_payment_line_items(ret)
 
+        ret = self._insert_s_dac_line_items(ret)
+
         ret = self._insert_calculated_levelized_metrics_line_items(ret)
 
         if self._may_consume_grid_electricity:
@@ -261,6 +265,70 @@ def _for_operational_years(_row: list[Any]) -> list[Any]:
 
         return ret
 
+    def _insert_s_dac_line_items(self, cf_ret: list[list[Any]]) -> list[list[Any]]:
+        ret: list[list[Any]] = cf_ret.copy()
+
+        def _get_row_index(row_name_: str) -> int:
+            return [it[0] for it in ret].index(row_name_)
+
+        def _insert_row_before(before_row_name: str, row_name: str, row_content: list[Any]) -> None:
+            ret.insert(
+                _get_row_index(before_row_name),
+                [row_name, *row_content],
+            )
+
+        def _insert_blank_line_before(before_row_name: str) -> None:
+            _insert_row_before(before_row_name, '', ['' for _it in ret[_get_row_index(before_row_name)]][1:])
+
+        REVENUE_CATEGORY_ROW_NAME = 'REVENUE'
+        ENERGY_CATEGORY_ROW_NAME = 'ENERGY'
+        CAPACITY_PAYMENT_REVENUE_ROW_NAME = 'Capacity payment revenue ($)'
+
+        _insert_blank_line_before(REVENUE_CATEGORY_ROW_NAME)
+        # _insert_blank_line_before(CAPACITY_PAYMENT_REVENUE_ROW_NAME)
+
+        def _for_operational_years(_row: list[Any]) -> list[Any]:
+            return [*([''] * (self._pre_revenue_years_count - 1)), 0, *_row]
+
+        _insert_row_before(
+            REVENUE_CATEGORY_ROW_NAME,
+            f'{self.s_dac_carbon_extracted_annually.Name} ({self.s_dac_carbon_extracted_annually.CurrentUnits})',
+            _for_operational_years(self.s_dac_carbon_extracted_annually.value),
+        )
+        _insert_blank_line_before(REVENUE_CATEGORY_ROW_NAME)
+
+        # for i, capacity_payment_revenue_source in enumerate([None]):
+        #     if capacity_payment_revenue_source.amount_provided_label is not None:
+        #
+        #
+        #     revenue_row_name = f'{capacity_payment_revenue_source.name} revenue ($)'
+        #     _insert_row_before(
+        #         CAPACITY_PAYMENT_REVENUE_ROW_NAME,
+        #         revenue_row_name,
+        #         _for_operational_years(capacity_payment_revenue_source.revenue_usd),
+        #     )
+        #
+        #     if capacity_payment_revenue_source.price_label is not None:
+        #         _insert_row_before(
+        #             revenue_row_name,
+        #             capacity_payment_revenue_source.price_label.replace('USD', '$'),
+        #             capacity_payment_revenue_source.price,
+        #         )
+        #
+        #     if len(self.capacity_payment_revenue_sources) > 1 and i < len(self.capacity_payment_revenue_sources) - 1:
+        #         _insert_row_before(
+        #             CAPACITY_PAYMENT_REVENUE_ROW_NAME,
+        #             'plus:',
+        #             ['' for _it in ret[_get_row_index(revenue_row_name)]][1:],
+        #         )
+        #
+        # if len(self.capacity_payment_revenue_sources) > 0:
+        #     _insert_row_before(
+        #         CAPACITY_PAYMENT_REVENUE_ROW_NAME, 'equals:', ['' for _it in ret[_get_row_index(revenue_row_name)]][1:]
+        #     )
+
+        return ret
+
     def _insert_calculated_levelized_metrics_line_items(self, cf_ret: list[list[Any]]) -> list[list[Any]]:
         ret = cf_ret.copy()
 

src/geophires_x/EconomicsUtils.py

@@ -2,7 +2,15 @@
 
 from geophires_x.GeoPHIRESUtils import is_float, is_int
 from geophires_x.Parameter import OutputParameter, SCHEDULE_DSL_MULTIPLIER_SYMBOL
-from geophires_x.Units import Units, PercentUnit, TimeUnit, CurrencyUnit, CurrencyFrequencyUnit, EnergyCostUnit
+from geophires_x.Units import (
+    Units,
+    PercentUnit,
+    TimeUnit,
+    CurrencyUnit,
+    CurrencyFrequencyUnit,
+    EnergyCostUnit,
+    MassPerTimeUnit,
+)
 
 CONSTRUCTION_CAPEX_SCHEDULE_PARAMETER_NAME = 'Construction CAPEX Schedule'
 
@@ -246,6 +254,15 @@ def investment_tax_credit_output_parameter() -> OutputParameter:
     )
 
 
+def carbon_extracted_annually_output_parameter() -> OutputParameter:
+    return OutputParameter(
+        Name="Tonnes per Year CO2 extracted",
+        UnitType=Units.MASSPERTIME,
+        PreferredUnits=MassPerTimeUnit.TONNEPERYEAR,
+        CurrentUnits=MassPerTimeUnit.TONNEPERYEAR,
+    )
+
+
 def expand_schedule_dsl(schedule_strings: list[str | float], total_years: int) -> list[float]:
     """
     Parse a duration-based scheduling DSL and expand it into a fixed-length time-series array.