Specify ValuesEnum for End-Use Option which gets included in schema as enum_values

Author: softwareengineerprogrammer

src/geophires_x/GeoPHIRESUtils.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
 import logging
-import os
 import sys
+from enum import EnumType
 from os.path import exists
 import dataclasses
 import json
@@ -577,6 +577,22 @@ class _EnhancedJSONEncoder(json.JSONEncoder):
     def default(self, o):
         if dataclasses.is_dataclass(o):
             return dataclasses.asdict(o)
+
+        if isinstance(o, EnumType):
+            def get_entry(member) -> dict[str, Any]:
+                d = {
+                    'name': member.name,
+                    'value': member.value
+                }
+
+                if hasattr(member, 'numerical_input_value'):
+                    d['numerical_input_value'] = member.numerical_input_value
+
+                return d
+
+            ret = [get_entry(member) for member in o]
+            return ret
+
         return super().default(o)
 
 

src/geophires_x/Parameter.py

@@ -119,6 +119,8 @@ def UnitsMatch(self) -> bool:
 
     parameter_category: str = None
 
+    ValuesEnum:Enum = None
+
     def __post_init__(self):
         if self.PreferredUnits is None:
             self.PreferredUnits = self.CurrentUnits

src/geophires_x/SurfacePlant.py

@@ -234,6 +234,7 @@ def __init__(self, model: Model):
             "End-Use Option",
             value=EndUseOptions.ELECTRICITY,
             AllowableRange=[1, 2, 31, 32, 41, 42, 51, 52],
+            ValuesEnum=EndUseOptions,
             UnitType=Units.NONE,
             ErrMessage="assume default end-use option (1: electricity only)",
             ToolTipText="Select the end-use application of the geofluid heat: " +

src/geophires_x_schema_generator/__init__.py

@@ -105,6 +105,9 @@ def generate_json_schema(self) -> dict:
             if param['Required']:
                 required.append(param_name)
 
+            if param['ValuesEnum']:
+                properties[param_name]['enum_values'] = param['ValuesEnum']
+
         schema = {
             'definitions': {},
             '$schema': 'http://json-schema.org/draft-04/schema#',

src/geophires_x_schema_generator/geophires-request.json

@@ -698,7 +698,49 @@
       "category": "Surface Plant",
       "default": null,
       "minimum": 1,
-      "maximum": 52
+      "maximum": 52,
+      "enum_values": [
+        {
+          "name": "ELECTRICITY",
+          "value": "Electricity",
+          "numerical_input_value": 1
+        },
+        {
+          "name": "HEAT",
+          "value": "Direct-Use Heat",
+          "numerical_input_value": 2
+        },
+        {
+          "name": "COGENERATION_TOPPING_EXTRA_HEAT",
+          "value": "Cogeneration Topping Cycle, Heat sales considered as extra income",
+          "numerical_input_value": 31
+        },
+        {
+          "name": "COGENERATION_TOPPING_EXTRA_ELECTRICITY",
+          "value": "Cogeneration Topping Cycle, Electricity sales considered as extra income",
+          "numerical_input_value": 32
+        },
+        {
+          "name": "COGENERATION_BOTTOMING_EXTRA_HEAT",
+          "value": "Cogeneration Bottoming Cycle, Heat sales considered as extra income",
+          "numerical_input_value": 41
+        },
+        {
+          "name": "COGENERATION_BOTTOMING_EXTRA_ELECTRICITY",
+          "value": "Cogeneration Bottoming Cycle, Electricity sales considered as extra income",
+          "numerical_input_value": 42
+        },
+        {
+          "name": "COGENERATION_PARALLEL_EXTRA_HEAT",
+          "value": "Cogeneration Parallel Cycle, Heat sales considered as extra income",
+          "numerical_input_value": 51
+        },
+        {
+          "name": "COGENERATION_PARALLEL_EXTRA_ELECTRICITY",
+          "value": "Cogeneration Parallel Cycle, Electricity sales considered as extra income",
+          "numerical_input_value": 52
+        }
+      ]
     },
     "Power Plant Type": {
       "description": "Specify the type of physical plant. 1: Subcritical ORC, 2: Supercritical ORC, 3: Single-flash, 4: Double-flash, 5: Absorption Chiller, 6: Heat Pump 7: District Heating, 8: Reservoir Thermal Energy Storage",