Add-ons parameters tooltip text including pattern for specifying multiple add-ons.

Author: softwareengineerprogrammer

src/geophires_x/EconomicsAddOns.py

@@ -46,51 +46,60 @@ def __init__(self, model: Model):
         self.MyClass = sclass.replace("\'>", "")
         self.MyPath = os.path.abspath(__file__)
 
+        def multi_addon_tooltip_text(param_name: str) -> str:
+            return f'If using multiple add-ons, suffix with a number e.g. \'{param_name} 1\', \'{param_name} 2\', etc.'
+
         self.AddOnNickname = self.ParameterDict[self.AddOnNickname.Name] = listParameter(
             "AddOn Nickname",
             UnitType=Units.NONE,
             Min=0.0,
-            Max=1000.0
+            Max=1000.0,
+            ToolTipText=multi_addon_tooltip_text("AddOn Nickname")
         )
         self.AddOnCAPEX = self.ParameterDict[self.AddOnCAPEX.Name] = listParameter(
             "AddOn CAPEX",
             Min=0.0,
             Max=1000.0,
             UnitType=Units.CURRENCY,
             PreferredUnits=CurrencyUnit.MDOLLARS,
-            CurrentUnits=CurrencyUnit.MDOLLARS
+            CurrentUnits=CurrencyUnit.MDOLLARS,
+            ToolTipText=multi_addon_tooltip_text("AddOn CAPEX")
         )
         self.AddOnOPEXPerYear = self.ParameterDict[self.AddOnOPEXPerYear.Name] = listParameter(
             "AddOn OPEX",
             Min=0.0,
             Max=1000.0,
             UnitType=Units.CURRENCYFREQUENCY,
             PreferredUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
-            CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR
+            CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
+            ToolTipText=f'Annual operating cost. {multi_addon_tooltip_text("AddOn OPEX")}'
         )
         self.AddOnElecGainedPerYear = self.ParameterDict[self.AddOnElecGainedPerYear.Name] = listParameter(
             "AddOn Electricity Gained",
             Min=0.0,
             Max=1000.0,
             UnitType=Units.ENERGYFREQUENCY,
             PreferredUnits=EnergyFrequencyUnit.KWPERYEAR,
-            CurrentUnits=EnergyFrequencyUnit.KWPERYEAR
+            CurrentUnits=EnergyFrequencyUnit.KWPERYEAR,
+            ToolTipText=f'Annual electricity gained. {multi_addon_tooltip_text("AddOn Electricity Gained")}'
         )
         self.AddOnHeatGainedPerYear = self.ParameterDict[self.AddOnHeatGainedPerYear.Name] = listParameter(
             "AddOn Heat Gained",
             Min=0.0,
             Max=1000.0,
             UnitType=Units.ENERGYFREQUENCY,
             PreferredUnits=EnergyFrequencyUnit.KWPERYEAR,
-            CurrentUnits=EnergyFrequencyUnit.KWPERYEAR
+            CurrentUnits=EnergyFrequencyUnit.KWPERYEAR,
+            ToolTipText=f'Annual heat gained. {multi_addon_tooltip_text("AddOn Heat Gained")}'
         )
         self.AddOnProfitGainedPerYear = self.ParameterDict[self.AddOnProfitGainedPerYear.Name] = listParameter(
             "AddOn Profit Gained",
             Min=0.0,
             Max=1000.0,
             UnitType=Units.CURRENCYFREQUENCY,
             PreferredUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
-            CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR
+            CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
+            ToolTipText=f'Annual profit gained. {multi_addon_tooltip_text("AddOn Profit Gained")}'
         )
 
         # local variables that need initialization
@@ -99,7 +108,7 @@ def __init__(self, model: Model):
             "AddOn CAPEX Total",
             UnitType=Units.CURRENCY,
             PreferredUnits=CurrencyUnit.MDOLLARS,
-            CurrentUnits=CurrencyUnit.MDOLLARS
+            CurrentUnits=CurrencyUnit.MDOLLARS,
         )
         self.AddOnOPEXTotalPerYear = self.OutputParameterDict[self.AddOnOPEXTotalPerYear.Name] = OutputParameter(
             "AddOn OPEX Total Per Year",
@@ -242,7 +251,7 @@ def read_parameters(self, model: Model) -> None:
             if key.startswith("AddOn Profit Gained"):
                 val = float(model.InputParameters[key].sValue)
                 self.AddOnProfitGainedPerYear.value.append(val)  # this assumes they put the values in the file in consecutive fashion
-        model.logger.info("complete " + str(__class__) + ": " + sys._getframe().f_code.co_name)
+        model.logger.info(f"complete {__class__!s}: {sys._getframe().f_code.co_name}")
 
     def Calculate(self, model: Model) -> None:
         """

src/geophires_x_schema_generator/geophires-request.json

@@ -2217,7 +2217,7 @@
       "maximum": 10000.0
     },
     "AddOn Nickname": {
-      "description": "",
+      "description": "If using multiple add-ons, suffix with a number e.g. 'AddOn Nickname 1', 'AddOn Nickname 2', etc.",
       "type": "array",
       "units": null,
       "category": "Economics",
@@ -2226,7 +2226,7 @@
       "maximum": 1000.0
     },
     "AddOn CAPEX": {
-      "description": "",
+      "description": "If using multiple add-ons, suffix with a number e.g. 'AddOn CAPEX 1', 'AddOn CAPEX 2', etc.",
       "type": "array",
       "units": "MUSD",
       "category": "Economics",
@@ -2235,7 +2235,7 @@
       "maximum": 1000.0
     },
     "AddOn OPEX": {
-      "description": "",
+      "description": "Annual operating cost. If using multiple add-ons, suffix with a number e.g. 'AddOn OPEX 1', 'AddOn OPEX 2', etc.",
       "type": "array",
       "units": "MUSD/yr",
       "category": "Economics",
@@ -2244,7 +2244,7 @@
       "maximum": 1000.0
     },
     "AddOn Electricity Gained": {
-      "description": "",
+      "description": "Annual electricity gained. If using multiple add-ons, suffix with a number e.g. 'AddOn Electricity Gained 1', 'AddOn Electricity Gained 2', etc.",
       "type": "array",
       "units": "kW/yr",
       "category": "Economics",
@@ -2253,7 +2253,7 @@
       "maximum": 1000.0
     },
     "AddOn Heat Gained": {
-      "description": "",
+      "description": "Annual heat gained. If using multiple add-ons, suffix with a number e.g. 'AddOn Heat Gained 1', 'AddOn Heat Gained 2', etc.",
       "type": "array",
       "units": "kW/yr",
       "category": "Economics",
@@ -2262,7 +2262,7 @@
       "maximum": 1000.0
     },
     "AddOn Profit Gained": {
-      "description": "",
+      "description": "Annual profit gained. If using multiple add-ons, suffix with a number e.g. 'AddOn Profit Gained 1', 'AddOn Profit Gained 2', etc.",
       "type": "array",
       "units": "MUSD/yr",
       "category": "Economics",