Skip to content

Commit 9cc0e5b

Browse files
fix documentation table rendering
1 parent 262cf19 commit 9cc0e5b

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

docs/SAM-Economic-Models.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,28 @@
44

55
### Parameters
66

7-
.. FIXME doesn't render in RST!
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!
811

912
| GEOPHIRES Parameter(s) | SAM Category | SAM Input(s) | SAM Module(s) | SAM Parameter Name(s) | Comment |
1013
|------------------------------------------------------|--------------------------------------------------------|----------------------------------------------------------------------------------|-----------------------------------|--------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
11-
| `Max Net Electricity Production` | Generation Profile | `Nameplate capacity` | `Singleowner` | `system_capacity` | |
14+
| `Max Net Electricity Production` | Generation Profile | `Nameplate capacity` | `Singleowner` | `system_capacity` | .. N/A |
1215
| `Net Electricity Production` | AC Degradation | `Annual AC degradation rate` schedule | `Utilityrate5` | `degradation` | Percentage difference of each year's `Net Electricity Production` from `Max Net Electricity Production` is input as SAM as the degradation rate schedule in order to match SAM's generation profile to GEOPHIRES |
13-
| `Total Capital Cost` + `Investment Tax Credit Value` | Installation Costs | `Total Installed Cost` | `Singleowner` | `total_installed_cost` | |
14-
| `Total O&M Cost`, `Inflation Rate` | Operating Costs | `Fixed operating cost`, `Escalation rate` set to `Inflation Rate` × -1 | `Singleowner` | `om_fixed`, `om_fixed_escal` | |
15-
| `Plant Lifetime` | Financial Parameters → Analysis Parameters | `Analysis period` | `CustomGeneration`, `Singleowner` | `CustomGeneration.analysis_period`, `Singleowner.term_tenor` |
16-
| `Inflation Rate` | Financial Parameters → Analysis Parameters | `Inflation rate` | `Utilityrate5` | `inflation_rate` |
17-
| `Discount Rate` | Financial Parameters → Analysis Parameters | `Real discount rate` | `Singleowner` | `real_discount_rate` | |
16+
| `Total Capital Cost` + `Investment Tax Credit Value` | Installation Costs | `Total Installed Cost` | `Singleowner` | `total_installed_cost` | .. N/A |
17+
| `Total O&M Cost`, `Inflation Rate` | Operating Costs | `Fixed operating cost`, `Escalation rate` set to `Inflation Rate` × -1 | `Singleowner` | `om_fixed`, `om_fixed_escal` | .. N/A |
18+
| `Plant Lifetime` | Financial Parameters → Analysis Parameters | `Analysis period` | `CustomGeneration`, `Singleowner` | `CustomGeneration.analysis_period`, `Singleowner.term_tenor` | .. N/A |
19+
| `Inflation Rate` | Financial Parameters → Analysis Parameters | `Inflation rate` | `Utilityrate5` | `inflation_rate` | .. N/A |
20+
| `Discount Rate` | Financial Parameters → Analysis Parameters | `Real discount rate` | `Singleowner` | `real_discount_rate` | .. N/A |
1821
| `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. |
19-
| `Property Tax Rate` | Financial Parameters | `Property tax rate` | `Singleowner` | `property_tax_rate` | |
20-
| `Fraction of Investment in Bonds` | Financial Parameters → Project Term Debt | `Debt percent` | `Singleowner` | `debt_percent` | |
21-
| `Inflated Bond Interest Rate` | Financial Parameters → Project Term Debt | `Annual interest rate` | `Singleowner` | `debt_percent` | |
22-
| `Starting Electricity Sale Price` | Revenue | `PPA price` | `Singleowner` | `ppa_price_input` | |
22+
| `Property Tax Rate` | Financial Parameters | `Property tax rate` | `Singleowner` | `property_tax_rate` | .. N/A |
23+
| `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 |
25+
| `Starting Electricity Sale Price` | Revenue | `PPA price` | `Singleowner` | `ppa_price_input` | .. N/A |
2326
| `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) |
24-
| `Investment Tax Credit Rate` | Incentives → Investment Tax Credit (ITC) | `Federal``Percentage (%)` | `Singleowner` | `itc_fed_percent` | |
25-
| `Other Incentives` + `One-time Grants Etc` | Incentives → Investment Based Incentive (IBI) | `Other``Amount ($)` | `Singleowner` | `ibi_oth_amount` | |
27+
| `Investment Tax Credit Rate` | Incentives → Investment Tax Credit (ITC) | `Federal``Percentage (%)` | `Singleowner` | `itc_fed_percent` | .. N/A |
28+
| `Other Incentives` + `One-time Grants Etc` | Incentives → Investment Based Incentive (IBI) | `Other``Amount ($)` | `Singleowner` | `ibi_oth_amount` | .. N/A |
2629

2730
[Implementation in source code](https://github.com/softwareengineerprogrammer/GEOPHIRES/blob/274786e6799d32dad3f42a2a04297818b811f24c/src/geophires_x/EconomicsSam.py#L135-L195)
2831

@@ -31,6 +34,6 @@
3134
1. Only Electricity end-use is supported
3235
2. Only 1 construction year is supported
3336
3. The following economic outputs are not supported:
34-
1. Project VIR=PI=PIR
35-
2. Project MOIC
36-
3. Project payback period
37+
1. Project VIR=PI=PIR
38+
2. Project MOIC
39+
3. Project payback period

0 commit comments

Comments
 (0)