CLI; documentation updates; parameter range exception handling

.bumpversion.cfg

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

CHANGELOG.rst

@@ -2,11 +2,26 @@
 Changelog
 =========
 
-GEOPHIRES-X (3.0) (2023)
+GEOPHIRES-X (2023)
 ------------------------
 
+3.2
+^^^
+Bug fixes
+
+`diff <https://github.com/NREL/python-geophires-x/compare/v3.1.0...v3.2.0>`__
+
+3.1
+^^^
+Internal changes to support unit testing
+
+`diff <https://github.com/NREL/python-geophires-x/compare/v3.0.0...v3.1.0>`__
+
+
+3.0
+^^^
+- New repository: https://github.com/NREL/python-geophires-x
 - Ported from `malcolm-dsider/GEOPHIRES-X <https://github.com/malcolm-dsider/GEOPHIRES-X>`_ and `softwareengineerprogrammer/python-geophires-x <https://github.com/softwareengineerprogrammer/python-geophires-x>`_ using `ionelmc/cookiecutter-pylibrary <https://github.com/ionelmc/cookiecutter-pylibrary/>`_.
-- https://github.com/NREL/python-geophires-x
 - Releases now marked with tags/version metadata generated with ``bumpversion``
 
 2.0 (2019)

CONTRIBUTING.rst

@@ -163,10 +163,10 @@ To run all the test environments in *parallel*::
     tox -p auto
 
 
-Test Configuration in VS Code
------------------------------
+VS Code
+-------
 
-``.vscode/settings.json`` (macos):
+``.vscode/settings.json`` (macOS):
 
 .. code-block::
 
@@ -190,7 +190,7 @@ Test Configuration in VS Code
    }
 
 
-``.vscode/settings.json`` (windows):
+``.vscode/settings.json`` (Windows):
 
 .. code-block::
 
@@ -221,7 +221,9 @@ Test Configuration in VS Code
         "python.languageServer": "Pylance",
    }
 
-Example running example file from the terminal: ``python 'C:\Users\kbeckers\Desktop\NREL\GitHub\python-geophires-x-nrel\src\geophires_x\GEOPHIRESv3.py' C:\Users\kbeckers\Desktop\NREL\GitHub\python-geophires-x-nrel\tests\examples\example1.txt``
+Example running example file from the terminal::
+
+   python src\geophires_x\GEOPHIRESv3.py tests\examples\example1.txt
 
 Version Management
 ------------------

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/NREL/python-geophires-x/v3.2.5.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/NREL/python-geophires-x/v3.2.8.svg
     :alt: Commits since latest release
-    :target: https://github.com/NREL/python-geophires-x/compare/v3.2.5...main
+    :target: https://github.com/NREL/python-geophires-x/compare/v3.2.8...main
 
 .. |docs| image:: https://readthedocs.org/projects/python-geophires-x/badge/?style=flat
     :target: https://nrel.github.io/python-geophires-x
@@ -87,7 +87,11 @@ follow `the Development instructions <CONTRIBUTING.rst#development>`__ instead.
 
 Usage
 -----
-Example usage:
+
+Python
+^^^^^^
+
+Example usage in Python:
 
 .. code:: python
 
@@ -111,8 +115,6 @@ Example usage:
     with open(result.output_file_path,'r') as f:
         print(f.read())
 
-Available parameters are documented in the `Parameters Reference <https://nrel.github.io/python-geophires-x/parameters.html>`__.
-
 You may also pass parameters as a text file:
 
 .. code:: python
@@ -133,10 +135,47 @@ You may also pass parameters as a text file:
         print(f.read())
 
 
-A variety of examples input ``.txt`` files are available in the `tests/examples directory of the repository <tests/examples>`__.
-
 `test_geophires_x.py <tests/test_geophires_x.py>`__ has additional examples of how to consume and call `GeophiresXClient <src/geophires_x_client/__init__.py#L14>`__.
 
