parse SAM cash flow profile in client, add example_SAM-single-owner-PPA

Author: softwareengineerprogrammer

src/geophires_x/EconomicsSamCashFlow.py

@@ -5,6 +5,7 @@
 import os
 import re
 import sys
+import math
 from functools import lru_cache
 from typing import Any
 
@@ -54,6 +55,9 @@ def adj(x_):
             if isinstance(x_, str):
                 return x_
             else:
+                if math.isnan(x_):
+                    return 'NaN'
+
                 return rnd(x_)
 
         return adj

src/geophires_x/GeoPHIRESUtils.py

@@ -621,3 +621,21 @@ def static_pressure_MPa(rho_kg_per_m3: float, depth_m: float) -> float:
 
     return pressure_mpa
 
+
+def is_int(o: Any) -> bool:
+    try:
+        float_n = float(o)
+        int_n = int(float_n)
+    except ValueError:
+        return False
+    else:
+        return float_n == int_n
+
+
+def is_float(o: Any) -> bool:
+    try:
+        float(o)
+    except ValueError:
+        return False
+    else:
+        return True

src/geophires_x/Outputs.py

@@ -770,7 +770,22 @@ def get_sam_cash_flow_profile_output(self, model):
         ret += '                            *  SAM CASH FLOW PROFILE  *\n'
         ret += '                            ***************************\n'
 
-        ret += get_sam_cash_flow_profile_tabulated_output(model)
+        cfp_o: str = get_sam_cash_flow_profile_tabulated_output(model)
+
+        # Ideally the separator line would be exactly the print width of the widest column, but the actual print width
+        # of tabs varies (at least according to https://stackoverflow.com/a/7643592). 4 spaces seems to be the minimum
+        # number that results in a separator line at least as wide as the table (narrower would be unsightly).
+        spaces_per_tab = 4
+
+        # The tabluate library has native separating line functionality (per https://pypi.org/project/tabulate/) but
+        # I wasn't able to get it to replicate the formatting as coded below.
+        separator_line = len(cfp_o.split('\n')[0].replace('\t',' ' * spaces_per_tab)) * '-'
+
+        ret += separator_line + '\n'
+        ret += cfp_o
+        ret += '\n' + separator_line
+
+        ret += '\n\n'
 
         return ret
 

src/geophires_x_client/geophires_x_result.py

@@ -6,8 +6,12 @@
 from io import StringIO
 from pathlib import Path
 from types import MappingProxyType
+from typing import Any
 from typing import ClassVar
 
+from geophires_x.GeoPHIRESUtils import is_float
+from geophires_x.GeoPHIRESUtils import is_int
+
 from .common import _get_logger
 from .geophires_input_parameters import EndUseOption
 
@@ -402,6 +406,10 @@ def __init__(self, output_file_path, logger_name=None):
         if sdacgt_profile is not None:
             self.result['S-DAC-GT PROFILE'] = sdacgt_profile
 
+        sam_cash_flow_profile = self._get_sam_cash_flow_profile()
+        if sam_cash_flow_profile is not None:
+            self.result['SAM CASH FLOW PROFILE'] = sam_cash_flow_profile
+
         self.result['metadata'] = {'output_file_path': self.output_file_path}
         for metadata_field in GeophiresXResult._METADATA_FIELDS:
             self.result['metadata'][metadata_field] = self._get_equal_sign_delimited_field(metadata_field)
@@ -726,6 +734,46 @@ def extract_table_header(lines: list) -> list:
             self._logger.debug(f'Failed to get legacy {GeophiresXResult.CCUS_PROFILE_LEGACY_NAME}: {e}')
             return None
 
+    def _get_sam_cash_flow_profile(self) -> list[Any]:
+        profile_name = 'SAM CASH FLOW PROFILE'
+
+        def _get_sam_cash_flow_profile_lines():
+            s1 = f'*  {profile_name}  *'
+            s2 = '-' * 50
+            return ''.join(self._lines).split(s1)[1].split(s2)[0].split(s2)[0]  # [5:]
+
+        try:
+            s1 = f'*  {profile_name}  *'
+            profile_text = ''.join(self._lines).split(s1)[1]
+            profile_text = re.split(r'^\s*-{20,}\s*$\n?', profile_text, flags=re.MULTILINE)[1]
+            rd = csv.reader(StringIO(profile_text), delimiter='\t', skipinitialspace=True)
+            profile_lines = []
+            for row in rd:
+                row_clean = []
+                for entry in row:
+                    entry_val = entry.rstrip()
+                    if is_int(entry_val):
+                        entry_val = int(float(entry_val))
+
+                    if is_float(entry_val):
+                        # FIXME WIP
+                        import math
+
+                        entry_val_float = float(entry_val)
+                        if math.isnan(entry_val_float):
+                            # entry_val = 'NaN' # FIXME WIP
+                            entry_val = math.nan
+                        else:
+                            entry_val = entry_val_float
+
+                    row_clean.append(entry_val)
+                profile_lines.append(row_clean)
+
+            return profile_lines
+        except BaseException as e:
+            self._logger.debug(f'Failed to get SAM cash flow profile: {e}')
+            return None
+
     def _extract_addons_style_table_data(self, lines: list):
         """TODO consolidate with _get_data_from_profile_lines"""