softwareengineerprogrammer · softwareengineerprogrammer · Apr 8, 2025 · Apr 8, 2025 · Apr 8, 2025 · Apr 8, 2025
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.8.14
+current_version = 3.9.5
 commit = True
 tag = True
 

diff --git a/.cookiecutterrc b/.cookiecutterrc
@@ -54,7 +54,7 @@ default_context:
     sphinx_doctest: "no"
     sphinx_theme: "sphinx-py3doc-enhanced-theme"
     test_matrix_separate_coverage: "no"
-    version: 3.8.14
+    version: 3.9.5
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -2,20 +2,20 @@
 #   pre-commit install --install-hooks
 # To update the versions:
 #   pre-commit autoupdate
-exclude: '^(\.tox|ci/templates|\.bumpversion\.cfg|src/geophires_x)(/|$)'
+exclude: '^(\.tox|ci/templates|\.bumpversion\.cfg|src/geophires_x(?!/(GEOPHIRESv3|EconomicsSam|EconomicsSamCashFlow)\.py))(/|$)'
 # Note the order is intentional to avoid multiple passes of the hooks
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.1
+    rev: v0.11.4
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix, --show-fixes]
   - repo: https://github.com/psf/black
-    rev: 24.2.0
+    rev: 25.1.0
     hooks:
       - id: black
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,16 @@ Changelog
 GEOPHIRES-X (2023-2025)
 ------------------------
 
+3.9
+^^^
+
+.. TODO/WIP stub
+
+`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.5>`__
+
+SAM Single-owner PPA Economic Model
+
+
 3.8
 ^^^
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -23,5 +23,6 @@ include How-to-extend-GEOPHIRES-X.md
 include geophires-logo.png
 
 prune References
+prune geophires_sam_economics
 
 global-exclude *.py[cod] __pycache__/* *.so *.dylib
diff --git a/README.rst b/README.rst
@@ -56,9 +56,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.8.14.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.9.5.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.8.14...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.5...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -299,7 +299,8 @@ well drilling, surface plant, etc.) are either provided by the user or calculate
 correlations.
 
 For more information on the theoretical basis for GEOPHIRES see
-`GEOPHIRES v2.0: updated geothermal techno‐economic simulation tool (Beckers & McCabe, 2019) <https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/GEOPHIRES%20v2.0%20User%20Manual.pdf>`__.
+`GEOPHIRES v2.0: updated geothermal techno‐economic simulation tool (Beckers & McCabe, 2019) <https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/GEOPHIRES%20v2.0%20User%20Manual.pdf>`__
+and `GEOPHIRES reference materials <References/references.md#geophires>`__.
 
 Parameters
 ----------
@@ -458,6 +459,10 @@ Example-specific web interface deeplinks are listed in the Link column.
      - `example_SHR-2.txt <tests/examples/example_SHR-2.txt>`__
      - `.out <tests/examples/example_SHR-2.out>`__
      - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SHR-2>`__
+   * - SAM Single-owner PPA
+     - `example_SAM-single-owner-PPA.txt <tests/examples/example_SAM-single-owner-PPA.txt>`__
+     - `.out <tests/examples/example_SAM-single-owner-PPA.out>`__
+     - .. FIXME TODO once SAM econ model in web interface: `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SAM-single-owner-PPA>`__
 
 .. raw:: html
 
@@ -499,7 +504,7 @@ Extending GEOPHIRES-X
 Additional Documentation
 ------------------------
 
-Additional materials can be found in `/References </References>`__.
+Additional materials can be found in `/References </References/references.md>`__.
 
 
 Development

diff --git a/docs/Monte-Carlo-User-Guide.md b/docs/Monte-Carlo-User-Guide.md
@@ -118,3 +118,7 @@ python -mgeophires_monte_carlo GEOPHIRESv3.py GEOPHIRES-example1.txt MC_GEOPHIRE
 ## Documentation
 
 See [module documentation](reference/geophires_monte_carlo.html)
+
+## Web Interface
+
+Monte Carlo is available in the web interface at [gtp.scientificwebservices.com/monte-carlo](https://gtp.scientificwebservices.com/monte-carlo)
diff --git a/docs/SAM-Economic-Models.md b/docs/SAM-Economic-Models.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,7 @@
 year = '2025'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.8.14'
+version = release = '3.9.5'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,6 +10,7 @@ Contents
    How-to-extend-GEOPHIRES-X
    hip_ra_x_parameters
    Monte-Carlo-User-Guide
+   SAM-Economic-Models
 ..   reference/index
 
 Indices and tables

diff --git a/pyproject.toml b/pyproject.toml
@@ -10,7 +10,11 @@ requires = [
 extend-exclude = ["static", "ci/templates", "src/geophires_x"]
 
 # Incrementally add files to this list as they are cleaned up
-extend-include=["src/geophires_x/GEOPHIRESv3.py"]
+extend-include=[
+    "src/geophires_x/GEOPHIRESv3.py",
+    "src/geophires_x/EconomicsSam.py",
+    "src/geophires_x/EconomicsSamCashFlow.py",
+]
 
 ignore = [
     "RUF001", # ruff-specific rules ambiguous-unicode-character-string

diff --git a/setup.py b/setup.py
@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name='geophires-x',
-    version='3.8.14',
+    version='3.9.5',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(
@@ -77,9 +77,14 @@ def read(*names, **kwargs):
         'h5py==3.10.0',  # TODO resolve apparent h5py==3.11.0 build compatibility issues on some platforms
         'scipy',
         'iapws',
-        'coolprop',
+        'coolprop; python_version > "3.8"',
+        # coolprop > 6.7.0 fails on Python 3.8, see
+        # https://github.com/softwareengineerprogrammer/GEOPHIRES/actions/runs/14599234458/job/40952924048?pr=69#step:5:302
+        'coolprop==6.7.0; python_version == "3.8"',
         'rich',
         'pylocker',
+        'nrel-pysam',
+        'tabulate',
     ],
     extras_require={
         # eg:

diff --git a/src/geophires_monte_carlo/MC_GeoPHIRES3.py b/src/geophires_monte_carlo/MC_GeoPHIRES3.py
@@ -29,6 +29,7 @@
 from geophires_monte_carlo.common import _get_logger
 from geophires_x.GeoPHIRESUtils import InsertImagesIntoHTML
 from geophires_x.GeoPHIRESUtils import render_default
+from geophires_x.MatplotlibUtils import plt_subplot
 from geophires_x_client import GeophiresInputParameters
 from geophires_x_client import GeophiresXClient
 from geophires_x_client import GeophiresXResult
@@ -519,7 +520,7 @@ def main(command_line_args=None):
         for i in range(len(inputs)):
             input = inputs[i][0]
             plt.figure(figsize=(8, 6))
-            ax = plt.subplot()
+            ax = plt_subplot()
             ax.set_title(input)
             ax.set_xlabel('Random Values')
             ax.set_ylabel('Probability')
@@ -553,7 +554,7 @@ def main(command_line_args=None):
                 annotations += display
 
             plt.figure(figsize=(8, 6))
-            ax = plt.subplot()
+            ax = plt_subplot()
             ax.set_title(output)
             ax.set_xlabel('Output units')
             ax.set_ylabel('Probability')

diff --git a/src/geophires_sam_economics/.gitignore b/src/geophires_sam_economics/.gitignore
@@ -0,0 +1,4 @@
+# scratch files
+draft_issue.md
+sam-cash-flow-table-comparison.csv
+sam-cash-flow-table-saved.csv