Merge pull request NREL#397 from softwareengineerprogrammer/main

Fix client cwd stashing regression [v3.9.31]

Author: softwareengineerprogrammer

.bumpversion.cfg

@@ -1,21 +1,7 @@
 [bumpversion]
-current_version = 3.9.29
+current_version = 3.9.31
 commit = True
 tag = True
-parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<prerelease_label>[a-z]+)\.(?P<prerelease>\d+))?
-serialize =
-	{major}.{minor}.{patch}-{prerelease_label}.{prerelease}
-	{major}.{minor}.{patch}
-
-[bumpversion:part:prerelease]
-first_value = 0
-
-[bumpversion:part:prerelease_label]
-optional_value = rc
-values =
-	alpha
-	beta
-	rc
 
 [bumpversion:file:setup.py]
 search = version='{current_version}'
@@ -30,10 +16,8 @@ search = /v{current_version}...main
 replace = /v{new_version}...main
 
 [bumpversion:file:docs/conf.py]
-search = version = '{current_version}'
-	release = '{current_version}'
-replace = version = '{new_version}'
-	release = '{new_version}'
+search = version = release = '{current_version}'
+replace = version = release = '{new_version}'
 
 [bumpversion:file:src/geophires_x/__init__.py]
 search = __version__ = '{current_version}'
@@ -42,6 +26,3 @@ replace = __version__ = '{new_version}'
 [bumpversion:file:.cookiecutterrc]
 search = version: {current_version}
 replace = version: {new_version}
-
-[bumpversion:part:release]
-# Enables the 'bumpversion release' command to drop pre-release suffixes.

.cookiecutterrc

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

CONTRIBUTING.rst

@@ -278,16 +278,9 @@ Then push both commits and tags to your fork:
     Writing objects: 100% (1/1), 205 bytes | 205.00 KiB/s, done.
     Total 1 (delta 0), reused 0 (delta 0), pack-reused 0
     To github.com:softwareengineerprogrammer/python-geophires-x-nrel.git
-     * [new tag]         v3.2.3-alpha.0 -> v3.2.3-alpha.0
+     * [new tag]         v3.2.3 -> v3.2.3
 
-Once the alpha version builds successfully in GitHubActions and you're ready to release it as v3.2.3:
-
-.. code-block::
-
-    (venv) ➜  python-geophires-x git:(main) bumpversion release
-    (venv) ➜  python-geophires-x git:(main) git push && git push fork --tags
-
-Once a version bump is merged into the main repository with a Pull Request, tags must be manually pushed (GitHub `doesn't include tags in PRs <https://stackoverflow.com/questions/12278660/adding-tags-to-a-pull-request>`__):
+Once a version bump is merged into the main repository with a Pull Request, tag must be manually pushed (GitHub `doesn't include tags in PRs <https://stackoverflow.com/questions/12278660/adding-tags-to-a-pull-request>`__):
 
 .. code-block::
 

README.rst

@@ -58,9 +58,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.9.29.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.9.31.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.29...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.31...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X

docs/conf.py

@@ -18,8 +18,7 @@
 year = '2025'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = '3.9.29'
-release = '3.9.29'
+version = release = '3.9.31'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

setup.py

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

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.9.29'
+__version__ = '3.9.31'

src/geophires_x_client/__init__.py

@@ -1,8 +1,10 @@
 import atexit
+import os
 import sys
 import threading
 from multiprocessing import Manager
 from multiprocessing import current_process
+from pathlib import Path
 
 # noinspection PyPep8Naming
 from geophires_x import GEOPHIRESv3 as geophires
@@ -110,6 +112,7 @@ def get_geophires_result(self, input_params: GeophiresInputParameters) -> Geophi
 
     def _run_simulation(self, input_params: GeophiresInputParameters) -> GeophiresXResult:
         """Helper method to encapsulate the actual GEOPHIRES run."""
+        stash_cwd = Path.cwd()
         stash_sys_argv = sys.argv
         sys.argv = ['', input_params.as_file_path(), input_params.get_output_file_path()]
 
@@ -121,6 +124,7 @@ def _run_simulation(self, input_params: GeophiresInputParameters) -> GeophiresXR
             raise RuntimeError('GEOPHIRES exited without giving a reason') from None
         finally:
             sys.argv = stash_sys_argv
+            os.chdir(stash_cwd)
 
         self._logger.info(f'GEOPHIRES-X output file: {input_params.get_output_file_path()}')
         result = GeophiresXResult(input_params.get_output_file_path())

tests/test_geophires_x_client.py

@@ -14,7 +14,7 @@
 class GeophiresXClientTestCase(BaseTestCase):
     """
     Note that these are tests of the geophires_x_client package only and not of the core geophires_x package.
-    If a test calls geophires_x_client.GeophiresXClient.get_geophires_result then it belongs in
+    If a test calls geophires_x_client.GeophiresXClient.get_geophires_result then it generally belongs in
     test_geophires_x.GeophiresXTestCase.
     """
 
@@ -615,3 +615,19 @@ def test_parse_sam_cash_flow_profile(self):
         cash_flow = result.result['SAM CASH FLOW PROFILE']
         self.assertIsNotNone(cash_flow)
         self.assertListEqual([''] + [f'Year {y}' for y in range(21)], cash_flow[0])
+
+    def test_stash_cwd(self):
+        start_cwd = Path.cwd()
+        GeophiresXClient().get_geophires_result(
+            GeophiresInputParameters(
+                {
+                    'End-Use Option': EndUseOption.DIRECT_USE_HEAT.value,
+                    'Reservoir Model': 1,
+                    'Time steps per year': 1,
+                    'Reservoir Depth': 3,
+                    'Gradient 1': 50,
+                }
+            )
+        )
+
+        self.assertEqual(start_cwd, Path.cwd())