Merge branch 'NREL:main' into main

Author: jeffbourdier

.bumpversion.cfg

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

.gitignore

@@ -13,6 +13,7 @@ requirements.txt
 .DS_Store
 *.lock
 *.json
+all_messages_conf.log
 
 # C extensions
 *.so
@@ -81,6 +82,8 @@ docs/reference/geophires-request.json
 docs/reference/parameters.rst
 docs/geophires-request.json
 docs/parameters.rst
+docs/hip-ra-x-request.json
+docs/hip_ra_x_parameters.rst
 _site/
 /docs/geophires_x.rstx
 /docs/temperature.txt

CHANGELOG.rst

@@ -12,6 +12,8 @@ GEOPHIRES-X (2023-2024)
 
 Milestone version for case studies, SHR temperatures, and other changes since 3.0.
 
+3.5.3: SBT Reservoir Model (Slender Body Theory)
+
 3.4
 ^^^
 

CONTRIBUTING.rst

@@ -286,6 +286,28 @@ Once a version bump is merged into the main repository with a Pull Request, tags
 
     (venv) ➜  python-geophires-x git:(main) git push origin --tags
 
+
+Documentation Updates
+---------------------
+
+If a change includes new classes with parameters that should be included in documentation,
+add them to `get_parameter_sources in geophires_x_schema_generator <https://github.com/NREL/GEOPHIRES-X/blob/1f47d6207c4d1458b949ac2cc470b453951d27ac/src/geophires_x_schema_generator/__init__.py#L48-L75>`__.
+Then run `geophires_x_schema_generator/main.py <https://github.com/NREL/GEOPHIRES-X/blob/main/src/geophires_x_schema_generator/main.py>`__
+and commit the updated json schema files to source - `example <https://github.com/NREL/GEOPHIRES-X/pull/285/files#diff-3d85ef79807fc6c25a758a698fd3a7095750bd27ea52341700e1dad94885b5f6>`__.
+
+``geophires_x_schema_generator/main.py`` should also be run if new parameters are added to existing classes or changes are made to existing parameters.
+
+New classes may also be added to the appropriate module file in ``docs/reference``, i.e. `geophires_x.rst <https://github.com/NREL/GEOPHIRES-X/blob/8cf4ee9a2cc917f037ff06554c40698ef2591614/docs/reference/geophires_x.rst#L16-L15>`__
+
+Schema Files
+------------
+
+GEOPHIRES & HIP-RA schema files generated by ``geophires_x_schema_generator`` are in an `OpenAPI Specification <https://swagger.io/docs/specification/about/>`__-compatible format.
+These schema files can be used to build your own API or UI for GEOPHIRES.
+
+* `geophires-request.json <https://github.com/NREL/GEOPHIRES-X/blob/main/src/geophires_x_schema_generator/geophires-request.json>`__
+* `hip-ra-x-request.json <https://github.com/NREL/GEOPHIRES-X/blob/main/src/geophires_x_schema_generator/hip-ra-x-request.json>`__
+
 Tips
 ----
 

README.rst

@@ -51,9 +51,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.5.2.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.5.4.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.5.2...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.5.4...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -254,88 +254,126 @@ Documentation
 Examples
 --------
 
-A variety of example input ``.txt`` files and corresponding case report ``.out`` files are available in the `tests/examples directory of the repository <tests/examples>`__:
+GEOPHIRES includes a variety of examples demonstrating its features and case studies for different types of geothermal systems.
+Starting with an existing GEOPHIRES example that is similar to your intended use/application can be an easier approach to using GEOPHIRES than constructing your own inputs from scratch.
+
+Example input ``.txt`` files and corresponding case report ``.out`` files are available in the `tests/examples directory <tests/examples>`__ of the repository.
+Example-specific web interface deeplinks are listed in the Link column.
 
 
 .. list-table::
-   :widths: 50 40 10
+   :widths: 50 40 5 5
    :header-rows: 1
 
    * - Example
      - Input file
      - Case report file
+     - Link
    * - Example 1
      - `example1.txt <tests/examples/example1.txt>`__
