Merge pull request NREL#327 from softwareengineerprogrammer/main

GeophiresInputParameters.as_text, minor miscellaneous updates [3.6.7]

Author: softwareengineerprogrammer

.bumpversion.cfg

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

README.rst

@@ -56,9 +56,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.6.6.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.6.7.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.6.6...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.6.7...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -482,7 +482,7 @@ A HIP-RA web interface is available at `gtp.scientificwebservices.com/hip-ra <ht
 Monte Carlo
 -----------
 
-`Monte Carlo User Guide <https://softwareengineerprogrammer.github.io/GEOPHIRES-X/Monte-Carlo-User-Guide.html>`__
+`Monte Carlo User Guide <https://nrel.github.io/GEOPHIRES-X/Monte-Carlo-User-Guide.html>`__
 
 A Monte Carlo web interface is available at `gtp.scientificwebservices.com/monte-carlo <https://gtp.scientificwebservices.com/monte-carlo>`__.
 

docs/conf.py

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

setup.py

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

src/geophires_x/WellBores.py

@@ -510,8 +510,10 @@ def ProdPressureDropAndPumpingPowerUsingIndexes(
         # Minimum production pump inlet pressure and minimum wellhead pressure
         if Trock_degC < 373.9:
             Pminimum_kPa = vapor_pressure_water_kPa(Trock_degC) + Pexcess_kPa
-        else: #above the critical water temperature, vapor no longer occurs and vapor pressure can no longer be calculated. A "dummy" vapor pressure can be assumed as the fluid phase no longer impacts the pump depth.
-            Pminimum_kPa = 100 #setting artificially to 1 bar = 100 kPa
+        else:
+            # Above the critical water temperature, vapor no longer occurs and vapor pressure can no longer be
+            # calculated. A "dummy" vapor pressure can be assumed as the fluid phase no longer impacts the pump depth.
+            Pminimum_kPa = 100 # 1 bar = 100 kPa
 
         if usebuiltinppwellheadcorrelation:
             Pprodwellhead = Pminimum_kPa  # production wellhead pressure [kPa]

src/geophires_x/__init__.py

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

src/geophires_x_client/geophires_input_parameters.py

@@ -69,6 +69,10 @@ def as_file_path(self):
     def get_output_file_path(self):
         return Path(tempfile.gettempdir(), f'geophires-result_{self._id}.out')
 
+    def as_text(self):
+        with open(self.as_file_path(), encoding='UTF-8') as f:
+            return f.read()
+
     def __hash__(self):
         """TODO make hashes for equivalent parameters equal"""
         return self._id

src/hip_ra_x/README.md

@@ -10,4 +10,4 @@ HIP-RA-X is the successor version to HIP-RA.
 
 ## Parameters
 
-[Parameters Reference](https://softwareengineerprogrammer.github.io/GEOPHIRES-X/hip_ra_x_parameters.html)
+[Parameters Reference](https://nrel.github.io/GEOPHIRES-X/hip_ra_x_parameters.html)