Merge pull request NREL#387 from softwareengineerprogrammer/main

SAM Single Owner PPA Economic Model [v3.9]

Author: softwareengineerprogrammer

.bumpversion.cfg

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

.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

CHANGELOG.rst

@@ -5,6 +5,16 @@ Changelog
 GEOPHIRES-X (2023-2025)
 ------------------------
 
+3.9
+^^^
+
+`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.7>`__
+
+v3.9 adds the `SAM Single Owner PPA Economic Model <https://softwareengineerprogrammer.github.io/GEOPHIRES/SAM-Economic-Models.html>`__
+
+.. TODO switch link to nrel.github.io version once merged into main repo
+
+
 3.8
 ^^^
 

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

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.7.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.7...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -288,18 +288,22 @@ direct-use heat (e.g. for industrial processing heating or residential space hea
 (3) co-generation of heat and electricity. The co-generation option considers bottoming
 cycle, topping cycle, and parallel cycle.
 
-GEOPHIRES has 4 economic models to calculate the levelized cost of heat or
+GEOPHIRES has 5 economic models to calculate the levelized cost of heat or
 electricity: (1) fixed charge rate (FCR) model;
 (2) standard discounting levelized cost model;
 (3) BICYCLE model;
-(4) CLGS.
+(4) CLGS;
+(5) SAM Single-owner PPA.
+
+.. TODO link to SAM Economic Model docs
 
 The capital and O&M costs for the different geothermal system components (exploration,
 well drilling, surface plant, etc.) are either provided by the user or calculated with built-in
 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 +462,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>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SAM-single-owner-PPA>`__
 
 .. raw:: html
 

References/references.md

@@ -1,9 +1,9 @@
 
 # GEOPHIRES
-* [GEOPHIRES v2.0 User Manual.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/GEOPHIRES%20v2.0%20User%20Manual.pdf) ![https://doi.org/10.1186/s40517-019-0119-6](https://zenodo.org/badge/doi/10.1186/s40517-019-0119-6.svg)
+* [GEOPHIRES v2.0 User Manual.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/GEOPHIRES%20v2.0%20User%20Manual.pdf) [![](https://zenodo.org/badge/doi/10.1186/s40517-019-0119-6.svg)](https://doi.org/10.1186/s40517-019-0119-6)
 * [Beckers 2019 GEOPHIRES v2.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/Beckers%202019%20GEOPHIRES%20v2.pdf)
 * [Beckers 2018 Introducing GEOPHIRES v2.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/Beckers%202018%20Introducing%20GEOPHIRES%20v2.pdf)
-* [Beckers 2016 Dissertation.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/Beckers%202016%20Dissertation.pdf)
+* [Beckers 2016 Dissertation.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/Beckers%202016%20Dissertation.pdf) [![](https://zenodo.org/badge/doi/10.7298/X4736NTC.svg)](https://doi.org/10.7298/X4736NTC)
 * [Beckers 2013 GEOPHIRES v1.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/Beckers%202013%20GEOPHIRES%20v1.pdf)
 
 # Reference

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)