+Command Line
+^^^^^^^^^^^^
+
+If you installed with pip, you may run GEOPHIRES from the command line, passing your input file as an argument::
+
+   python -mgeophires_x my_geophires_input.txt
+
+Parameters
+^^^^^^^^^^
+
+Available parameters are documented in the `Parameters Reference <https://nrel.github.io/python-geophires-x/parameters.html>`__.
+
+Examples
+^^^^^^^^
+
+A variety of example input ``.txt`` files are available in the `tests/examples directory of the repository <tests/examples>`__:
+
+- `example1.txt <tests/examples/example1.txt>`__
+- `example1_addons.txt <tests/examples/example1_addons.txt>`__
+- `example2.txt <tests/examples/example2.txt>`__
+- `example3.txt <tests/examples/example3.txt>`__
+- `example4.txt <tests/examples/example4.txt>`__
+- `example5.txt <tests/examples/example5.txt>`__
+- `example8.txt <tests/examples/example8.txt>`__
+- `example9.txt <tests/examples/example9.txt>`__
+- `example10_HP.txt <tests/examples/example10_HP.txt>`__
+- `example11_AC.txt <tests/examples/example11_AC.txt>`__
+- `example12_DH.txt <tests/examples/example12_DH.txt>`__
+- `example13.txt <tests/examples/example13.txt>`__
+- `Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt>`__
+- `Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt>`__
+- `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt>`__
+- `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt>`__
+- `Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt>`__
+- `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt>`__
+- `SUTRAExample1.txt <tests/examples/SUTRAExample1.txt>`__
+- `example_multiple_gradients.txt <tests/examples/example_multiple_gradients.txt>`__
+
+
 Documentation
 =============
 

docs/conf.py

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

docs/templates/layout.html

@@ -4,13 +4,15 @@
 <script type="text/javascript">
     console.debug('Referrer:', document.referrer)
 
-    if (location.href.indexOf("nrel.github.io/python-geophires-x") !== -1
-        && document.referrer.indexOf("https://github.com/softwareengineerprogrammer/python-geophires-x") !== -1) {
-        /* Redirect links from fork's GitHub docs to fork's docs deployment */
-        location.href = location.href.replace(
-            "nrel.github.io/python-geophires-x",
-            "softwareengineerprogrammer.github.io/python-geophires-x-nrel"
-        )
-    }
+        ['python-geophires-x', 'GEOPHIRES-X'].map((repositoryName) => {
+        if (location.href.indexOf(`nrel.github.io/${repositoryName}`) !== -1
+            && document.referrer.indexOf(`https://github.com/softwareengineerprogrammer/${repositoryName}`) !== -1) {
+            /* Redirect links from fork's GitHub docs to fork's docs deployment */
+            location.href = location.href.replace(
+                `nrel.github.io/${repositoryName}`,
+                `softwareengineerprogrammer.github.io/${repositoryName}`
+            )
+        }
+    })
 </script>
 {% endblock %}

setup.py

@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name='geophires-x',
-    version='3.2.5',
+    version='3.2.8',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(
@@ -80,5 +80,6 @@ def read(*names, **kwargs):
         # eg:
         #   "rst": ["docutils>=0.11"],
         #   ":python_version=="2.6"": ["argparse"],
+        'development': ['bumpversion']
     },
 )

src/geophires_x/AGSOutputs.py

@@ -3,6 +3,8 @@
 import sys
 import traceback
 
+import geophires_x
+
 from .Parameter import ConvertUnitsBack, ConvertOutputUnits
 from .OptionList import EndUseOptions, EconomicModel
 from .Units import *
@@ -83,7 +85,7 @@ def PrintOutputs(self, model: Model):
                     f.write(NL)
                     f.write("Simulation Metadata\n")
                     f.write("----------------------\n")
-                    f.write(" GEOPHIRES Version: 3.0\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"))