Merge pull request NREL#215 from softwareengineerprogrammer/main

Miscellaneous fixes & improvements [v3.4.29]
aimiktena · May 14, 2024 · 227a5e9 · 227a5e9
2 parents 703c967 + d72d04f
commit 227a5e9
Show file tree

Hide file tree

Showing 61 changed files with 259 additions and 69 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.4.28
+current_version = 3.4.29
 commit = True
 tag = True
 

diff --git a/.cookiecutterrc b/.cookiecutterrc
@@ -54,7 +54,7 @@ default_context:
     sphinx_doctest: "no"
     sphinx_theme: "sphinx-py3doc-enhanced-theme"
     test_matrix_separate_coverage: "no"
-    version: 3.4.28
+    version: 3.4.29
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

diff --git a/README.rst b/README.rst
@@ -47,9 +47,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.4.28.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.4.29.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.28...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.29...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -65,7 +65,9 @@ Getting Started
 Web Interface
 -------------
 
-A web interface is available at `bit.ly/GEOPHIRES <https://bit.ly/GEOPHIRES>`__
+A web interface is available at `scientificwebservices.com/tools/geophires <https://scientificwebservices.com/tools/geophires>`__.
+
+The short URL `bit.ly/GEOPHIRES <https://bit.ly/GEOPHIRES>`__ redirects to the same location.
 
 Installation
 ------------

