Fix Reservoir Volume Option tooltip text

Author: softwareengineerprogrammer

src/geophires_x/OptionList.py

@@ -137,6 +137,10 @@ def from_int(int_val):
 
 
 class ReservoirVolume(GeophiresInputEnum):
+    """
+    TODO should probably be renamed to ReservoirVolumeOption
+    """
+
     FRAC_NUM_SEP = 1, "Specify number of fractures and fracture separation"
     RES_VOL_FRAC_SEP = 2, "Specify reservoir volume and fracture separation"
     RES_VOL_FRAC_NUM = 3, "Specify reservoir volume and number of fractures"

src/geophires_x/Reservoir.py

@@ -221,6 +221,7 @@ def __init__(self, model: Model):
             ToolTipText="Thickness of rock segment 4"
         )
 
+        # noinspection SpellCheckingInspection
         self.resvoloption = self.ParameterDict[self.resvoloption.Name] = intParameter(
             "Reservoir Volume Option",
             DefaultValue=ReservoirVolume.RES_VOL_FRAC_NUM.int_value,
@@ -229,14 +230,11 @@ def __init__(self, model: Model):
             Required=True,
             UnitType=Units.NONE,
             ErrMessage="assume default reservoir volume option",
-            ToolTipText=(
-                "Specifies how the reservoir volume, and fracture distribution (for reservoir models 1 and 2) "
-                "are calculated. The reservoir volume is used by GEOPHIRES to estimate the stored heat in place. The "
-                "fracture distribution is needed as input for the EGS fracture-based reservoir models 1 and 2: "
-                "Specify number of fractures and fracture separation, 2: Specify reservoir volume and fracture separation, "
-                "3: Specify reservoir volume and number of fractures, 4: Specify reservoir volume only "
-                "(sufficient for reservoir models 3, 4, 5 and 6)"
-            )
+            ToolTipText="Specifies how the reservoir volume, and fracture distribution (for reservoir models 1 and 2) "
+                        "are calculated. The reservoir volume is used by GEOPHIRES to estimate the stored "
+                        "heat in place. The fracture distribution is needed as input for the EGS fracture-based "
+                        "reservoir models 1 and 2. " +
+                        '; '.join([f'{it.int_value}: {it.name}: {it.value}' for it in ReservoirVolume])
         )
 
         self.fracshape = self.ParameterDict[self.fracshape.Name] = intParameter(

src/geophires_x_schema_generator/geophires-request.json

@@ -226,7 +226,7 @@
       "maximum": 100.0
     },
     "Reservoir Volume Option": {
-      "description": "Specifies how the reservoir volume, and fracture distribution (for reservoir models 1 and 2) are calculated. The reservoir volume is used by GEOPHIRES to estimate the stored heat in place. The fracture distribution is needed as input for the EGS fracture-based reservoir models 1 and 2: Specify number of fractures and fracture separation, 2: Specify reservoir volume and fracture separation, 3: Specify reservoir volume and number of fractures, 4: Specify reservoir volume only (sufficient for reservoir models 3, 4, 5 and 6)",
+      "description": "Specifies how the reservoir volume, and fracture distribution (for reservoir models 1 and 2) are calculated. The reservoir volume is used by GEOPHIRES to estimate the stored heat in place. The fracture distribution is needed as input for the EGS fracture-based reservoir models 1 and 2. 1: FRAC_NUM_SEP: Specify number of fractures and fracture separation; 2: RES_VOL_FRAC_SEP: Specify reservoir volume and fracture separation; 3: RES_VOL_FRAC_NUM: Specify reservoir volume and number of fractures; 4: RES_VOL_ONLY: Specify reservoir volume only",
       "type": "integer",
       "units": null,
       "category": "Reservoir",