-     - `example1.out <tests/examples/example1.out>`__
+     - `.out <tests/examples/example1.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example1>`__
    * - Example 1 with Addons
      - `example1_addons.txt <tests/examples/example1_addons.txt>`__
-     - `example1_addons.out <tests/examples/example1_addons.out>`__
+     - `.out <tests/examples/example1_addons.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example1_addons>`__
    * - Example 2
      - `example2.txt <tests/examples/example2.txt>`__
-     - `example2.out <tests/examples/example2.out>`__
+     - `.out <tests/examples/example2.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example2>`__
    * - Example 3
      - `example3.txt <tests/examples/example3.txt>`__
-     - `example3.out <tests/examples/example3.out>`__
+     - `.out <tests/examples/example3.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example3>`__
    * - Example 4
      - `example4.txt <tests/examples/example4.txt>`__
-     - `example4.out <tests/examples/example4.out>`__
+     - `.out <tests/examples/example4.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example4>`__
    * - Example 5
      - `example5.txt <tests/examples/example5.txt>`__
-     - `example5.out <tests/examples/example5.out>`__
+     - `.out <tests/examples/example5.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example5>`__
    * - Example 8
      - `example8.txt <tests/examples/example8.txt>`__
-     - `example8.out <tests/examples/example8.out>`__
+     - `.out <tests/examples/example8.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example8>`__
    * - Example 9
      - `example9.txt <tests/examples/example9.txt>`__
-     - `example9.out <tests/examples/example9.out>`__
+     - `.out <tests/examples/example9.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example9>`__
    * - Example 10: Heat Pump
      - `example10_HP.txt <tests/examples/example10_HP.txt>`__
-     - `example10_HP.out <tests/examples/example10_HP.out>`__
+     - `.out <tests/examples/example10_HP.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example10_HP>`__
    * - Example 11: Absorption Chiller
      - `example11_AC.txt <tests/examples/example11_AC.txt>`__
-     - `example11_AC.out <tests/examples/example11_AC.out>`__
+     - `.out <tests/examples/example11_AC.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example11_AC>`__
    * - Example 12: District Heating
      - `example12_DH.txt <tests/examples/example12_DH.txt>`__
-     - `example12_DH.out <tests/examples/example12_DH.out>`__
+     - `.out <tests/examples/example12_DH.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example12_DH>`__
    * - Example 13
      - `example13.txt <tests/examples/example13.txt>`__
-     - `example13.out <tests/examples/example13.out>`__
+     - `.out <tests/examples/example13.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example13>`__
    * - AGS: Coaxial sCO2: Heat (Beckers et. al 2023)
      - `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_sCO2_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out>`__
+     - `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat>`__
    * - AGS: Coaxial Water: Heat (Beckers et. al 2023)
      - `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_Coaxial_water_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out>`__
+     - `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat>`__
    * - AGS: Uloop sCO2: Electricity (Beckers et. al 2023)
      - `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_elec.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out>`__
+     - `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec>`__
    * - AGS: Uloop sCO2: Heat (Beckers et. al 2023)
      - `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_sCO2_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out>`__
+     - `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat>`__
    * - AGS: Uloop Water: Electricity (Beckers et. al 2023)
      - `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_elec.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out>`__
+     - `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec>`__
    * - CLGS: Uloop Water: Heat (Beckers et. al 2023)
      - `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt>`__
-     - `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out>`__
+     - `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat>`__
    * - SUTRA Example 1
      - `SUTRAExample1.txt <tests/examples/SUTRAExample1.txt>`__
-     - `SUTRAExample1.out <tests/examples/SUTRAExample1.out>`__
+     - `.out <tests/examples/SUTRAExample1.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=SUTRAExample1>`__
    * - Multiple Gradients
      - `example_multiple_gradients.txt <tests/examples/example_multiple_gradients.txt>`__
-     - `example_multiple_gradients.out <tests/examples/example_multiple_gradients.out>`__
-   * - Fervo Energy Whitepaper (Norbeck J.H. and Latimer T.M. 2023.)
+     - `.out <tests/examples/example_multiple_gradients.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_multiple_gradients>`__
+   * - Fervo Project Red (Norbeck J.H. and Latimer T.M. 2023.)
      - `Fervo_Norbeck_Latimer_2023.txt <tests/examples/Fervo_Norbeck_Latimer_2023.txt>`__
