Skip to content

Commit d95cfb0

Browse files
Document DR/FIR equivalency
1 parent 6281bd8 commit d95cfb0

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

src/geophires_x/Economics.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -849,7 +849,9 @@ def __init__(self, model: Model):
849849
PreferredUnits=PercentUnit.TENTH,
850850
CurrentUnits=PercentUnit.TENTH,
851851
ErrMessage=f'assume default discount rate ({discount_rate_default_val})',
852-
ToolTipText="Discount rate used in the Standard Levelized Cost Model"
852+
ToolTipText="Discount rate used in the Standard Levelized Cost Model. "
853+
"Discount Rate is synonymous with Fixed Internal Rate. If one is provided, the other's value "
854+
"will be automatically set to the same value."
853855
)
854856
self.FIB = self.ParameterDict[self.FIB.Name] = floatParameter(
855857
"Fraction of Investment in Bonds",
@@ -1394,7 +1396,9 @@ def __init__(self, model: Model):
13941396
PreferredUnits=PercentUnit.PERCENT,
13951397
CurrentUnits=fir_default_unit,
13961398
ErrMessage=f'assume default for fixed internal rate ({fir_default_val}%)',
1397-
ToolTipText="Fixed Internal Rate (used in NPV calculation)"
1399+
ToolTipText="Fixed Internal Rate (used in NPV calculation). "
1400+
"Fixed Internal Rate is synonymous with Discount Rate. If one is provided, the other's value "
1401+
"will be automatically set to the same value."
13981402
)
13991403
self.CAPEX_heat_electricity_plant_ratio = self.ParameterDict[self.CAPEX_heat_electricity_plant_ratio.Name] = floatParameter(
14001404
"CHP Electrical Plant Cost Allocation Ratio",

src/geophires_x_schema_generator/geophires-request.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1536,7 +1536,7 @@
15361536
"maximum": 1.0
15371537
},
15381538
"Discount Rate": {
1539-
"description": "Discount rate used in the Standard Levelized Cost Model",
1539+
"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.",
15401540
"type": "number",
15411541
"units": "",
15421542
"category": "Economics",
@@ -2082,7 +2082,7 @@
20822082
"maximum": 1000.0
20832083
},
20842084
"Fixed Internal Rate": {
2085-
"description": "Fixed Internal Rate (used in NPV calculation)",
2085+
"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.",
20862086
"type": "number",
20872087
"units": "%",
20882088
"category": "Economics",

0 commit comments

Comments
 (0)