finish impl of royalty holder outputs

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -2157,7 +2157,7 @@ def __init__(self, model: Model):
         self.royalty_holder_annual_revenue = self.OutputParameterDict[
             self.royalty_holder_annual_revenue.Name
         ] = OutputParameter(
-            'Royalty Holder Annual Revenue',
+            'Royalty Holder Average Annual Revenue',
             UnitType=Units.CURRENCYFREQUENCY,
             PreferredUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
             CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
@@ -3289,7 +3289,7 @@ def _calculate_sam_economics(self, model: Model) -> None:
 
 
         if self.royalty_rate.Provided:
-            average_annual_royalties = np.average(
+            average_annual_royalties = np.average(  # TODO unit conversion
                 self.sam_economics_calculations.royalties_opex.value[1:]  # ignore pre-revenue year(s) (Year 0)
             )
 
@@ -3301,9 +3301,10 @@ def _calculate_sam_economics(self, model: Model) -> None:
                 self.sam_economics_calculations.royalties_opex.value,
                 self.discount_initial_year_cashflow.value
             )
-            # FIXME WIP
-            # self.royalty_holder_annual_revenue
-            # self.royalty_holder_total_revenue
+            self.royalty_holder_annual_revenue.value = self.royalties_average_annual_cost.value
+            self.royalty_holder_total_revenue.value = np.sum(  # TODO unit conversion
+                self.sam_economics_calculations.royalties_opex.value[1:]  # ignore pre-revenue year(s) (Year 0)
+            )
 
 
         self.wacc.value = self.sam_economics_calculations.wacc.value

src/geophires_x/Outputs.py

@@ -325,9 +325,16 @@ def PrintOutputs(self, model: Model):
                     f.write(f'      Estimated Jobs Created:                                 {model.economics.jobs_created.value}\n')
 
                 if econ.royalty_rate.Provided:
-                    royalty_holder_npv_label = Outputs._field_label(econ.royalty_holder_npv.display_name, 49)
-                    f.write(
-                        f'         {royalty_holder_npv_label}{econ.royalty_holder_npv.value:10.2f} {econ.royalty_holder_npv.CurrentUnits.value}\n')
+                    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)

src/geophires_x_client/geophires_x_result.py

@@ -94,6 +94,8 @@ class GeophiresXResult:
                 '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)',

src/geophires_x_schema_generator/geophires-request.json

@@ -1647,6 +1647,15 @@
       "minimum": 0.0,
       "maximum": 1.0
     },
+    "Royalty Holder Discount Rate": {
+      "description": "Royalty holder discount rate used in SAM Economic Models.",
+      "type": "number",
+      "units": "",
+      "category": "Economics",
+      "default": 0.05,
+      "minimum": 0.0,
+      "maximum": 1.0
+    },
     "Discount Initial Year Cashflow": {
       "description": "Whether to discount cashflow in the initial project year when calculating NPV (Net Present Value). The default value of False conforms to NREL's standard convention for NPV calculation (Short W et al, 1995. https://www.nrel.gov/docs/legosti/old/5173.pdf). A value of True will, by contrast, cause NPV calculation to follow the convention used by Excel, Google Sheets, and other common spreadsheet software. Although NREL's NPV convention may typically be considered more technically correct, Excel-style NPV calculation might be preferred for familiarity or compatibility with existing business processes. See https://github.com/NREL/GEOPHIRES-X/discussions/344 for further details.",
       "type": "boolean",

src/geophires_x_schema_generator/geophires-result.json

@@ -143,6 +143,21 @@
           "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"
         }
       }
     },

tests/test_geophires_x.py

@@ -9,6 +9,7 @@
 
 import numpy as np
 
+# @formatter:off
 # noinspection PyProtectedMember
 from geophires_x.EconomicsSam import _cash_flow_profile_row
 from geophires_x.OptionList import PlantType
@@ -22,6 +23,8 @@
 from geophires_x_client.geophires_input_parameters import GeophiresInputParameters
 from geophires_x_client.geophires_input_parameters import ImmutableGeophiresInputParameters
 from geophires_x_tests.test_options_list import WellDrillingCostCorrelationTestCase
+
+# @formatter:on
 from tests.base_test_case import BaseTestCase