Merge pull request NREL#154 from softwareengineerprogrammer/main

MC CLI enhancement, miscellaneous updates

Author: softwareengineerprogrammer

.bumpversion.cfg

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

.github/workflows/github-actions.yml

@@ -101,10 +101,10 @@ jobs:
 #            os: 'macos-latest'
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python }}
         architecture: ${{ matrix.python_arch }}
@@ -131,10 +131,10 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: '3.11'
         architecture: 'x64'
@@ -162,8 +162,8 @@ jobs:
         done
 
     - name: upload artifact
-      uses: actions/upload-pages-artifact@v2
+      uses: actions/upload-pages-artifact@v3
 
     - name: deploy to GitHub Pages
       id: deployment
-      uses: actions/deploy-pages@v2
+      uses: actions/deploy-pages@v4

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

ci/templates/.github/workflows/github-actions.yml

@@ -43,10 +43,10 @@ jobs:
 {% endfor %}
 {% endfor %}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: {{ '${{ matrix.python }}' }}
         architecture: {{ '${{ matrix.python_arch }}' }}

docs/Monte-Carlo-User-Guide.md

@@ -109,6 +109,12 @@ bin edges: [-43.34   -43.2258 -43.1116 -42.9974 -42.8832 -42.769  -42.6548 -42.5
 
 ```
 
+You may also run from the command line:
+
+```
+python -mgeophires_monte_carlo GEOPHIRESv3.py GEOPHIRES-example1.txt MC_GEOPHIRES_Settings_file.txt MC_GEOPHIRES_Result.txt
+```
+
 ## Documentation
 
 See [module documentation](reference/geophires_monte_carlo.html)

docs/conf.py

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

setup.py

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

src/geophires_monte_carlo/MC_GeoPHIRES3.py

@@ -240,11 +240,6 @@ def main(command_line_args=None):
     # keep track of execution time
     tic = time.time()
 
-    # set the starting directory to be the directory that this file is in
-    working_dir = os.path.dirname(os.path.abspath(__file__))
-    os.chdir(working_dir)
-    working_dir = working_dir + os.sep
-
     # get the values off the command line
     parser = argparse.ArgumentParser()
     parser.add_argument('Code_File', help='Code File')
@@ -268,7 +263,11 @@ def main(command_line_args=None):
     inputs = []
     outputs = []
     iterations = 0
-    output_file = args.MC_OUTPUT_FILE if 'MC_OUTPUT_FILE' in args and args.MC_OUTPUT_FILE is not None else ''
+    output_file = (
+        args.MC_OUTPUT_FILE
+        if 'MC_OUTPUT_FILE' in args and args.MC_OUTPUT_FILE is not None
+        else str(Path(Path(args.Input_file).parent, 'MC_Result.txt').absolute())
+    )
     python_path = 'python'
 
     for line in flist:
@@ -312,6 +311,11 @@ def main(command_line_args=None):
     with open(output_file, 'w') as f:
         f.write(s)
 
+    # set the starting directory to be the directory that this file is in
+    working_dir = os.path.dirname(os.path.abspath(__file__))
+    os.chdir(working_dir)
+    working_dir = working_dir + os.sep
+
     # build the args list
     pass_list = [inputs, outputs, args, output_file, working_dir, python_path]  # this list never changes
 

src/geophires_monte_carlo/__main__.py

@@ -0,0 +1,29 @@
+import os
+import sys
+from pathlib import Path
+
+from geophires_monte_carlo import MC_GeoPHIRES3
+from geophires_monte_carlo import common
+
+if __name__ == '__main__':
+    log = common._get_logger()
+    stash_cwd = Path.cwd()
+
+    try:
+        command_line_args = []
+        for i in range(len(sys.argv[1:])):
+            arg = sys.argv[i + 1]
+            if Path(arg).exists():
+                arg = str(Path(arg).absolute())
+                log.info(f'Converted arg to absolute path: {arg}')
+
+            command_line_args.append(arg)
+
+        MC_GeoPHIRES3.main(command_line_args=command_line_args)
+    except Exception as e:
+        raise RuntimeError(f'Monte Carlo encountered an exception: {e!s}') from e
+    except SystemExit:
+        raise RuntimeError('Monte Carlo exited without giving a reason') from None
+    finally:
+        # Undo MC internal global settings changes
+        os.chdir(stash_cwd)