Documentation updates, ITC in client result, PR 310 follow-up items [v3.6.6]

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.6.4
+current_version = 3.6.6
 commit = True
 tag = True
 

.cookiecutterrc

@@ -54,7 +54,7 @@ default_context:
     sphinx_doctest: "no"
     sphinx_theme: "sphinx-py3doc-enhanced-theme"
     test_matrix_separate_coverage: "no"
-    version: 3.6.4
+    version: 3.6.6
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

CHANGELOG.rst

@@ -31,6 +31,7 @@ Affected users who do not want the new behavior can specify absolute output path
 `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.5.0>`__ | `diff <https://github.com/NREL/GEOPHIRES-X/compare/v3.4.0...v3.5.0>`__
 
 Milestone version for case studies, SHR temperatures, and other changes since 3.0.
+An overview is given in the July 2024 NREL GEOPHIRES Workshop `Version 3.5 Announcement session recording <https://youtu.be/Bi_l6y6_LQk>`__.
 
 3.5.3: SBT Reservoir Model (Slender Body Theory)
 

docs/conf.py

@@ -18,7 +18,7 @@
 year = '2024'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.6.4'
+version = release = '3.6.6'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

setup.py

@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name='geophires-x',
-    version='3.6.4',
+    version='3.6.6',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(

src/geophires_x/AGSEconomics.py

@@ -189,7 +189,7 @@ def Calculate(self, model: Model) -> None:
             # use the CLGS-Style economic calculations
             err = self.verify(model)
             if err > 0:
-                msg = 'Error: GEOPHIRES failed to Failed to validate CLGS input value. Exiting....'
+                msg = 'Error: GEOPHIRES failed to validate CLGS input value. Exiting...'
                 print(msg)
                 raise RuntimeError(msg)
 

src/geophires_x/AGSWellBores.py

@@ -977,7 +977,7 @@ def Calculate(self, model: Model) -> None:
             # do the CLGS-style calculation
             err = self.verify(model)
             if err > 0:
-                msg = 'Error: GEOPHIRES failed to Failed to validate CLGS input value. Exiting....'
+                msg = 'Error: GEOPHIRES failed to validate CLGS input value. Exiting...'
                 model.logger.fatal(msg)
                 print(msg)
 

src/geophires_x/SurfacePlantHeatPump.py

@@ -41,7 +41,7 @@ def __init__(self, model: Model):
 
         self.heat_pump_cop = self.ParameterDict[self.heat_pump_cop.Name] = floatParameter(
             "Heat Pump COP",
-            value=5,
+            DefaultValue=5,
             Min=1,
             Max=10,
             UnitType=Units.PERCENT,

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.6.4'
+__version__ = '3.6.6'

src/geophires_x_client/geophires_x_result.py

@@ -205,6 +205,7 @@ class GeophiresXResult:
                 'Field gathering system costs',
                 'Total surface equipment costs',
                 'Exploration costs',
+                'Investment Tax Credit',
                 'Total capital costs',
                 # AGS/CLGS
                 'Total CAPEX',

src/geophires_x_schema_generator/hip-ra-x-request.json

@@ -17,7 +17,7 @@
   ],
   "properties": {
     "Reservoir Temperature": {
-      "description": "Reservoir Temperature [150 degC]",
+      "description": "Reservoir Temperature",
       "type": "number",
       "units": "degC",
       "category": null,
@@ -26,7 +26,7 @@
       "maximum": 1000
     },
     "Rejection Temperature": {
-      "description": "Rejection Temperature [25 degC]",
+      "description": "Rejection Temperature",
       "type": "number",
       "units": "degC",
       "category": null,
@@ -35,7 +35,7 @@
       "maximum": 200
     },
     "Reservoir Porosity": {
-      "description": "Reservoir Porosity [18%]",
+      "description": "Reservoir Porosity",
       "type": "number",
       "units": "%",
       "category": null,
@@ -44,7 +44,7 @@
       "maximum": 100.0
     },
     "Reservoir Area": {
-      "description": "Reservoir Area [81 km2]",
+      "description": "Reservoir Area",
       "type": "number",
       "units": "km**2",
       "category": null,
@@ -53,7 +53,7 @@
       "maximum": 10000.0
     },
     "Reservoir Thickness": {
-      "description": "Reservoir Thickness [0.286 km]",
+      "description": "Reservoir Thickness",
       "type": "number",
       "units": "kilometer",
       "category": null,
@@ -62,7 +62,7 @@
       "maximum": 10000.0
     },
     "Reservoir Life Cycle": {
-      "description": "Reservoir Life Cycle [30 years]",
+      "description": "Reservoir Life Cycle",
       "type": "integer",
       "units": "yr",
       "category": null,
@@ -71,7 +71,7 @@
       "maximum": 100
     },
     "Rock Heat Capacity": {
-      "description": "Rock Heat Capacity [2.84E+12 kJ/km3C]",
+      "description": "Rock Heat Capacity",
       "type": "number",
       "units": "kJ/km**3C",
       "category": null,
@@ -80,7 +80,7 @@
       "maximum": 100000000000000.0
     },
     "Fluid Specific Heat Capacity": {
-      "description": "Specific Heat Capacity Of Water [4.18 kJ/kgC]",
+      "description": "Specific Heat Capacity Of Water",
       "type": "number",
       "units": "kJ/kgC",
       "category": null,
@@ -89,7 +89,7 @@
       "maximum": 10.0
     },
     "Density Of Reservoir Fluid": {
-      "description": "Density Of Water [1.0E+12 kg/km3]",
+      "description": "Density Of Water",
       "type": "number",
       "units": "kg/km**3",
       "category": null,
@@ -98,7 +98,7 @@
       "maximum": 10000000000000.0
     },
     "Density Of Reservoir Rock": {
-      "description": "Density Of Rock [2.55E+12 kg/km3]",
+      "description": "Density Of Rock",
       "type": "number",
       "units": "kg/km**3",
       "category": null,

src/hip_ra_x/hip_ra_x.py

@@ -120,7 +120,7 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
                 CurrentUnits=TemperatureUnit.CELSIUS,
                 Required=True,
                 ErrMessage='assume default reservoir temperature (150 degC)',
-                ToolTipText='Reservoir Temperature [150 degC]',
+                ToolTipText='Reservoir Temperature',
             )
         )
         self.rejection_temperature: Parameter = parameter_dict_entry(
@@ -134,7 +134,7 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
                 CurrentUnits=TemperatureUnit.CELSIUS,
                 Required=True,
                 ErrMessage='assume default rejection temperature (25 degC)',
-                ToolTipText='Rejection Temperature [25 degC]',
+                ToolTipText='Rejection Temperature',
             )
         )
         self.reservoir_porosity: Parameter = parameter_dict_entry(
@@ -148,7 +148,7 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
                 CurrentUnits=PercentUnit.PERCENT,
                 Required=True,
                 ErrMessage='assume default reservoir porosity (18%)',
-                ToolTipText='Reservoir Porosity [18%]',
+                ToolTipText='Reservoir Porosity',
             )
         )
         self.reservoir_area: Parameter = parameter_dict_entry(
@@ -162,7 +162,7 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
                 CurrentUnits=AreaUnit.KILOMETERS2,
                 Required=True,
                 ErrMessage='assume default reservoir area (81 km2)',
-                ToolTipText='Reservoir Area [81 km2]',
+                ToolTipText='Reservoir Area',
             )
         )
         self.reservoir_thickness: Parameter = parameter_dict_entry(
@@ -176,7 +176,7 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
                 CurrentUnits=LengthUnit.KILOMETERS,
                 Required=True,
                 ErrMessage='assume default reservoir thickness (0.286 km2)',
-                ToolTipText='Reservoir Thickness [0.286 km]',
+                ToolTipText='Reservoir Thickness',
             )
         )
         self.reservoir_life_cycle: Parameter = parameter_dict_entry(
@@ -189,7 +189,7 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
                 AllowableRange=list(range(1, 101, 1)),
                 Required=True,
                 ErrMessage='assume default Reservoir Life Cycle (25 years)',
-                ToolTipText='Reservoir Life Cycle [30 years]',
+                ToolTipText='Reservoir Life Cycle',
             )
         )
 