diff --git a/References/fervo_energy_white_paper.md b/References/fervo_energy_white_paper.md
@@ -0,0 +1 @@
+[fervo_energy_white_paper.pdf](https://github.com/NREL/GEOPHIRES-X/blob/703c967b0b1fe9f6d619b1e786686ba07fb0fe59/References/fervo_energy_white_paper.pdf)
diff --git a/References/fervo_energy_white_paper.pdf b/References/fervo_energy_white_paper.pdf
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,7 @@
 year = '2023'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.4.28'
+version = release = '3.4.29'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

diff --git a/docs/reference/geophires_x.rst b/docs/reference/geophires_x.rst
@@ -11,6 +11,15 @@ geophires_x
 .. automodule:: geophires_x.TDPReservoir
     :members:
 
+.. automodule:: geophires_x.LHSReservoir
+    :members:
+
+.. automodule:: geophires_x.MPFReservoir
+    :members:
+
+.. automodule:: geophires_x.SFReservoir
+    :members:
+
 .. automodule:: geophires_x.CylindricalReservoir
     :members:
 

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

diff --git a/src/geophires_x/AGSOutputs.py b/src/geophires_x/AGSOutputs.py
@@ -83,7 +83,6 @@ def PrintOutputs(self, model: Model):
                     f.write("Simulation Metadata\n")
                     f.write("----------------------\n")
                     f.write(f' GEOPHIRES Version: {geophires_x.__version__}\n')
-                    f.write(" GEOPHIRES Build Date: 2022-06-30\n")
                     f.write(" Simulation Date: " + datetime.datetime.now().strftime("%Y-%m-%d\n"))
                     f.write(" Simulation Time:  " + datetime.datetime.now().strftime("%H:%M\n"))
                     f.write(" Calculation Time: " + "{0:10.3f}".format((time.time() - model.tic)) + " sec\n")

diff --git a/src/geophires_x/AGSWellBores.py b/src/geophires_x/AGSWellBores.py
@@ -578,21 +578,21 @@ def read_parameters(self, model: Model) -> None:
 
         # handle error checking and special cases:
         if model.reserv.numseg.value > 1:
-            msg = "Warning: CLGS model can only handle a single layer gradient segment. Number of Segments set to 1, \
-                Gradient set to Gradient[0], and Depth set to Reservoir Depth."
+            msg = ('Warning: CLGS model can only handle a single layer gradient segment. '
+                   'Number of Segments set to 1, Gradient set to Gradient[0], and Depth set to Reservoir Depth.')
             print(msg)
             model.logger.warning(msg)
             model.reserv.numseg.value = 1
 
         if self.ninj.value > 0:
-            msg = "Warning: CLGS model considers the only the production wellbore parameters. Anything related to the \
-                injection wellbore is ignored."
+            msg = ('Warning: CLGS model considers the only the production wellbore parameters. '
+                   'Anything related to the injection wellbore is ignored.')
             print(msg)
             model.logger.warning(msg)
 
         if self.nprod.value != 1:
-            msg = "Warning: CLGS model considers the only a single production wellbore (coaxial or uloop). \
-                Number of production wellboreset set 1."
+            msg = ('Warning: CLGS model considers the only a single production wellbore (coaxial or uloop). '
+                   'Number of production wellboreset set 1.')
             print(msg)
             model.logger.warning(msg)
 

diff --git a/src/geophires_x/Outputs.py b/src/geophires_x/Outputs.py
@@ -778,7 +778,6 @@ def PrintOutputs(self, model: Model):
         pumping_power_results = []
 
         simulation_metadata.append(OutputTableItem('GEOPHIRES Version', geophires_x.__version__))
-        simulation_metadata.append(OutputTableItem('GEOPHIRES Build Date', '2024-03-05'))
         simulation_metadata.append(OutputTableItem('Simulation Date', datetime.datetime.now().strftime('%Y-%m-%d')))
         simulation_metadata.append(OutputTableItem('Simulation Time', datetime.datetime.now().strftime('%H:%M')))
         simulation_metadata.append(OutputTableItem('Calculation Time', '{0:10.3f}'.format((time.time() - model.tic)) + ' sec'))
@@ -1554,7 +1553,6 @@ def PrintOutputs(self, model: Model):
                 f.write('Simulation Metadata\n')
                 f.write('----------------------\n')
                 f.write(f' GEOPHIRES Version: {geophires_x.__version__}\n')
-                f.write(' GEOPHIRES Build Date: 2024-03-05\n') # FIXME TODO https://github.com/NREL/GEOPHIRES-X/issues/139
                 f.write(' Simulation Date: '+ datetime.datetime.now().strftime('%Y-%m-%d\n'))
                 f.write(' Simulation Time:  '+ datetime.datetime.now().strftime('%H:%M\n'))
                 f.write(' Calculation Time: '+'{0:10.3f}'.format((time.time()-model.tic)) + ' sec\n')

diff --git a/src/geophires_x/SFReservoir.py b/src/geophires_x/SFReservoir.py
@@ -49,7 +49,7 @@ def __init__(self, model:Model):
         model.logger.info("Complete " + str(__class__) + ": " + sys._getframe().f_code.co_name)
 
     def __str__(self):
-        return "LHSReservoir"
+        return 'SFReservoir'
 
     def read_parameters(self, model: Model) -> None:
         """

diff --git a/src/geophires_x/SUTRAOutputs.py b/src/geophires_x/SUTRAOutputs.py
@@ -117,7 +117,6 @@ def PrintOutputs(self, model: Model):
                 f.write("Simulation Metadata\n")
                 f.write("----------------------\n")
                 f.write(f' GEOPHIRES Version: {geophires_x.__version__}\n')
-                f.write(" GEOPHIRES Build Date: 2023-11-06\n")
                 f.write(" Simulation Date: "+ datetime.datetime.now().strftime("%Y-%m-%d\n"))
                 f.write(" Simulation Time:  "+ datetime.datetime.now().strftime("%H:%M\n"))
                 f.write(" Calculation Time: "+"{0:10.3f}".format((time.time()-model.tic)) + " sec\n")

diff --git a/src/geophires_x/__init__.py b/src/geophires_x/__init__.py
@@ -1 +1 @@
-__version__ = '3.4.28'
+__version__ = '3.4.29'
diff --git a/src/geophires_x_client/geophires_input_parameters.py b/src/geophires_x_client/geophires_input_parameters.py
@@ -1,4 +1,5 @@
 import tempfile
+import uuid
 from enum import Enum
 from pathlib import Path
 from types import MappingProxyType
@@ -34,25 +35,33 @@ class PowerPlantType(Enum):
 
 
 class GeophiresInputParameters:
+
     def __init__(self, params: Optional[MappingProxyType] = None, from_file_path: Optional[Path] = None):
-        assert (params is None) ^ (from_file_path is None), 'Only one of params or from_file_path may be provided'
+        """
+        Note that params will override any duplicate entries in from_file_path
+        """
+
+        assert (params is not None) or (from_file_path is not None), 'One of params or from_file_path must be provided'
 
         if params is not None:
             self._params = dict(params)
-            self._id = abs(hash(frozenset(self._params.items())))
+            self._file_path = Path(tempfile.gettempdir(), f'geophires-input-params_{uuid.uuid4()!s}.txt')
+
+            if from_file_path is not None:
+                with open(from_file_path, encoding='UTF-8') as base_file:
+                    with open(self._file_path, 'a', encoding='UTF-8') as f:
+                        f.writelines(base_file.readlines())
+        else:
+            self._file_path = from_file_path
+
+        if params is not None:
             # TODO validate params - i.e. that all names are accepted by simulation, values don't exceed max allowed,
             #  etc.
 
-            tmp_file_path = Path(tempfile.gettempdir(), f'geophires-input-params_{self._id}.txt')
-            f = Path.open(tmp_file_path, 'w')
+            with open(self._file_path, 'a', encoding='UTF-8') as f:
+                f.writelines([', '.join([str(p) for p in param_item]) + '\n' for param_item in self._params.items()])
 
-            f.writelines([','.join([str(p) for p in param_item]) + '\n' for param_item in self._params.items()])
-            f.close()
-            self._file_path = tmp_file_path
-
-        if from_file_path is not None:
-            self._file_path = from_file_path
-            self._id = hash(from_file_path)
+        self._id = hash(self._file_path)
 
     def as_file_path(self):
         return self._file_path
@@ -61,4 +70,5 @@ def get_output_file_path(self):
         return Path(tempfile.gettempdir(), f'geophires-result_{self._id}.out')
 
     def __hash__(self):
+        """TODO make hashes for equivalent parameters equal"""
         return self._id
diff --git a/src/geophires_x_schema_generator/__init__.py b/src/geophires_x_schema_generator/__init__.py
@@ -8,6 +8,9 @@
 # ruff: noqa: I001
 from geophires_x.Model import Model
 
+from geophires_x.SFReservoir import SFReservoir
+from geophires_x.LHSReservoir import LHSReservoir
+from geophires_x.MPFReservoir import MPFReservoir
 from geophires_x.AGSEconomics import AGSEconomics
 from geophires_x.AGSWellBores import AGSWellBores
 from geophires_x.CylindricalReservoir import CylindricalReservoir
@@ -20,6 +23,7 @@
 from geophires_x.SUTRAEconomics import SUTRAEconomics
 from geophires_x.SUTRAReservoir import SUTRAReservoir
 from geophires_x.SUTRAWellBores import SUTRAWellBores
+from geophires_x.TDPReservoir import TDPReservoir
 
 
 class GeophiresXSchemaGenerator:
@@ -49,6 +53,10 @@ def _with_cat(p: Parameter, cat: str):
 
         parameter_sources = [
             (dummy_model.reserv, 'Reservoir'),
+            (TDPReservoir(dummy_model), 'Reservoir'),
+            (LHSReservoir(dummy_model), 'Reservoir'),
+            (MPFReservoir(dummy_model), 'Reservoir'),
+            (SFReservoir(dummy_model), 'Reservoir'),
             (CylindricalReservoir(dummy_model), 'Reservoir'),
             (SUTRAReservoir(dummy_model), 'Reservoir'),
             (dummy_model.wellbores, 'Well Bores'),

diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.4
- GEOPHIRES Build Date: 2022-06-30
  Simulation Date: 2024-03-02
  Simulation Time:  14:11
  Calculation Time:      1.178 sec

diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.4
- GEOPHIRES Build Date: 2022-06-30
  Simulation Date: 2024-03-02
  Simulation Time:  14:12
  Calculation Time:      1.004 sec

diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.4
- GEOPHIRES Build Date: 2022-06-30
  Simulation Date: 2024-03-02
  Simulation Time:  14:13
  Calculation Time:      1.085 sec

diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.4
- GEOPHIRES Build Date: 2022-06-30
  Simulation Date: 2024-03-02
  Simulation Time:  14:13
  Calculation Time:      1.093 sec

diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.4
- GEOPHIRES Build Date: 2022-06-30
  Simulation Date: 2024-03-02
  Simulation Time:  14:14
  Calculation Time:      1.073 sec

diff --git a/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out b/tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.4
- GEOPHIRES Build Date: 2022-06-30
  Simulation Date: 2024-03-02
  Simulation Time:  14:14
  Calculation Time:      1.026 sec

diff --git a/tests/examples/FIXME_example1_outputunits.out b/tests/examples/FIXME_example1_outputunits.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.0
- GEOPHIRES Build Date: 2022-06-30
  Simulation Date: 2023-09-29
  Simulation Time:  21:03
  Calculation Time:     13.691 sec

diff --git a/tests/examples/Fervo_Norbeck_Latimer_2024.out b/tests/examples/Fervo_Norbeck_Latimer_2024.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.28
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-05-08
  Simulation Time:  09:44
  Calculation Time:      2.671 sec

diff --git a/tests/examples/S-DAC-GT.out b/tests/examples/S-DAC-GT.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
 GEOPHIRES Version: 3.4.22
-GEOPHIRES Build Date: 2024-03-05
 Simulation Date: 2024-03-20
 Simulation Time: 17:51
 Calculation Time:      0.433 sec

diff --git a/tests/examples/SUTRAExample1.out b/tests/examples/SUTRAExample1.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.0
- GEOPHIRES Build Date: 2023-11-06
  Simulation Date: 2023-11-06
  Simulation Time:  17:26
  Calculation Time:      1.566 sec

diff --git a/tests/examples/Wanju_Yuan_Closed-Loop_Geothermal_Energy_Recovery.out b/tests/examples/Wanju_Yuan_Closed-Loop_Geothermal_Energy_Recovery.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.25
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-04-30
  Simulation Time:  08:43
  Calculation Time:      1.706 sec

diff --git a/tests/examples/example1.out b/tests/examples/example1.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.25
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-04-16
  Simulation Time:  10:32
  Calculation Time:      0.962 sec

diff --git a/tests/examples/example10_HP.out b/tests/examples/example10_HP.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.25
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-04-16
  Simulation Time:  10:37
  Calculation Time:      0.275 sec

diff --git a/tests/examples/example11_AC.out b/tests/examples/example11_AC.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.25
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-04-16
  Simulation Time:  10:36
  Calculation Time:      0.274 sec

diff --git a/tests/examples/example12_DH.out b/tests/examples/example12_DH.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.25
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-04-16
  Simulation Time:  10:46
  Calculation Time:      0.257 sec

diff --git a/tests/examples/example13.out b/tests/examples/example13.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.25
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-04-16
  Simulation Time:  10:29
  Calculation Time:      0.088 sec

diff --git a/tests/examples/example1_addons.out b/tests/examples/example1_addons.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.25
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-04-16
  Simulation Time:  10:26
  Calculation Time:      0.937 sec

diff --git a/tests/examples/example2.out b/tests/examples/example2.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.25
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-04-16
  Simulation Time:  10:33
  Calculation Time:      0.365 sec

diff --git a/tests/examples/example3.out b/tests/examples/example3.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.25
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-04-16
  Simulation Time:  10:34
  Calculation Time:      0.333 sec

diff --git a/tests/examples/example4.out b/tests/examples/example4.out
@@ -5,7 +5,6 @@
 Simulation Metadata
 ----------------------
  GEOPHIRES Version: 3.4.25
- GEOPHIRES Build Date: 2024-03-05
  Simulation Date: 2024-04-16
  Simulation Time:  10:30
  Calculation Time:      0.127 sec
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		[fervo_energy_white_paper.pdf](https://github.com/NREL/GEOPHIRES-X/blob/703c967b0b1fe9f6d619b1e786686ba07fb0fe59/References/fervo_energy_white_paper.pdf)