print tsv SAM cash flow profile in output file

Author: softwareengineerprogrammer

setup.py

@@ -81,11 +81,12 @@ def read(*names, **kwargs):
         'rich',
         'pylocker',
         'nrel-pysam',
+        'tabulate',
     ],
     extras_require={
         # eg:
         #   "rst": ["docutils>=0.11"],
         #   ":python_version=="2.6"": ["argparse"],
-        'development': ['bumpversion', 'tabulate']
+        'development': ['bumpversion']
     },
 )

src/geophires_x/Economics.py

@@ -4,7 +4,7 @@
 import numpy as np
 import numpy_financial as npf
 import geophires_x.Model as Model
-from geophires_x.EconomicsSam import calculate_sam_economics
+from geophires_x.EconomicsSam import calculate_sam_economics, _SAM_CASH_FLOW_PROFILE_KEY
 from geophires_x.OptionList import Configuration, WellDrillingCostCorrelation, EconomicModel, EndUseOptions, PlantType, \
     _WellDrillingCostCorrelationCitation
 from geophires_x.Parameter import intParameter, floatParameter, OutputParameter, ReadParameter, boolParameter, \
@@ -472,7 +472,7 @@ def CalculateLCOELCOHLCOC(econ, model: Model) -> tuple:
             LCOH = LCOH * 2.931  # $/Million Btu
     elif econ.econmodel.value == EconomicModel.SAM_SINGLE_OWNER_PPA:
         # FIXME TODO designate nominal (as opposed to real) in client result
-        LCOE = calculate_sam_economics(model)['LCOE (nominal)']['value']
+        LCOE = econ.sam_economics.value['LCOE (nominal)']['value']
     else:
         # must be BICYCLE
         # average return on investment (tax and inflation adjusted)
@@ -1858,6 +1858,14 @@ def __init__(self, model: Model):
             PreferredUnits=TimeUnit.YEAR,
             CurrentUnits=TimeUnit.YEAR
         )
+
+        # FIXME TODO/WIP representation in schema...
+        self.sam_economics = self.OutputParameterDict[self.sam_economics.Name] = OutputParameter(
+            'SAM Economics',
+            UnitType=Units.NONE,
+            json_parameter_type='object',
+        )
+
         self.RITCValue = self.OutputParameterDict[self.RITCValue.Name] = OutputParameter(
             Name="Investment Tax Credit Value",
             display_name='Investment Tax Credit',
@@ -2785,23 +2793,27 @@ def Calculate(self, model: Model) -> None:
             )
 
         if self.econmodel.value == EconomicModel.SAM_SINGLE_OWNER_PPA:
-            sam_economics = calculate_sam_economics(model)
-            self.ProjectNPV.value = sam_economics['NPV']['value']
-            self.ProjectIRR.value = sam_economics['IRR']['value']
+            self.sam_economics.value = calculate_sam_economics(model)
+            self.ProjectNPV.value = self.sam_economics.value['NPV']['value']
+            self.ProjectIRR.value = self.sam_economics.value['IRR']['value']
             # FIXME WIP VIR + MOIC
             self.ProjectVIR.value, self.ProjectMOIC.value = -1, -1
 
         # Calculate the project payback period
-        self.ProjectPaybackPeriod.value = 0.0   # start by assuming the project never pays back
-        for i in range(0, len(self.TotalCummRevenue.value), 1):
+
+        if self.econmodel.value == EconomicModel.SAM_SINGLE_OWNER_PPA:
+            self.ProjectPaybackPeriod.value = -1  # FIXME WIP
+        else:
+            self.ProjectPaybackPeriod.value = 0.0  # start by assuming the project never pays back
+            for i in range(0, len(self.TotalCummRevenue.value), 1):
                 # find out when the cumm cashflow goes from negative to positive
                 if self.TotalCummRevenue.value[i] > 0 >= self.TotalCummRevenue.value[i - 1]:
-                    # we just crossed the threshold into positive project cummcashflow, so we can calculate payback period
+                    # we just crossed the threshold into positive project cummcashflow,
+                    # so we can calculate payback period
                     dFullDiff = self.TotalCummRevenue.value[i] + math.fabs(self.TotalCummRevenue.value[(i - 1)])
                     dPerc = math.fabs(self.TotalCummRevenue.value[(i - 1)]) / dFullDiff
                     self.ProjectPaybackPeriod.value = i + dPerc
 
-
         # Calculate LCOE/LCOH
         self.LCOE.value, self.LCOH.value, self.LCOC.value = CalculateLCOELCOHLCOC(self, model)
 
@@ -2817,7 +2829,9 @@ def Calculate(self, model: Model) -> None:
     def calculate_cashflow(self, model: Model) -> None:
             """
             Calculate cashflow and cumulative cash flow
+            TODO/WIP adjust/skip for SAM economic model(s)
             """
+
             total_duration = model.surfaceplant.plant_lifetime.value + model.surfaceplant.construction_years.value
             self.ElecRevenue.value = [0.0] * total_duration
             self.ElecCummRevenue.value = [0.0] * total_duration

