IRR + VIR=PI=PIR output param display names

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -1820,12 +1820,14 @@ def __init__(self, model: Model):
         )
         self.ProjectIRR = self.OutputParameterDict[self.ProjectIRR.Name] = OutputParameter(
             "Project Internal Rate of Return",
+            display_name='Project IRR',
             UnitType=Units.PERCENT,
             CurrentUnits=PercentUnit.PERCENT,
             PreferredUnits=PercentUnit.PERCENT,
         )
         self.ProjectVIR = self.OutputParameterDict[self.ProjectVIR.Name] = OutputParameter(
             "Project Value Investment Ratio",
+            display_name='Project VIR=PI=PIR',
             UnitType=Units.PERCENT,
             PreferredUnits=PercentUnit.TENTH,
             CurrentUnits=PercentUnit.TENTH

src/geophires_x/Outputs.py

@@ -238,26 +238,26 @@ def PrintOutputs(self, model: Model):
                 f.write('                           ***ECONOMIC PARAMETERS***\n')
                 f.write(NL)
                 if model.economics.econmodel.value == EconomicModel.FCR:
-                    f.write('      Economic Model = ' + model.economics.econmodel.value.value + NL)
-                    f.write(f'      Fixed Charge Rate (FCR):                          {model.economics.FCR.value*100.0:10.2f} ' + model.economics.FCR.CurrentUnits.value + NL)
+                    f.write(f'      Economic Model = {model.economics.econmodel.value.value}\n')
+                    f.write(f'      Fixed Charge Rate (FCR):                          {model.economics.FCR.value*100.0:10.2f} {model.economics.FCR.CurrentUnits.value}\n')
                 elif model.economics.econmodel.value == EconomicModel.STANDARDIZED_LEVELIZED_COST:
-                    f.write('      Economic Model = ' + model.economics.econmodel.value.value + NL)
+                    f.write(f'      Economic Model = {model.economics.econmodel.value.value}\n')
                     f.write(f'      {model.economics.interest_rate.Name}:                                    {model.economics.interest_rate.value:10.2f} {model.economics.interest_rate.CurrentUnits.value}\n')
 
                 elif model.economics.econmodel.value == EconomicModel.BICYCLE:
-                    f.write('      Economic Model  = ' + model.economics.econmodel.value.value + NL)
-                f.write(f'      Accrued financing during construction:            {model.economics.inflrateconstruction.value*100:10.2f} ' + model.economics.inflrateconstruction.CurrentUnits.value + NL)
-                f.write(f'      Project lifetime:                              {model.surfaceplant.plant_lifetime.value:10.0f} ' + model.surfaceplant.plant_lifetime.CurrentUnits.value + NL)
-                f.write(f'      Capacity factor:                                 {model.surfaceplant.utilization_factor.value * 100:10.1f} %' + NL)
+                    f.write(f'      Economic Model  = {model.economics.econmodel.value.value}\n')
+                f.write(f'      Accrued financing during construction:            {model.economics.inflrateconstruction.value*100:10.2f} {model.economics.inflrateconstruction.CurrentUnits.value}\n')
+                f.write(f'      Project lifetime:                              {model.surfaceplant.plant_lifetime.value:10.0f} {model.surfaceplant.plant_lifetime.CurrentUnits.value}\n')
+                f.write(f'      Capacity factor:                                 {model.surfaceplant.utilization_factor.value * 100:10.1f} %\n')
 
                 e_npv: OutputParameter = model.economics.ProjectNPV
                 npv_field_label = Outputs._field_label(e_npv.display_name, 49)
                 # TODO should use CurrentUnits instead of PreferredUnits
                 f.write(f'      {npv_field_label}{e_npv.value:10.2f} {e_npv.PreferredUnits.value}\n')
 
-                f.write(f'      Project IRR:                                     {model.economics.ProjectIRR.value:10.2f} ' + model.economics.ProjectIRR.PreferredUnits.value + NL)
-                f.write(f'      Project VIR=PI=PIR:                              {model.economics.ProjectVIR.value:10.2f}' + NL)
-                f.write(f'      {model.economics.ProjectMOIC.Name}:                                    {model.economics.ProjectMOIC.value:10.2f}' + NL)
+                f.write(f'      {model.economics.ProjectIRR.display_name}:                                     {model.economics.ProjectIRR.value:10.2f} {model.economics.ProjectIRR.PreferredUnits.value}\n')
+                f.write(f'      {model.economics.ProjectVIR.display_name}:                              {model.economics.ProjectVIR.value:10.2f}\n')
+                f.write(f'      {model.economics.ProjectMOIC.Name}:                                    {model.economics.ProjectMOIC.value:10.2f}\n')
 
                 payback_period_val = model.economics.ProjectPaybackPeriod.value
                 project_payback_period_display = f'{payback_period_val:10.2f} {model.economics.ProjectPaybackPeriod.PreferredUnits.value}' \

src/geophires_x/Reservoir.py

@@ -104,7 +104,7 @@ def __init__(self, model: Model):
             CurrentUnits=TemperatureGradientUnit.DEGREESCPERM,
             Required=True,
             ErrMessage="assume default geothermal gradients 1 (50, 0, 0, 0 deg.C/km)",
-            ToolTipText="Geothermal gradients"
+            ToolTipText="Geothermal gradient(s)"
         )
 
         self.gradient1 = self.ParameterDict[self.gradient1.Name] = floatParameter(

src/geophires_x_schema_generator/geophires-request.json

@@ -125,7 +125,7 @@
       "maximum": 4
     },
     "Gradients": {
-      "description": "Geothermal gradients",
+      "description": "Geothermal gradient(s)",
       "type": "array",
       "units": "degC/m",
       "category": "Reservoir",

src/geophires_x_schema_generator/geophires-result.json

@@ -70,8 +70,16 @@
           "description": "Project Net Present Value. NPV is calculated with cashflows lumped at the end of periods. See: Short W et al, 1995. \"A Manual for the Economic Evaluation of Energy Efficiency and Renewable Energy Technologies.\", p. 41. https://www.nrel.gov/docs/legosti/old/5173.pdf",
           "units": "MUSD"
         },
-        "Project IRR": {},
-        "Project VIR=PI=PIR": {},
+        "Project IRR": {
+          "type": "number",
+          "description": "Project Internal Rate of Return",
+          "units": "%"
+        },
+        "Project VIR=PI=PIR": {
+          "type": "number",
+          "description": "Project Value Investment Ratio",
+          "units": ""
+        },
         "Project MOIC": {
           "type": "number",
           "description": "Project Multiple of Invested Capital",