Merge pull request NREL#215 from softwareengineerprogrammer/main

Miscellaneous fixes & improvements [v3.4.29]

Author: softwareengineerprogrammer

.bumpversion.cfg

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

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
 ------------

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)

References/fervo_energy_white_paper.pdf

@@ -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']

docs/conf.py

@@ -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:
 

docs/reference/geophires_x.rst

@@ -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(

setup.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")

src/geophires_x/AGSOutputs.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)