Merge pull request NREL#411 from softwareengineerprogrammer/main

Add-Ons support for SAM Economic Models [v3.9.47]

Author: softwareengineerprogrammer

.bumpversion.cfg

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

CHANGELOG.rst

@@ -8,15 +8,36 @@ GEOPHIRES v3 (2023-2025)
 3.9
 ^^^
 
-`release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.7>`__
+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>`__
 
-v3.9 adds the `SAM Single Owner PPA Economic Model <https://nrel.github.io/GEOPHIRES-X/SAM-Economic-Models.html>`__
+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 +51,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 +72,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 +92,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>`__.

README.rst

@@ -58,9 +58,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.9.43.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.9.47.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.43...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.47...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -308,7 +308,10 @@ Example-specific web interface deeplinks are listed in the Link column.
      - `example_SAM-single-owner-PPA-2.txt <tests/examples/example_SAM-single-owner-PPA-2.txt>`__
      - `.out <tests/examples/example_SAM-single-owner-PPA-2.out>`__
      - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SAM-single-owner-PPA-2>`__
-
+   * - SAM Single Owner PPA: 50 MWe with Add-on
+     - `example_SAM-single-owner-PPA-3.txt <tests/examples/example_SAM-single-owner-PPA-3.txt>`__
+     - `.out <tests/examples/example_SAM-single-owner-PPA-3.out>`__
+     - `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SAM-single-owner-PPA-3>`__
 .. raw:: html
 
    <embed>

docs/SAM-Economic-Models.md

@@ -30,6 +30,7 @@ The following table describes how GEOPHIRES parameters are transformed into SAM
 | `Fraction of Investment in Bonds`                                                                                                               | Financial Parameters → Project Term Debt               | `Debt percent`                                                                                               | `Singleowner`                     | `debt_percent`                                               | .. N/A                                                                                                                                                                                                                                                                                                                    |
 | `Inflated Bond Interest Rate`                                                                                                                   | Financial Parameters → Project Term Debt               | `Annual interest rate`                                                                                       | `Singleowner`                     | `term_int_rate`                                              | .. N/A                                                                                                                                                                                                                                                                                                                    |
 | `Starting Electricity Sale Price`, `Ending Electricity Sale Price`, `Electricity Escalation Rate Per Year`, `Electricity Escalation Start Year` | Revenue                                                | `PPA price`                                                                                                  | `Singleowner`                     | `ppa_price_input`                                            | GEOPHIRES's pricing model is used to create a PPA price schedule that is passed to SAM.                                                                                                                                                                                                                                   |
+| `Total AddOn Profit Gained`                                                                                                                     | Revenue → Capacity Payments                            | `Fixed amount`, `Capacity payment amount`                                                                    | `Singleowner`                     | `cp_capacity_payment_type = 1`, `cp_capacity_payment_amount` |                                                                                                                                                                                                                                                                                                                           |
 | `Investment Tax Credit Rate`                                                                                                                    | Incentives → Investment Tax Credit (ITC)               | `Federal` → `Percentage (%)`                                                                                 | `Singleowner`                     | `itc_fed_percent`                                            | Note that unlike the BICYCLE Economic Model's `Total capital costs`, SAM Economic Model's `Total CAPEX` is the total installed cost and does not subtract ITC value (if present).                                                                                                                                         |
 | `Production Tax Credit Electricity`                                                                                                             | Incentives → Production Tax Credit (PTC)               | `Federal` → `Amount ($/kWh)`                                                                                 | `Singleowner`                     | `ptc_fed_amount`                                             | .. N/A                                                                                                                                                                                                                                                                                                                    |
 | `Production Tax Credit Duration`                                                                                                                | Incentives → Production Tax Credit (PTC)               | `Federal` → `Term (years)`                                                                                   | `Singleowner`                     | `ptc_fed_term`                                               | .. N/A                                                                                                                                                                                                                                                                                                                    |
@@ -48,7 +49,9 @@ The following table describes how GEOPHIRES parameters are transformed into SAM
 ### Limitations
 
 1. Only Electricity end-use is supported
-2. Only 1 construction year is supported. Note that the `Inflation Rate During Construction` parameter can be used to partially account for longer construction periods.
+2. Only 1 construction year is supported. Note that the `Inflation Rate During Construction` parameter can be used to
+   partially account for longer construction periods.
+3. Add-ons with electricity and heat are not currently supported. (Add-ons CAPEX, OPEX, and profit are supported.)
 
 ## Using SAM Economic Models with Existing GEOPHIRES Inputs
 
@@ -135,6 +138,17 @@ You can then manually enter the parameters from the logged mapping into the SAM
 
 ![](sam-desktop-app-manually-enter-system-capacity-from-geophires-log.png)
 
+## Add-Ons
+
+SAM Economic Models incorporate add-ons directly, unlike other GEOPHIRES economic models, which calculate separate
+extended economics.
+Total Add-on CAPEX is added to Total CAPEX.
+Total Add-on OPEX is added to Total operating and maintenance costs.
+Total AddOn Profit Gained per year is treated as fixed amount Capacity payment revenue.
+
+Add-ons CAPEX, OPEX, and profit are supported.
+Add-ons with electricity and heat are not currently supported, but may be supported in the future.
+
 ## Examples
 
 ### SAM Single Owner PPA: 50 MWe

docs/conf.py

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

setup.py

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