Skip to content

Commit 0956487

Browse files
fix documentation errors, add descriptions + links to SAM pages
1 parent bdcda6e commit 0956487

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

docs/SAM-Economic-Models.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,26 @@
11
# SAM Economic Models
22

3+
SAM Economic Models leverage [NREL's SAM Financial Models](https://sam.nrel.gov/financial-models.html)
4+
by transforming GEOPHIRES parameters into SAM parameters and running SAM with [PySAM](https://github.com/NREL/pysam).
5+
36
## SAM Single-Owner PPA
47

8+
SAM Financial Model: [Power Purchase Agreement (PPA): Single owner](https://sam.nrel.gov/financial-models/utility-scale-ppa)
9+
510
### Parameters
611

7-
.. RST Comment: Comment entries of ".. N/A" render as blank in the final RST, by design.
8-
.. This entry value is required because m2r2 (https://pypi.org/project/m2r2/) seems to choke and bail on rendering
9-
.. the entire table when blank comment entries are blank. Make sure to check this doesn't happen when making changes
10-
.. to this file by running `tox -e docs` and opening `dist/docs/SAM-Economic-Models.html` in your browser!
12+
The following table describes how GEOPHIRES parameters are transformed into SAM parameters, as implemented in
13+
[EconomicsSam.py](https://github.com/softwareengineerprogrammer/GEOPHIRES/blob/274786e6799d32dad3f42a2a04297818b811f24c/src/geophires_x/EconomicsSam.py#L135-L195).
14+
(Note that the source code implementation determines actual behavior in the case of any discrepancies.)
15+
16+
.. <RST_Comment>
17+
.. Comment entries of ".. N/A" render as blank in the final RST, by design.
18+
.. This entry value is required because m2r2 (https://pypi.org/project/m2r2/) seems to choke and bail on rendering
19+
.. the entire table when blank comment entries are blank. Make sure to check this doesn't happen when making changes
20+
.. to this file by running `tox -e docs` and opening `dist/docs/SAM-Economic-Models.html` in your browser!
21+
..
22+
.. TODO: Generate this programmatically (like schema generator) to prevent drift between code and documentation.
23+
.. </RST_Comment>
1124

1225
| GEOPHIRES Parameter(s) | SAM Category | SAM Input(s) | SAM Module(s) | SAM Parameter Name(s) | Comment |
1326
|------------------------------------------------------|--------------------------------------------------------|----------------------------------------------------------------------------------|-----------------------------------|--------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -18,17 +31,15 @@
1831
| `Plant Lifetime` | Financial Parameters → Analysis Parameters | `Analysis period` | `CustomGeneration`, `Singleowner` | `CustomGeneration.analysis_period`, `Singleowner.term_tenor` | .. N/A |
1932
| `Inflation Rate` | Financial Parameters → Analysis Parameters | `Inflation rate` | `Utilityrate5` | `inflation_rate` | .. N/A |
2033
| `Discount Rate` | Financial Parameters → Analysis Parameters | `Real discount rate` | `Singleowner` | `real_discount_rate` | .. N/A |
21-
| `Combined Income Tax Rate` | Financial Parameters → Project Tax and Insurance Rates | `Federal income tax rate` (75% of CTR) and `State income tax rate` (25% of CTR) | `Singleowner` | `federal_tax_rate`, `state_tax_rate` | GEOPHIRES does have separate parameters for federal and state income tax so the rates are split from the combined rate based on the ratio of SAM's default values of 21% and 7%, respectively. |
34+
| `Combined Income Tax Rate` | Financial Parameters → Project Tax and Insurance Rates | `Federal income tax rate` (75% of CTR) and `State income tax rate` (25% of CTR) | `Singleowner` | `federal_tax_rate`, `state_tax_rate` | GEOPHIRES does not have separate parameters for federal and state income tax so the rates are split from the combined rate based on the ratio of SAM's default values of 21% and 7%, respectively. |
2235
| `Property Tax Rate` | Financial Parameters | `Property tax rate` | `Singleowner` | `property_tax_rate` | .. N/A |
2336
| `Fraction of Investment in Bonds` | Financial Parameters → Project Term Debt | `Debt percent` | `Singleowner` | `debt_percent` | .. N/A |
24-
| `Inflated Bond Interest Rate` | Financial Parameters → Project Term Debt | `Annual interest rate` | `Singleowner` | `debt_percent` | .. N/A |
37+
| `Inflated Bond Interest Rate` | Financial Parameters → Project Term Debt | `Annual interest rate` | `Singleowner` | `term_int_rate` | .. N/A |
2538
| `Starting Electricity Sale Price` | Revenue | `PPA price` | `Singleowner` | `ppa_price_input` | .. N/A |
2639
| `Electricity Escalation Rate Per Year` × 0.745 | Revenue | `PPA price escalation` | `Singleowner` | `ppa_escalation` | Approximates GEOPHIRES escalation rate into escalation percentage (does not exactly match GEOPHIRES amount-based pricing model) |
2740
| `Investment Tax Credit Rate` | Incentives → Investment Tax Credit (ITC) | `Federal``Percentage (%)` | `Singleowner` | `itc_fed_percent` | .. N/A |
2841
| `Other Incentives` + `One-time Grants Etc` | Incentives → Investment Based Incentive (IBI) | `Other``Amount ($)` | `Singleowner` | `ibi_oth_amount` | .. N/A |
2942

30-
[Implementation in source code](https://github.com/softwareengineerprogrammer/GEOPHIRES/blob/274786e6799d32dad3f42a2a04297818b811f24c/src/geophires_x/EconomicsSam.py#L135-L195)
31-
3243
### Limitations
3344

3445
1. Only Electricity end-use is supported

0 commit comments

Comments
 (0)