Merge pull request #305 from softwareengineerprogrammer/main

Document DR-FIR equivalency in parameters reference & changelog

CHANGELOG.rst

@@ -23,6 +23,8 @@ Affected users who do not want the new behavior can specify absolute output path
 
 3.6.1: Fixed Internal Rate default value changed to 7% from 6.25% per https://github.com/NREL/GEOPHIRES-X/issues/301
 
+3.6.3: Discount Rate and Fixed Internal Rate are now synonymous. If one is provided, the other's value will be automatically set to the same value.
+
 3.5
 ^^^
 

src/geophires_x/Economics.py

@@ -849,7 +849,9 @@ def __init__(self, model: Model):
             PreferredUnits=PercentUnit.TENTH,
             CurrentUnits=PercentUnit.TENTH,
             ErrMessage=f'assume default discount rate ({discount_rate_default_val})',
-            ToolTipText="Discount rate used in the Standard Levelized Cost Model"
+            ToolTipText="Discount rate used in the Standard Levelized Cost Model. "
+                        "Discount Rate is synonymous with Fixed Internal Rate. If one is provided, the other's value "
+                        "will be automatically set to the same value."
         )
         self.FIB = self.ParameterDict[self.FIB.Name] = floatParameter(
             "Fraction of Investment in Bonds",
@@ -1394,7 +1396,9 @@ def __init__(self, model: Model):
             PreferredUnits=PercentUnit.PERCENT,
             CurrentUnits=fir_default_unit,
             ErrMessage=f'assume default for fixed internal rate ({fir_default_val}%)',
-            ToolTipText="Fixed Internal Rate (used in NPV calculation)"
+            ToolTipText="Fixed Internal Rate (used in NPV calculation). "
+                        "Fixed Internal Rate is synonymous with Discount Rate. If one is provided, the other's value "
+                        "will be automatically set to the same value."
         )
         self.CAPEX_heat_electricity_plant_ratio = self.ParameterDict[self.CAPEX_heat_electricity_plant_ratio.Name] = floatParameter(
             "CHP Electrical Plant Cost Allocation Ratio",

src/geophires_x_schema_generator/geophires-request.json

@@ -1536,7 +1536,7 @@
       "maximum": 1.0
     },
     "Discount Rate": {
-      "description": "Discount rate used in the Standard Levelized Cost Model",
+      "description": "Discount rate used in the Standard Levelized Cost Model. Discount Rate is synonymous with Fixed Internal Rate. If one is provided, the other's value will be automatically set to the same value.",
       "type": "number",
       "units": "",
       "category": "Economics",
@@ -2082,7 +2082,7 @@
       "maximum": 1000.0
     },
     "Fixed Internal Rate": {
-      "description": "Fixed Internal Rate (used in NPV calculation)",
+      "description": "Fixed Internal Rate (used in NPV calculation). Fixed Internal Rate is synonymous with Discount Rate. If one is provided, the other's value will be automatically set to the same value.",
       "type": "number",
       "units": "%",
       "category": "Economics",