@@ -205,7 +205,7 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
                 CurrentUnits=HeatCapacityUnit.KJPERKM3C,
                 Required=True,
                 ErrMessage='assume default Rock Heat Capacity (2.84E+12 kJ/km3C)',
-                ToolTipText='Rock Heat Capacity [2.84E+12 kJ/km3C]',
+                ToolTipText='Rock Heat Capacity',
             )
         )
         self.fluid_heat_capacity: Parameter = parameter_dict_entry(
@@ -219,7 +219,7 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
                 CurrentUnits=HeatCapacityUnit.kJPERKGC,
                 Required=True,
                 ErrMessage='calculate a value based on the water temperature',
-                ToolTipText='Specific Heat Capacity Of Water [4.18 kJ/kgC]',
+                ToolTipText='Specific Heat Capacity Of Water',
             )
         )
         self.fluid_density: Parameter = parameter_dict_entry(
@@ -233,7 +233,7 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
                 CurrentUnits=DensityUnit.KGPERKILOMETERS3,
                 Required=True,
                 ErrMessage='calculate a value based on the water temperature',
-                ToolTipText='Density Of Water [1.0E+12 kg/km3]',
+                ToolTipText='Density Of Water',
             )
         )
         self.rock_density: Parameter = parameter_dict_entry(
@@ -247,7 +247,7 @@ def parameter_dict_entry(param: Parameter) -> Parameter:
                 CurrentUnits=DensityUnit.KGPERKILOMETERS3,
                 Required=True,
                 ErrMessage='assume default Density Of Rock (2.55E+12 kg/km3)',
-                ToolTipText='Density Of Rock [2.55E+12 kg/km3]',
+                ToolTipText='Density Of Rock',
             )
         )
         self.rock_recoverable_heat: Parameter = parameter_dict_entry(