Move royalty outputs to EXTENDED ECONOMICS

Author: softwareengineerprogrammer

src/geophires_x/Outputs.py

@@ -2,7 +2,9 @@
 import math
 import time
 import sys
+from io import TextIOWrapper
 from pathlib import Path
+from typing import Any
 
 # noinspection PyPackageRequirements
 import numpy as np
@@ -324,19 +326,6 @@ def PrintOutputs(self, model: Model):
                 if model.surfaceplant.enduse_option.value in [EndUseOptions.ELECTRICITY]:
                     f.write(f'      Estimated Jobs Created:                                 {model.economics.jobs_created.value}\n')
 
-                if econ.royalty_rate.Provided:
-                    for royalty_output in [
-                        econ.royalty_holder_npv,
-                        econ.royalty_holder_annual_revenue,
-                        econ.royalty_holder_total_revenue
-                    ]:
-                        label = Outputs._field_label(royalty_output.display_name, 49)
-                        f.write(
-                            f'      {label}{royalty_output.value:10.2f} {royalty_output.CurrentUnits.value}\n')
-
-
-
-
                 f.write(NL)
                 f.write('                          ***ENGINEERING PARAMETERS***\n')
                 f.write(NL)
@@ -803,9 +792,25 @@ def PrintOutputs(self, model: Model):
 
             addon_df = pd.DataFrame()
             addon_results = []
+            extended_economics_header_printed = False
             if model.economics.DoAddOnCalculations.value and not is_sam_econ_model:
                 # SAM econ models incorporate add-on economics into main economics, not as separate extended economics.
                 addon_df, addon_results = model.addoutputs.PrintOutputs(model)
+                extended_economics_header_printed = True
+
+            if econ.royalty_rate.Provided:
+                with open(self.output_file, 'a', encoding='UTF-8') as f_:
+                    if not extended_economics_header_printed:
+                        self._print_extended_economics_header(f_)
+
+                    for royalty_output in [
+                        econ.royalty_holder_npv,
+                        econ.royalty_holder_annual_revenue,
+                        econ.royalty_holder_total_revenue
+                    ]:
+                        label = Outputs._field_label(royalty_output.display_name, 49)
+                        f_.write(
+                            f'      {label}{royalty_output.value:10.2f} {royalty_output.CurrentUnits.value}\n')
 
             sdac_df = pd.DataFrame()
             sdac_results = []
@@ -909,6 +914,24 @@ def get_sam_cash_flow_profile_output(self, model):
 
         return ret
 
+    def _print_extended_economics_header(self, f_output_file: TextIOWrapper | None = None) -> None:
+        """
+        Header may be printed by either OutputsAddOns, or parent class if royalties are calculated and add-ons are not.
+        """
+
+        close_f = False
+        if f_output_file is None:
+            f_output_file = open(self.output_file, 'a', encoding='UTF-8')
+            close_f = True
+
+        f_output_file.write(NL)
+        f_output_file.write(NL)
+        f_output_file.write("                                ***EXTENDED ECONOMICS***\n")
+        f_output_file.write(NL)
+
+        if close_f:
+            f_output_file.close()
+
     @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)}'

src/geophires_x/OutputsAddOns.py

@@ -29,10 +29,8 @@ def PrintOutputs(self, model) -> tuple[pd.DataFrame, list]:
         try:
             with open(self.output_file, 'a', encoding='UTF-8') as f:
                 addon_results: list[OutputTableItem] = []
-                f.write(NL)
-                f.write(NL)
-                f.write("                                ***EXTENDED ECONOMICS***\n")
-                f.write(NL)
+                self._print_extended_economics_header(f)
+
                 if model.economics.LCOE.value > -999.0:
                     f.write(f"      Adjusted Project LCOE (after incentives, grants, AddOns,etc):     {model.economics.LCOE.value:10.2f} " + model.economics.LCOE.PreferredUnits.value + NL)
                     addon_results.append(OutputTableItem('Adjusted Project LCOE (after incentives, grants, AddOns,etc)', '{0:10.2f}'.format(model.economics.LCOE.value), model.economics.LCOE.PreferredUnits.value))

