Merge pull request NREL#292 from softwareengineerprogrammer/main

Project Cape workshop example; miscellaneous fixes & improvements

Author: softwareengineerprogrammer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.5.3
+current_version = 3.5.4
 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.5.3
+    version: 3.5.4
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

README.rst

@@ -51,9 +51,9 @@ Free software: `MIT license <LICENSE>`__
     :alt: Supported implementations
     :target: https://pypi.org/project/geophires-x
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.5.3.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.5.4.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.5.3...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.5.4...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X

docs/conf.py

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

setup.py

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

src/geophires_x/SurfacePlantDistrictHeating.py

@@ -365,12 +365,12 @@ def calculate_dh_demand(self, households, census_division, constant_demand, temp
             heat_intensity = 1.845
             water_intensity = 12.41
 
-            demand = np.empty(0) # create an empty np array for daily demand
-            for day in daily_HDD:
-                # MWh/day
-                demand = np.append(demand, households * (heat_intensity * day + water_intensity) / 1000 + constant_demand * 24)
+        demand = np.empty(0) # create an empty np array for daily demand
+        for day in daily_HDD:
+            # MWh/day
+            demand = np.append(demand, households * (heat_intensity * day + water_intensity) / 1000 + constant_demand * 24)
 
-            return demand
+        return demand
 
     def calc_HDD(self, hourly_temp) -> np.array:
         """

src/geophires_x/TOUGH2Reservoir.py

@@ -1,17 +1,16 @@
 import sys
-import os
 import numpy as np
 from .Parameter import floatParameter, strParameter
 from .Units import *
 import geophires_x.Model as Model
-from .Reservoir import Reservoir
+from geophires_x.Reservoir import Reservoir
 
 
 class TOUGH2Reservoir(Reservoir):
     """
     This class models the TOUGH2 Reservoir.
     """
-    def __init__(self, model:Model):
+    def __init__(self, model: Model):
         """
         The __init__ function is called automatically when a class is instantiated.
         It initializes the attributes of an object, and sets default values for certain arguments that can be overridden
@@ -33,6 +32,11 @@ def __init__(self, model:Model):
         # or used for Output
         # This also includes all Parameters that are calculated and then published using the Printouts function.
         # specific to this stype of reservoir
+        self.tough2_executable_path = self.ParameterDict[self.tough2_executable_path.Name] = strParameter(
+            "TOUGH2 Executable Path",
+            DefaultValue='xt2_eos1.exe',
+            UnitType=Units.NONE,
+        )
         self.tough2modelfilename = self.ParameterDict[self.tough2modelfilename.Name] = strParameter(
             "TOUGH2 Model/File Name",
             value='Doublet',
@@ -126,7 +130,7 @@ def Calculate(self, model:Model):
 
         # GEOPHIRES assumes TOUGH2 executable and input file are in same directory as GEOPHIRESv3.py
         # create tough2 input file
-        path_to_exe = str('xt2_eos1.exe')
+        path_to_exe = str(self.tough2_executable_path.value)
         if not os.path.exists(os.path.join(os.getcwd(), path_to_exe)):
             model.logger.critical('TOUGH2 executable file does not exist in current working directory. \
             GEOPHIRES will abort simulation.')

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.5.3'
+__version__ = '3.5.4'

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

@@ -21,7 +21,7 @@
       "type": "number",
       "units": "degC",
       "category": null,
-      "default": 0.0,
+      "default": 150.0,
       "minimum": 50,
       "maximum": 1000
     },
@@ -30,7 +30,7 @@
       "type": "number",
       "units": "degC",
       "category": null,
-      "default": 0.0,
+      "default": 25.0,
       "minimum": 0.1,
       "maximum": 200
     },
@@ -39,7 +39,7 @@
       "type": "number",
       "units": "%",
       "category": null,
-      "default": 0.0,
+      "default": 18.0,
       "minimum": 0.0,
       "maximum": 100.0
     },
@@ -48,7 +48,7 @@
       "type": "number",
       "units": "km**2",
       "category": null,
-      "default": 0.0,
+      "default": 81.0,
       "minimum": 0.0,
       "maximum": 10000.0
     },
@@ -57,7 +57,7 @@
       "type": "number",
       "units": "kilometer",
       "category": null,
-      "default": 0.0,
+      "default": 0.286,
       "minimum": 0.0,
       "maximum": 10000.0
     },
@@ -66,7 +66,7 @@
       "type": "integer",
       "units": "yr",
       "category": null,
-      "default": null,
+      "default": 30,
       "minimum": 1,
       "maximum": 100
     },
@@ -75,7 +75,7 @@
       "type": "number",
       "units": "kJ/km**3C",
       "category": null,
-      "default": 0.0,
+      "default": 2840000000000.0,
       "minimum": 0.0,
       "maximum": 100000000000000.0
     },
@@ -84,7 +84,7 @@
       "type": "number",
       "units": "kJ/kgC",
       "category": null,
-      "default": 0.0,
+      "default": -1.0,
       "minimum": 3.0,
       "maximum": 10.0
     },
@@ -93,7 +93,7 @@
       "type": "number",
       "units": "kg/km**3",
       "category": null,
-      "default": 0.0,
+      "default": -1.0,
       "minimum": 100000000000.0,
       "maximum": 10000000000000.0
     },
@@ -102,7 +102,7 @@
       "type": "number",
       "units": "kg/km**3",
       "category": null,
-      "default": 0.0,
+      "default": 2550000000000.0,
       "minimum": 100000000000.0,
       "maximum": 10000000000000.0
     },
@@ -111,7 +111,7 @@
       "type": "number",
       "units": "",
       "category": null,
-      "default": 0.0,
+      "default": -1.0,
       "minimum": 0.0,
       "maximum": 1.0
     },
@@ -120,7 +120,7 @@
       "type": "number",
       "units": "",
       "category": null,
-      "default": 0.0,
+      "default": -1.0,
       "minimum": 0.0,
       "maximum": 1.0
     },
@@ -129,7 +129,7 @@
       "type": "number",
       "units": "",
       "category": null,
-      "default": 0.0,
+      "default": 0.5,
       "minimum": 0.0,
       "maximum": 1.0
     },
@@ -138,7 +138,7 @@
       "type": "number",
       "units": "kilometer",
       "category": null,
-      "default": 0.0,
+      "default": -1.0,
       "minimum": 0.001,
       "maximum": 15.0
     },
@@ -147,7 +147,7 @@
       "type": "number",
       "units": "mPa",
       "category": null,
-      "default": 0.0,
+      "default": -1.0,
       "minimum": 0.0,
       "maximum": 10000.0
     },
@@ -156,7 +156,7 @@
       "type": "number",
       "units": "",
       "category": null,
-      "default": 0.0,
+      "default": 0.75,
       "minimum": 0.0,
       "maximum": 1.0
     },
@@ -165,7 +165,7 @@
       "type": "string",
       "units": null,
       "category": null,
-      "default": null,
+      "default": "HIP.html",
       "minimum": null,
       "maximum": null
     }