src/geophires_x/EconomicsSam.py

@@ -24,7 +24,7 @@
 
 import geophires_x.Model as Model
 
-_CASH_FLOW_PROFILE_KEY = 'Cash Flow'
+_SAM_CASH_FLOW_PROFILE_KEY = 'Cash Flow'
 
 
 @lru_cache(maxsize=12)
@@ -62,7 +62,7 @@ def calculate_sam_economics(model: Model) -> dict[str, dict[str, Any]]:
         ('CAPEX', single_owner.Outputs.adjusted_installed_cost * 1e-6, 'MUSD'),
         # ('Gross Output', gt.Outputs.gross_output, 'MW'),
         # ('Net Output', gt.Outputs.gross_output - gt.Outputs.pump_work, 'MW')
-        (_CASH_FLOW_PROFILE_KEY, cash_flow, None),
+        (_SAM_CASH_FLOW_PROFILE_KEY, cash_flow, None),
     ]
 
     # max_field_name_len = max(len(x[0]) for x in display_data)
@@ -74,7 +74,7 @@ def calculate_sam_economics(model: Model) -> dict[str, dict[str, Any]]:
         # print(f'{field_display}\t{sig_figs(e[1], 5)} {e[2]}')
 
         as_val = e[1]
-        if key != _CASH_FLOW_PROFILE_KEY:
+        if key != _SAM_CASH_FLOW_PROFILE_KEY:
             as_val = {'value': _sig_figs(e[1], 5), 'unit': e[2]}
 
         ret[key] = as_val

src/geophires_x/Outputs.py

@@ -4,10 +4,12 @@
 from pathlib import Path
 
 import numpy as np
+from tabulate import tabulate
 
 import geophires_x
 import geophires_x.Model as Model
 from geophires_x.Economics import Economics
+from geophires_x.EconomicsSam import _SAM_CASH_FLOW_PROFILE_KEY
 from geophires_x.OutputsRich import print_outputs_rich
 from geophires_x.Parameter import ConvertUnitsBack, ConvertOutputUnits, LookupUnits, strParameter, boolParameter, \
     OutputParameter, ReadParameter
@@ -736,7 +738,10 @@ def o(output_param: OutputParameter):
                             model.wellbores.PumpingPowerInj.value[i*model.economics.timestepsperyear.value],
                             model.wellbores.PumpingPower.value[i*model.economics.timestepsperyear.value]))
                         f.write(NL)
-                    f.write(NL)\
+                    f.write(NL)
+
+                if econ.econmodel.value == EconomicModel.SAM_SINGLE_OWNER_PPA:
+                    f.write(self.get_sam_cash_flow_profile_output(model))
 
         except BaseException as ex:
             tb = sys.exc_info()[2]
@@ -751,9 +756,27 @@ def o(output_param: OutputParameter):
 
         model.logger.info(f'Complete {__class__!s}: {sys._getframe().f_code.co_name}')
 
+    # noinspection PyMethodMayBeStatic
+    def get_sam_cash_flow_profile_output(self, model):
+        ret = '\n'
+        ret += '                            ***************************\n'
+        ret += '                            *  SAM CASH FLOW PROFILE  *\n'
+        ret += '                            ***************************\n'
+
+        ret += tabulate(
+            model.economics.sam_economics.value[_SAM_CASH_FLOW_PROFILE_KEY],
+            # tablefmt='pretty',
+            # tablefmt='psql',
+            # tablefmt='simple_grid',
+            #tablefmt='fancy_grid',
+            tablefmt='tsv',
+            floatfmt='.2f',
+            # headers='keys'
+        )
+
+        return ret
 
     @staticmethod
     def _field_label(field_name: str, print_width_before_value: int) -> str:
         return f'{field_name}:{" " * (print_width_before_value - len(field_name) - 1)}'
 
-

tests/geophires_x_tests/test_economics_sam.py

@@ -11,7 +11,7 @@
 # ruff: noqa: I001  # Successful module initialization is dependent on this specific import order.
 from geophires_x.Model import Model
 
-from geophires_x.EconomicsSam import calculate_sam_economics, _sig_figs, _CASH_FLOW_PROFILE_KEY
+from geophires_x.EconomicsSam import calculate_sam_economics, _sig_figs, _SAM_CASH_FLOW_PROFILE_KEY
 from geophires_x_client import GeophiresInputParameters
 from geophires_x_client import GeophiresXClient
 from geophires_x_client import GeophiresXResult
@@ -51,7 +51,7 @@ def test_cash_flow(self):
         m.Calculate()
 
         sam_econ = calculate_sam_economics(m)
-        cash_flow = sam_econ[_CASH_FLOW_PROFILE_KEY]
+        cash_flow = sam_econ[_SAM_CASH_FLOW_PROFILE_KEY]
         self.assertIsNotNone(cash_flow)
 
         print(