Merge branch 'main' into softwareengineerprogrammer_sherrboldt_tough-updates

Author: softwareengineerprogrammer

.bumpversion.cfg

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

.github/pull_request_template.md

@@ -0,0 +1,33 @@
+# Description
+
+*Describe your change, including links to relevant tracking issue(s), implementation approach, new/updated documentation,
+and any other relevant information.*
+
+# Testing & Verification
+
+1. Unit tests added: *Describe new unit tests added, if any.*
+1. Unit tests updated: *Describe existing unit tests that were updated, if any.*
+1. Manual testing: *Describe any additional manual testing steps that were performed, such as running the change on a pre-existing data set you own.*
+
+---
+
+**Change Checklist**:
+
+Observe the following checklist items if your change includes a new version (see [versioning notes](https://github.com/NREL/GEOPHIRES-X/blob/main/CHANGELOG.rst#versioning-notes) and [version management docs](https://github.com/NREL/GEOPHIRES-X/blob/main/CONTRIBUTING.rst#version-management)).
+
+Before merging:
+1. [ ] Add a CHANGELOG entry ([example](https://github.com/NREL/GEOPHIRES-X/commit/15e10e5c3c08633a16645e41dfb7e8131805483f)). RST Template:
+```restructuredtext
+M.m.P: `TITLE <https://github.com/NREL/GEOPHIRES-X/pull/PR-NUMBER>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/vM.m.P>`__
+```
+
+After merging:
+1. [ ] Push tag(s) to GitHub: `git push origin refs/tags/vM.m.P`
+1. [ ] Post a change announcement to the [GEOPHIRES Change Announcements Discussion](https://github.com/NREL/GEOPHIRES-X/discussions/428) ([example](https://github.com/NREL/GEOPHIRES-X/discussions/428#discussioncomment-14593405)). Markdown template:
+```markdown
+M.m.p: [TITLE](https://github.com/NREL/GEOPHIRES-X/pull/PR-NUMBER) | [release](https://github.com/NREL/GEOPHIRES-X/releases/tag/vM.m.P)
+```
+
+---
+
+*Additional metadata such as TODO items or link to your initial self-review (PR into your own fork created prior to submission)*

.github/workflows/github-actions.yml

@@ -38,24 +38,18 @@ jobs:
             python_arch: 'x64'
             tox_env: 'py39'
             os: 'ubuntu-latest'
-          - name: 'py39 (windows)'
-            python: '3.9'
-            toxpython: 'python3.9'
-            python_arch: 'x64'
-            tox_env: 'py39'
-            os: 'windows-latest'
           - name: 'py310 (ubuntu)'
             python: '3.10'
             toxpython: 'python3.10'
             python_arch: 'x64'
             tox_env: 'py310'
             os: 'ubuntu-latest'
-          - name: 'py310 (windows)'
-            python: '3.10'
-            toxpython: 'python3.10'
-            python_arch: 'x64'
-            tox_env: 'py310'
-            os: 'windows-latest'
+#          - name: 'py310 (windows)'
+#            python: '3.10'
+#            toxpython: 'python3.10'
+#            python_arch: 'x64'
+#            tox_env: 'py310'
+#            os: 'windows-latest'
           - name: 'py311 (ubuntu)'
             python: '3.11'
             toxpython: 'python3.11'
@@ -74,7 +68,12 @@ jobs:
             python_arch: 'x64'
             tox_env: 'py311'
             os: 'windows-latest'
-
+          - name: 'py312 (ubuntu)'
+            python: '3.12'
+            toxpython: 'python3.12'
+            python_arch: 'x64'
+            tox_env: 'py312'
+            os: 'ubuntu-latest'
 #          - name: 'pypy38 (ubuntu)'
 #            python: 'pypy-3.8'
 #            toxpython: 'pypy3.8'

.gitignore

@@ -23,6 +23,10 @@ Geothermal_district_heating_system_with_peaking_boilers.png
 *.html
 !docs/*.html
 
+# TODO may want to add this to source
+regenerate-schemas.sh
+requirements_2025-08-11.txt
+
 # C extensions
 *.so
 
@@ -80,6 +84,8 @@ nosetests.xml
 .pydevproject
 .vscode
 
+ai.md
+
 # Complexity
 output/*.html
 output/*/index.html
@@ -100,6 +106,9 @@ _site/
 /Useful sites for Sphinx docstrings.txt
 /.github/workflows/workflows.7z
 
+# TODO unignore once favicon is correctly configured
+docs/_images/geophires-favicon.png
+
 # Mypy Cache
 .mypy_cache/
 
@@ -110,6 +119,21 @@ _site/
 /src/geophires_x/CLG Simulator/clg_tea_v3_SCO2_elec.py
 /src/geophires_x/CLG Simulator/clgs_v2.py
 
+# TOUGH
+CO2TAB
+Doublet.dat
+Doublet.out
+FOFT_*.csv
+GENER
+GOFT_*.csv
+INCON
+INFILE
+MESH*
+OUTPUT_ELEME.csv
+SAVE
+TABLE
+rcc3.out
+tough_debug_output/
 
 # Temp
 ai.md

CHANGELOG.rst

@@ -2,21 +2,59 @@
 Changelog
 =========
 
-GEOPHIRES-X (2023-2025)
+GEOPHIRES v3 (2023-2025)
 ------------------------
 
 3.9
 ^^^
+3.9.65: `GEOPHIRES v3 User Manual, GEOPHIRES Project Tenets, example_SAM-Single-Owner-PPA PI/II pumping power <https://github.com/NREL/GEOPHIRES-X/pull/432>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.65>`__
 
-`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.7>`__
+3.9.64: `Update tooltip texts from theoretical basis <https://github.com/NREL/GEOPHIRES-X/pull/430>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.64>`__
 
-v3.9 adds the `SAM Single Owner PPA Economic Model <https://nrel.github.io/GEOPHIRES-X/SAM-Economic-Models.html>`__
+3.9.62: `Change notifications, typo fixes, royalties example PI/II <https://github.com/NREL/GEOPHIRES-X/pull/429>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.62>`__
 
+3.9.61: `Royalties <https://github.com/NREL/GEOPHIRES-X/pull/425>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.61>`__
+
+3.9.54: `List parameter read fix <https://github.com/NREL/GEOPHIRES-X/pull/418>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.54>`__
+
+3.9.53: `Gringarten-Stehfest Precision <https://github.com/NREL/GEOPHIRES-X/pull/417>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.53>`__
+
+3.9.50: `HIP-RA-X Print Output to Console parameter <https://github.com/NREL/GEOPHIRES-X/pull/416>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.50>`__
+
+3.9.49: `Fervo_Project_Cape-4 Stimulation Costs Update <https://github.com/NREL/GEOPHIRES-X/pull/414>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.49>`__
+
+3.9.48: `Well diameter outputs, surface plant cost, non-SAM-EM Inflation costs during construction <https://github.com/NREL/GEOPHIRES-X/pull/412>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.48>`__
+
+3.9.47: `Add-Ons support for SAM Economic Models <https://nrel.github.io/GEOPHIRES-X/SAM-Economic-Models.html#add-ons>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.47>`__
+
+3.9.43: `Inflation costs <https://github.com/NREL/GEOPHIRES-X/pull/409>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.43>`__
+
+3.9.40: `Redrilling costs fixup; Don't display incorrect SAM-EM ITC <https://github.com/NREL/GEOPHIRES-X/pull/405>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.40>`__
+
+3.9.36: `Increase max exploration cost <https://github.com/NREL/GEOPHIRES-X/pull/403>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.36>`__
+
+3.39.35: `Parameterize contingency <https://github.com/NREL/GEOPHIRES-X/pull/402>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.35>`__
+
+3.9.34: `Parameterize indirect costs <https://github.com/NREL/GEOPHIRES-X/pull/401>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.34>`__
+
+3.9.33: `Parameterize Reservoir Stimulation Capital Cost per well <https://github.com/NREL/GEOPHIRES-X/pull/399>`__, `Allow input parameters in CSV <https://github.com/NREL/GEOPHIRES-X/pull/398>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.33>`__
+
+3.9.31: `Fix client cwd stashing regression <https://github.com/NREL/GEOPHIRES-X/pull/397>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.31>`__
+
+3.9.29: `Move Getting Started to separate documentation page; MPF Gringarten name <https://github.com/NREL/GEOPHIRES-X/pull/396>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.29>`__
+
+3.9.28: `Peaking Boiler Cost per kW; Increase allowed fractures; Honor Capital Cost for Power Plant; Client caching fix; Cape-4 laterals & res. vol.; Doublets parameter <https://github.com/NREL/GEOPHIRES-X/pull/394>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.28>`__
+
+3.9.16: `Fervo Cape Station 500 MWe Update + 50 MWe SAM Example <https://github.com/NREL/GEOPHIRES-X/pull/389>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.16>`__
+
+3.9.8: `Missing percent unit fixes <https://github.com/NREL/GEOPHIRES-X/pull/388>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.8>`__
+
+3.9: `SAM Single Owner PPA Economic Model <https://nrel.github.io/GEOPHIRES-X/SAM-Economic-Models.html>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.7>`__
 
 3.8
 ^^^
 
-`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.8.0>`__ | `diff <https://github.com/NREL/GEOPHIRES-X/compare/v3.7.0...v3.8.0>`__
+`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.8.14>`__ | `diff <https://github.com/NREL/GEOPHIRES-X/compare/v3.7.23...v3.8.14>`__
 
 Revenue & Cashflow Profile period output aligned with NREL convention used to calculate NPV.
 See https://github.com/NREL/GEOPHIRES-X/discussions/344
@@ -30,7 +68,7 @@ DOE 2019. "GeoVision" p. 163. https://www.energy.gov/sites/prod/files/2019/06/f6
 3.7
 ^^^
 
-`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.7.0>`__ | `diff <https://github.com/NREL/GEOPHIRES-X/compare/v3.6.0...v3.7.0>`__
+`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.7.23>`__ | `diff <https://github.com/NREL/GEOPHIRES-X/compare/v3.6.9...v3.7.23>`__
 
 "Well depth (or total length, if not vertical)" output field renamed to "Well depth" per https://github.com/NREL/GEOPHIRES-X/issues/321
 
@@ -51,7 +89,7 @@ DOE 2019. "GeoVision" p. 163. https://www.energy.gov/sites/prod/files/2019/06/f6
 3.6
 ^^^
 
-`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.6.0>`__ | `diff <https://github.com/NREL/GEOPHIRES-X/compare/v3.5.0...v3.6.0>`__
+`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.6.9>`__ | `diff <https://github.com/NREL/GEOPHIRES-X/compare/v3.5.7...v3.6.9>`__
 
 Changes default output file path to the original working directory instead of the the GEOPHIRES module source directory (usually ``geophires-x`` or ``src/geophires_x``, depending on package installation type).
 This affects:
@@ -71,7 +109,7 @@ Affected users who do not want the new behavior can specify absolute output path
 3.5
 ^^^
 
-`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.5.0>`__ | `diff <https://github.com/NREL/GEOPHIRES-X/compare/v3.4.0...v3.5.0>`__
+`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.5.7>`__ | `diff <https://github.com/NREL/GEOPHIRES-X/compare/v3.4.0...v3.5.7>`__
 
 Milestone version for case studies, SHR temperatures, and other changes since 3.0.
 An overview is given in the July 2024 NREL GEOPHIRES Workshop `Version 3.5 Announcement session recording <https://youtu.be/Bi_l6y6_LQk>`__.
@@ -108,8 +146,8 @@ Bug fixes
 Internal changes to support unit testing
 
 
-3.0
-^^^
+3.0: GEOPHIRES-X
+^^^^^^^^^^^^^^^^
 `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.0.0>`__
 
 - New repository: https://github.com/NREL/GEOPHIRES-X (Originally https://github.com/NREL/python-geophires-x, renamed to GEOPHIRES-X 2023-12-15 per https://github.com/NREL/GEOPHIRES-X/issues/48.)
@@ -144,3 +182,11 @@ as intermediate internal-only patch versions are sometimes introduced during the
 (Improved designation and distribution of releases for public consumption may eventually be addressed by
 `publishing to PyPI <https://github.com/NREL/GEOPHIRES-X/issues/117>`__ and/or use of
 `GitHub releases <https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases>`__.)
+
+Change Notifications
+--------------------
+To receive email notifications of changes:
+
+1. Create or log in to your GitHub account.
+2. Go to the `GEOPHIRES Change Announcements Discussion <https://github.com/NREL/GEOPHIRES-X/discussions/428>`__.
+3. Click the Subscribe button in the Notifications section in the right panel.

CONTRIBUTING.rst

@@ -4,6 +4,18 @@ Contributing
 
 Contributions are welcome and greatly appreciated. GEOPHIRES is free and open source software that is built with collaboration and knowledge sharing. Don't hesitate to reach out to `the authors <AUTHORS.rst>`__ if you are interested in contributing in any way — big or small!
 
+GEOPHIRES Project Tenets
+========================
+
+1. **Empower Users to Develop & Deploy Geothermal Technology**: GEOPHIRES's core tenet is to serve the geothermal techno-economic analysis needs of our users including public sector, industry, and academic, especially with regards to the development and deployment of next-generation geothermal technology.
+
+2. **Correctness & Credibility**: GEOPHIRES strives to be maximally accurate according to state-of-the-art research consensus. SME review is required for all changes.
+
+3. **Build Open Consensus & Community**: We build geothermal industry and stakeholder consensus through open source transparency into GEOPHIRES methodology and calculations. We embrace geothermal community participation and contribution as core aspects of fostering consensus.
+
+4. **Continuous Improvement**: GEOPHIRES is updated continuously to reflect the latest geothermal industry research and developments. Software engineering best practices including automated test coverage ensure code quality and compliance with specifications.
+
+
 Feature requests and feedback
 =============================