Tweak name to 'After-tax IRR' for consistency with SAM name and existing GEOPHIRES hyphenated result fields. Result backwards compatibility maintained with previous capitalization

Author: softwareengineerprogrammer

src/geophires_x/EconomicsUtils.py

@@ -39,11 +39,11 @@ def BuildPricingModel(plantlifetime: int, StartPrice: float, EndPrice: float,
 
 def after_tax_irr_parameter() -> OutputParameter:
     return OutputParameter(
-        Name='After-Tax IRR',
+        Name='After-tax IRR',
         UnitType=Units.PERCENT,
         CurrentUnits=PercentUnit.PERCENT,
         PreferredUnits=PercentUnit.PERCENT,
-        ToolTipText='The After-Tax IRR (internal rate of return) is the nominal discount rate that corresponds to '
+        ToolTipText='The After-tax IRR (internal rate of return) is the nominal discount rate that corresponds to '
                     'a net present value (NPV) of zero for PPA SAM Economic models. '
                     'See https://samrepo.nrelcloud.org/help/mtf_irr.html.'
     )

src/geophires_x_client/geophires_x_result.py

@@ -76,6 +76,7 @@ class GeophiresXResult:
                 'Project NPV',
                 'Project IRR',
                 'After-Tax IRR',
+                'After-tax IRR',
                 'Project VIR=PI=PIR',
                 'Project MOIC',
                 'Fixed Charge Rate (FCR)',  # SUTRA

src/geophires_x_schema_generator/__init__.py

@@ -140,7 +140,9 @@ def generate_json_schema(self) -> Tuple[dict, dict]:
             'properties': properties,
         }
 
-        return request_schema, self.get_result_json_schema(output_params_json)
+        result_schema = self.get_result_json_schema(output_params_json)
+
+        return request_schema, result_schema
 
     def get_result_json_schema(self, output_params_json) -> dict:
         properties = {}
@@ -165,6 +167,11 @@ def get_result_json_schema(self, output_params_json) -> dict:
             for field in GeophiresXResult._RESULT_FIELDS_BY_CATEGORY[category]:
                 param_name = field if isinstance(field, str) else field.field_name
 
+                ignored_output_param_names = ['After-Tax IRR']  # Silently ignored in favor of "After-tax IRR"
+
+                if param_name in ignored_output_param_names:
+                    continue
+
                 if param_name in properties:
                     _log.warning(f'Param {param_name} is already in properties: {properties[param_name]}')
 

src/geophires_x_schema_generator/geophires-result.json

@@ -102,9 +102,9 @@
           "description": "Project Internal Rate of Return",
           "units": "%"
         },
-        "After-Tax IRR": {
+        "After-tax IRR": {
           "type": "number",
-          "description": "The After-Tax IRR (internal rate of return) is the nominal discount rate that corresponds to a net present value (NPV) of zero for PPA SAM Economic models. See https://samrepo.nrelcloud.org/help/mtf_irr.html.",
+          "description": "The After-tax IRR (internal rate of return) is the nominal discount rate that corresponds to a net present value (NPV) of zero for PPA SAM Economic models. See https://samrepo.nrelcloud.org/help/mtf_irr.html.",
           "units": "%"
         },
         "Project VIR=PI=PIR": {

tests/examples/Fervo_Project_Cape-4.out

@@ -6,7 +6,7 @@ Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.9.10
  Simulation Date: 2025-05-23
- Simulation Time:  10:35
+ Simulation Time:  12:57
  Calculation Time:      1.052 sec
 
                            ***SUMMARY OF RESULTS***
@@ -31,7 +31,7 @@ Simulation Metadata
       Project lifetime:                                      20 yr
       Capacity factor:                                       90.0 %
       Project NPV:                                         791.59 MUSD
-      After-Tax IRR:                                        17.18 %
+      After-tax IRR:                                        17.18 %
       Estimated Jobs Created:                                 1190
 
                           ***ENGINEERING PARAMETERS***

tests/examples/example_SAM-single-owner-PPA-2.out

@@ -5,9 +5,9 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.9.10
- Simulation Date: 2025-05-22
- Simulation Time:  07:11
- Calculation Time:      0.874 sec
+ Simulation Date: 2025-05-23
+ Simulation Time:  12:57
+ Calculation Time:      0.879 sec
 
                            ***SUMMARY OF RESULTS***
 
@@ -31,7 +31,7 @@ Simulation Metadata
       Project lifetime:                                      20 yr
       Capacity factor:                                       90.0 %
       Project NPV:                                        2877.00 MUSD
-      After-Tax IRR:                                        59.73 %
+      After-tax IRR:                                        59.73 %
       Estimated Jobs Created:                                 976
 
                           ***ENGINEERING PARAMETERS***

tests/examples/example_SAM-single-owner-PPA.out

@@ -5,9 +5,9 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.9.10
- Simulation Date: 2025-05-21
- Simulation Time:  13:19
- Calculation Time:      1.058 sec
+ Simulation Date: 2025-05-23
+ Simulation Time:  12:57
+ Calculation Time:      1.052 sec
 
                            ***SUMMARY OF RESULTS***
 
@@ -31,7 +31,7 @@ Simulation Metadata
       Project lifetime:                                      20 yr
       Capacity factor:                                       90.0 %
       Project NPV:                                         124.91 MUSD
-      After-Tax IRR:                                        22.33 %
+      After-tax IRR:                                        22.33 %
       Estimated Jobs Created:                                 125
 
                           ***ENGINEERING PARAMETERS***

tests/test_geophires_x.py

@@ -254,9 +254,9 @@ def _sanitize_nan(self, r: GeophiresXResult) -> None:
         Workaround for float('nan') != float('nan')
         See https://stackoverflow.com/questions/51728427/unittest-how-to-assert-if-the-two-possibly-nan-values-are-equal
 
-        TODO generalize beyond After-Tax IRR
+        TODO generalize beyond After-tax IRR
         """
-        irr_key = 'After-Tax IRR'
+        irr_key = 'After-tax IRR'
         if irr_key in r.result['ECONOMIC PARAMETERS']:
             try:
                 if math.isnan(r.result['ECONOMIC PARAMETERS'][irr_key]['value']):