-     - `Fervo_Norbeck_Latimer_2023.out <tests/examples/Fervo_Norbeck_Latimer_2023.out>`__
+     - `.out <tests/examples/Fervo_Norbeck_Latimer_2023.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Fervo_Norbeck_Latimer_2023>`__
+   * - Fervo Project Cape
+     - `Fervo_Project_Cape.txt <tests/examples/Fervo_Project_Cape.txt>`__
+     - `.out <tests/examples/Fervo_Project_Cape.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Fervo_Project_Cape>`__
    * - Superhot Rock (SHR) Example 1
      - `example_SHR-1.txt <tests/examples/example_SHR-1.txt>`__
-     - `example_SHR-1.out <tests/examples/example_SHR-1.out>`__
+     - `.out <tests/examples/example_SHR-1.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SHR-1>`__
    * - Superhot Rock (SHR) Example 2
      - `example_SHR-2.txt <tests/examples/example_SHR-2.txt>`__
-     - `example_SHR-2.out <tests/examples/example_SHR-2.out>`__
-
+     - `.out <tests/examples/example_SHR-2.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SHR-2>`__
+   * - SBT High Temperature
+     - `example_SBT_Hi_T.txt <tests/examples/example_SBT_Hi_T.txt>`__
+     - `.out <tests/examples/example_SBT_Hi_T.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SBT_Hi_T>`__
+   * - SBT Low Temperature
+     - `example_SBT_Lo_T.txt <tests/examples/example_SBT_Lo_T.txt>`__
+     - `.out <tests/examples/example_SBT_Lo_T.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SBT_Lo_T>`__
 
-An interactive table of examples is available at `gtp.scientificwebservices.com/geophires <https://gtp.scientificwebservices.com/geophires>`__, under the Examples tab.
 
 Parameters
 ----------
@@ -349,6 +387,15 @@ Extending GEOPHIRES-X
 
   - `Extension example: SUTRA <https://github.com/NREL/GEOPHIRES-X/commit/984cb4da1505667adb2c45cb1297cab6550774bd#diff-5b1ea85ce061b9a1137a46c48d2d293126224d677d3ab38d9b2f4dcfc4e1674e>`__
 
+
+HIP-RA: Heat in Place - Resource Assessment
+-------------------------------------------
+
+* `HIP-RA-X README <src/hip_ra_x/README.md>`__
+* `HIP-RA-X Parameters Reference <https://softwareengineerprogrammer.github.io/GEOPHIRES-X/hip_ra_x_parameters.html>`__
+
+.. TODO switch over to https://nrel.github.io/GEOPHIRES-X/hip_ra_x_parameters.html once merged
+
 Monte Carlo
 -----------
 

docs/conf.py

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

docs/index.rst

@@ -8,6 +8,7 @@ Contents
    overview
    parameters
    How-to-extend-GEOPHIRES-X
+   hip_ra_x_parameters
    Monte-Carlo-User-Guide
 ..   reference/index
 

docs/reference/geophires_x.rst

@@ -23,6 +23,9 @@ geophires_x
 .. automodule:: geophires_x.CylindricalReservoir
     :members:
 
+.. automodule:: geophires_x.SBTReservoir
+    :members:
+
 .. automodule:: geophires_x.SUTRAReservoir
     :members:
 
@@ -33,6 +36,9 @@ geophires_x
 .. automodule:: geophires_x.AGSWellBores
     :members:
 
+.. automodule:: geophires_x.SBTWellBores
+    :members:
+
 .. automodule:: geophires_x.SUTRAWellBores
     :members:
 
@@ -52,6 +58,9 @@ geophires_x
 .. automodule:: geophires_x.AGSEconomics
     :members:
 
+.. automodule:: geophires_x.SBTEconomics
+    :members:
+
 .. automodule:: geophires_x.SUTRAEconomics
     :members:
 

setup.py

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