src/geophires_x_client/geophires_x_result.py

@@ -93,9 +93,6 @@ class GeophiresXResult:
                 'Project Payback Period',
                 'CHP: Percent cost allocation for electrical plant',
                 'Estimated Jobs Created',
-                'Royalty Holder NPV',
-                'Royalty Holder Average Annual Revenue',
-                'Royalty Holder Total Revenue',
             ],
             'EXTENDED ECONOMICS': [
                 'Adjusted Project LCOE (after incentives, grants, AddOns,etc)',
@@ -113,6 +110,9 @@ class GeophiresXResult:
                 'Total Add-on Net Heat',
                 'Total Add-on Profit',
                 'AddOns Payback Period',
+                'Royalty Holder NPV',
+                'Royalty Holder Average Annual Revenue',
+                'Royalty Holder Total Revenue',
             ],
             'CCUS ECONOMICS': [
                 'Total Avoided Carbon Production',

src/geophires_x_schema_generator/geophires-result.json

@@ -143,21 +143,6 @@
           "type": "number",
           "description": "",
           "units": null
-        },
-        "Royalty Holder NPV": {
-          "type": "number",
-          "description": "Net Present Value (NPV) of the royalty holder's cash flow stream.",
-          "units": "MUSD"
-        },
-        "Royalty Holder Average Annual Revenue": {
-          "type": "number",
-          "description": "The royalty holder's annual revenue stream from the royalty agreement.",
-          "units": "MUSD/yr"
-        },
-        "Royalty Holder Total Revenue": {
-          "type": "number",
-          "description": "The total (undiscounted) revenue received by the royalty holder over the project lifetime.",
-          "units": "MUSD"
         }
       }
     },
@@ -186,7 +171,22 @@
         "Total Add-on Net Elec": {},
         "Total Add-on Net Heat": {},
         "Total Add-on Profit": {},
-        "AddOns Payback Period": {}
+        "AddOns Payback Period": {},
+        "Royalty Holder NPV": {
+          "type": "number",
+          "description": "Net Present Value (NPV) of the royalty holder's cash flow stream.",
+          "units": "MUSD"
+        },
+        "Royalty Holder Average Annual Revenue": {
+          "type": "number",
+          "description": "The royalty holder's annual revenue stream from the royalty agreement.",
+          "units": "MUSD/yr"
+        },
+        "Royalty Holder Total Revenue": {
+          "type": "number",
+          "description": "The total (undiscounted) revenue received by the royalty holder over the project lifetime.",
+          "units": "MUSD"
+        }
       }
     },
     "CCUS ECONOMICS": {

tests/test_geophires_x.py

@@ -9,9 +9,6 @@
 
 import numpy as np
 
-# @formatter:off
-# noinspection PyProtectedMember
-from geophires_x.EconomicsSam import _cash_flow_profile_row
 from geophires_x.OptionList import PlantType
 from geophires_x.OptionList import WellDrillingCostCorrelation
 from geophires_x_client import GeophiresXClient
@@ -24,7 +21,10 @@
 from geophires_x_client.geophires_input_parameters import ImmutableGeophiresInputParameters
 from geophires_x_tests.test_options_list import WellDrillingCostCorrelationTestCase
 
-# @formatter:on
+# noinspection PyProtectedMember
+# ruff: noqa: I001  # Successful module initialization is dependent on this specific import order.
+from geophires_x.EconomicsSam import _cash_flow_profile_row
+
 from tests.base_test_case import BaseTestCase
 
 
@@ -1338,7 +1338,7 @@ def test_royalty_rate(self):
 
             self.assertEqual(opex_line_item_sum, total_opex_MUSD)
 
-            econ_result = result.result['ECONOMIC PARAMETERS']
+            econ_result = result.result['EXTENDED ECONOMICS']
             royalty_holder_npv_MUSD = econ_result['Royalty Holder NPV']['value']
 
             if royalty_rate > 0.0: