Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions doc/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Tested on Windows with Python 3.12.10 and GNU Make 4.4.1.
rm -rf build
```

As an alternative, run Make, assuming Make is installed and `Makefile` is in the `doc` folder.
As an alternative, run Make, assuming Make is installed (see below) and `Makefile` is in the `doc` folder.

```
make html
Expand All @@ -78,6 +78,20 @@ Tested on Windows with Python 3.12.10 and GNU Make 4.4.1.

To see Help, open the `../doc/html/index.html` file.

### Make Installation Instructions (Optional)

For Linux, Make comes with the operating system, so you do not need to install it.

For macOS, Make is part of the Command Line Tools that are required to build SAM from source. See [Installing the command-line tools](https://developer.apple.com/documentation/xcode/installing-the-command-line-tools/) if you need to install them.

For Windows:

1. Download the "Complete package, except sources" from https://gnuwin32.sourceforge.net/packages/make.htm.

2. Run the make installer (`make-3.81.exe`).

3. Add the make installation folder `C:\Program Files (x86)\GnuWin32\bin` to the Windows `Path` user environment variable.

## Help Context IDs in SAM

SAM uses Help Context IDs to open context-specific Help files from the SAM user interface.
Expand Down Expand Up @@ -231,7 +245,7 @@ To insert the content of `snip_system_availability.rst` from a file in a `../doc
.. include:: ../includes/snip_system_availability.rst
```

If possible, avoid using headings in snippet files to avoid inconsistencies between the heading level in the snippet file and the file it is being inserted to.
If possible, avoid using headings in snippet files to avoid inconsistencies between the heading level in the snippet file and the file it is being inserted to. *Check this: The Sphinx documentation suggests document structure is preserved if the heading order is the same as the document containing the `include` directive: "If an included document fragment contains section structure, the title adornments must match those of the master document" from https://docutils.sourceforge.io/docs/ref/rst/directives.html#include*.

**Important note about snippets**: Do not include targets (`.. _target-name-in-snippet`), cross references, references to targets in other snippet files, or cross references to other snippet files in snippet files. Doing so results in duplicate target names which breaks the Sphinx build. You can include cross references in snippet files to topic files that are not in the `../doc/includes` folder.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Revenue
Expenses
~~~~~~~~

The expense rows are for annual project costs calculated from assumptions you specify on the :doc:`Financial Parameters <../financial-parameters/fin_all_equity_partnership>`, :doc:`Installation costs <../installation-costs/installation_costs>`, and :doc:`Operating costs <../operating-costs/operating_costs>` pages.
The expense rows are for annual project costs calculated from assumptions you specify on the :doc:`Financial Parameters <../financial-parameters/fin_all_equity_partnership>`, :doc:`Installation costs <../installation-costs/index>`, and :doc:`Operating costs <../operating-costs/operating_costs>` pages.

The operating expenses are based on the first year or annual schedule costs you specify on the Operating costs page, and are adjusted by the inflation rate from the :doc:`Financial Parameters <../financial-parameters/fin_all_equity_partnership>` page and optional escalation rate from the Installation costs page.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Revenue
Project Expenses
~~~~~~~~~~~~~~~~

The expense rows are for annual project costs calculated from assumptions you specify on the :doc:`Financial Parameters <../financial-parameters/fin_all_equity_partnership>`, :doc:`Installation costs <../installation-costs/installation_costs>`, and :doc:`Operating costs <../operating-costs/operating_costs>` pages.
The expense rows are for annual project costs calculated from assumptions you specify on the :doc:`Financial Parameters <../financial-parameters/fin_all_equity_partnership>`, :doc:`Installation costs <../installation-costs/index>`, and :doc:`Operating costs <../operating-costs/operating_costs>` pages.

The operating expenses are based on the first year or annual schedule costs you specify on the Operating costs page, and are adjusted by the inflation rate from the :doc:`Financial Parameters <../financial-parameters/fin_all_equity_partnership>` page and optional escalation rate from the Installation costs page.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The LCOE rows in the cash table show how SAM calculates the real and nominal :do
*+ After Tax Cost in Year 1 ÷ ( 1 + Nominal Discount Rate (%) ÷ 100% )^1*
*+ After Tax Cost in Year 2 ÷ ( 1 + Nominal Discount Rate (%) ÷ 100% )^2*
*+ After Tax Cost in Year 3 ÷ ( 1 + Nominal Discount Rate (%) ÷ 100% )^3*
*+ ...*
*+ ---*
*+ After Tax Cost in Year N ÷ ( 1 + Nominal Discount Rate (%) ÷ 100% )^N ]*

Where the analysis period *N* and *Nominal Discount Rate* are both on the :doc:`Financial Parameters <../financial-parameters/fin_overview>` page, and the :ref:`After Tax Cost <costcashflow>` in Year n is at the bottom of the cash flow table.
Expand All @@ -49,7 +49,7 @@ The LCOE rows in the cash table show how SAM calculates the real and nominal :do
*NPV of Energy Nominal = Energy in Year 1 ÷ ( 1 + Nominal Discount Rate (%) ÷ 100% )^1*
*+ Energy in Year 2 ÷ ( 1 + Nominal Discount Rate (%) ÷ 100% )^2*
*+ Energy in Year 3 ÷ ( 1 + Nominal Discount Rate (%) ÷ 100% )^3*
*+ ...*
*+ ---*
*+ Energy in Year N ÷ ( 1 + Nominal Discount Rate (%) ÷ 100% )^N*

Where the analysis period *N* and *Nominal Discount Rate* are both on the :doc:`Financial Parameters <../financial-parameters/fin_overview>` page, and *Energy* is described above.
Expand All @@ -65,7 +65,7 @@ The LCOE rows in the cash table show how SAM calculates the real and nominal :do
*NPV of Energy Real = Energy in Year 1 ÷ ( 1 + Real Discount Rate (%) ÷ 100% )^1*
*+ Energy in Year 2 ÷ ( 1 + Real Discount Rate (%) ÷ 100% )^2*
*+ Energy in Year 3 ÷ ( 1 + Real Discount Rate (%) ÷ 100% )^3*
*+ ...*
*+ ---*
*+ Energy in Year N ÷ ( 1 + Real Discount Rate (%) ÷ 100% )^N*

Where the analysis period *N* and *Real Discount Rate* are both on the Financial Parameters page.
Expand Down Expand Up @@ -99,7 +99,7 @@ Operating expenses include operation and maintenance, insurance, and property ta
.. include:: ../includes/snip_cf_salvage_value.rst

**Operating costs**
.. include:: ../includes/snip_cf_operating_costs.rst
.. include:: ../operating_costs/index.rst

Deductible Expenses
~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -136,7 +136,7 @@ The tax effect on equity cash flows are the tax calculations for state income ta
* Debt interest payments are deductible for the Residential option with a Mortgage type loan and for the Commercial option. Debt interest payments are not tax deductible for the Residential option with the Standard Loan type loan. You specify the residential loan type on the :doc:`Financial Parameters <../financial-parameters/fin_overview>` page.

Depreciation (Commercial Only)
..............................
------------------------------

Depreciation applies only to the Commercial financial model, and depends on the depreciation schedule from the :doc:`Depreciation <../incentives-and-depreciation/tax_credits_depreciation>` page.

Expand All @@ -150,7 +150,7 @@ Depreciation applies only to the Commercial financial model, and depends on the

*Depreciation in Year n = Depreciation Schedule (%) in Year n × ( Net Capital Cost - Depreciation Basis Reduction )*

Where *Depreciation Schedule* is described above, and the *Net Capital Cost* is the total installed cost from the :doc:`Installation costs <../installation-costs/installation_costs>` page less any incentives from the Incentives page that reduce the depreciation basis.
Where *Depreciation Schedule* is described above, and the *Net Capital Cost* is the total installed cost from the :doc:`Installation costs <../installation-costs/index>` page less any incentives from the Incentives page that reduce the depreciation basis.

*Basis Reduction* depends on whether the project includes any investment-based incentives (IBI) or capacity-based incentives (CBI) specified on the :doc:`Incentives <../incentives-and-depreciation/cash_incentives>` page with checked **State** boxes in the **Reduces Depreciation and ITC Bases** column, or an investment tax credit (ITC) with checked **State** boxes in the **Reduces Depreciation Basis** column. For each IBI, CBI, or ITC with a check mark, SAM subtracts the total incentive amount and fifty percent of the tax credit amount from the total installed cost to calculate the depreciable base:

Expand All @@ -163,12 +163,12 @@ Depreciation applies only to the Commercial financial model, and depends on the
.. _stateincometaxes:

State Income Taxes
..................
------------------

The state income tax is the annual income tax owed before accounting for tax credits. A negative value indicates a net tax liability (tax owed), and a positive value indicates a net tax benefit (tax refund).

State Income Taxes: Residential with Standard Loan
..................................................
--------------------------------------------------

For the Residential financial model with the Standard Loan loan type on the :doc:`Financial Parameters <../financial-parameters/fin_overview>` page, debt interest payments are not tax-deductible:

Expand Down Expand Up @@ -250,7 +250,7 @@ The tax effect on equity cash flows are the tax calculations for federal income
* Debt interest payments are deductible for the Residential option with a Mortgage type loan and for the Commercial option. Debt interest payments are not tax deductible for the Residential option with the Standard Loan type loan. You specify the residential loan type on the :doc:`Financial Parameters <../financial-parameters/fin_overview>` page.

Depreciation (Commercial Only)
..............................
------------------------------

Depreciation applies only to the Commercial financial model, and depends on the depreciation schedule from the :doc:`Depreciation <../incentives-and-depreciation/tax_credits_depreciation>` page.

Expand All @@ -264,7 +264,7 @@ Depreciation applies only to the Commercial financial model, and depends on the

*Depreciation in Year n = Depreciation Schedule (%) in Year n × ( Total Installed costs - Depreciation Basis Reduction )*

Where *Depreciation Schedule* is described above, and the *Total Installed costs* is from the :doc:`Installation costs <../installation-costs/installation_costs>` page.
Where *Depreciation Schedule* is described above, and the *Total Installed costs* is from the :doc:`Installation costs <../installation-costs/index>` page.

*Basis Reduction* depends on whether the project includes any investment-based incentives (IBI) or capacity-based incentives (CBI) specified on the :doc:`Incentives <../incentives-and-depreciation/cash_incentives>` page with checked **Federal** boxes in the **Reduces Depreciation and ITC Bases** column, or an investment tax credit (ITC) on the :doc:`Incentives <../incentives-and-depreciation/cash_incentives>` page with checked **Federal** boxes in the **Reduces Depreciation Basis** column. For each IBI, CBI, or ITC with a check mark, SAM subtracts the total incentive amount and fifty percent of the tax credit amount from the total installed cost to calculate the depreciable base:

Expand All @@ -277,12 +277,12 @@ Depreciation applies only to the Commercial financial model, and depends on the
.. _federalincometaxes:

Federal Income Taxes
....................
--------------------

The federal income tax is the annual income tax owed before accounting for tax credits. A negative value indicates a net tax liability (tax owed), and a positive value indicates a net tax benefit (tax refund).

Federal Income Taxes: Residential with Standard Loan
....................................................
----------------------------------------------------

For the Residential financial model with the Standard Loan loan type on the :doc:`Financial Parameters <../financial-parameters/fin_overview>` page, debt interest payments are not tax-deductible:

Expand Down Expand Up @@ -370,7 +370,7 @@ After Tax Cost and Cash Flow
*+ Total CBI in Year Zero*
*- Total Installed Cost*

Where *Loan Principal Amount* is from the :doc:`fin_overview <../financial-parameters/fin_overview>` page (equivalent to the Debt Balance in Year One of the cash flow), *Total IBI* and *Total CBI* are the values described above, and *Total Installed Cost* is from the :doc:`Installation costs <../installation-costs/installation_costs>` page.
Where *Loan Principal Amount* is from the :doc:`fin_overview <../financial-parameters/fin_overview>` page (equivalent to the Debt Balance in Year One of the cash flow), *Total IBI* and *Total CBI* are the values described above, and *Total Installed Cost* is from the :doc:`Installation costs <../installation-costs/index>` page.

Year One is the first year that the project generates electricity. The after tax cost in Year One and subsequent years is:

Expand Down
30 changes: 15 additions & 15 deletions doc/source/archive/cash-flow-descriptions/cf_sale_leaseback.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ Expenses
.. include:: ../includes/snip_cf_expenses.rst

Operating Margin Not Including Lease Payment
............................................
--------------------------------------------

*Operating Margin Not Including Lease Payment = Total Revenue - Total Operating Expense*

Cash Flow: Developer (Lessee LLC)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Cash Flows from Operating Activities
....................................
------------------------------------

The developer's cash flow from operating activities includes revenue less operating expenses plus interest earned on reserves.

Expand All @@ -51,19 +51,19 @@ The developer's cash flow from operating activities includes revenue less operat
*Total in Year n = Operating Margin Not Including Lease Payment + Plus Interest Earned*

Developer Cash Flows from Investing Activities
..............................................
----------------------------------------------

The developer's cash flow from investing activities occurs in Year Zero, except for the salvage value adjustment which is in the final year of the cash flow.

**Sale of Property**
*Sale of Property in Year Zero = Total Construction Financing Cost + Development Fee + Equity Closing Cost + Other Financing Cost + Total Installed costs*

Where *Total Construction Financing Cost*, *Development Fee*, *Equity Closing Cost*, and *Other Financing Cost* are from the :doc:`Financial Parameters <../financial-parameters/fin_sale_leaseback>` page, and *Total Installed costs* is from the :doc:`Installation costs <../installation-costs/installation_costs>` page.
Where *Total Construction Financing Cost*, *Development Fee*, *Equity Closing Cost*, and *Other Financing Cost* are from the :doc:`Financial Parameters <../financial-parameters/fin_sale_leaseback>` page, and *Total Installed costs* is from the :doc:`Installation costs <../installation-costs/index>` page.

**Purchase of Plant**
*Purchase of Plant in Year Zero = Total Installed Cost - Equity Closing Cost - Total Construction Financing*

Where *Total Construction Financing Cost*, and *Equity Closing Cost* are from the :doc:`Financial Parameters <../financial-parameters/fin_sale_leaseback>` page, and *Total Installed costs* is from the :doc:`Installation costs <../installation-costs/installation_costs>` page.
Where *Total Construction Financing Cost*, and *Equity Closing Cost* are from the :doc:`Financial Parameters <../financial-parameters/fin_sale_leaseback>` page, and *Total Installed costs* is from the :doc:`Installation costs <../installation-costs/index>` page.

**Distribution of Development Fee**
*Distribution of Development Fee in Year 0 = Development Fee*
Expand Down Expand Up @@ -125,38 +125,38 @@ The developer's cash flow from investing activities occurs in Year Zero, except
*Total in Year n>0 = Major Equipment Reserve Account + Major Equipment Capital Spending*

Developer Cash Flows from Financing Activities
..............................................
----------------------------------------------

**Developer Equity in Lessee LLC (funding of reserve accounts)**
**Total**
**Pre-tax cash flow including release of reserves**
**Adjustment for release of reserves**
Developer Pre-tax operating cash flow (effective lease payment)
...............................................................
---------------------------------------------------------------

Cash Flow: Tax Investor (Lessor)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Tax Investor Cash Flows from Operating Activities
.................................................
-------------------------------------------------

**Lease Payment**
**Total**
Tax Investor Cash Flows from Investing Activities
.................................................
-------------------------------------------------

**Purchase of Property**
**Pre-Tax Salvage Value**
**Total**
Tax Investor Cash Flows from Financing Activities
.................................................
-------------------------------------------------

**Issuance of equity**
**IBI**
**CBI**
**Total**
Tax Investor Pre-tax Cash Flow
..............................
------------------------------

LCOE
~~~~
Expand Down Expand Up @@ -206,7 +206,7 @@ Party Returns
~~~~~~~~~~~~~

Tax Investor (Lessor) Pre-tax
.............................
-----------------------------

**Purchase price of asset**
**IBI income**
Expand All @@ -217,7 +217,7 @@ Tax Investor (Lessor) Pre-tax
**Cumulative IRR**
**Cumulative NPV**
Tax Investor (Lessor) After-tax
...............................
-------------------------------

**Purchase price of asset**
**IBI income**
Expand All @@ -236,7 +236,7 @@ Tax Investor (Lessor) After-tax
**Cumulative IRR**
**Cumulative NPV**
Developer Pre-tax
.................
-----------------

**Developer equity in Lessee LLC (funding of reserve accounts)**
**Distribution of development fee**
Expand All @@ -251,7 +251,7 @@ Developer Pre-tax
**IRR**
**NPV**
Developer After-tax
...................
-------------------

**Developer equity in Lessee LLC (funding of reserve accounts)**
**Distribution of development fee**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Revenues
Operating Expenses
~~~~~~~~~~~~~~~~~~

The expense rows are for annual project costs calculated from assumptions you specify on the :doc:`Financing <../financial-parameters/fin_single_owner>`, :doc:`Installation costs <../installation-costs/installation_costs>`, and :doc:`Operating costs <../operating-costs/operating_costs>` pages.
The expense rows are for annual project costs calculated from assumptions you specify on the :doc:`Financing <../financial-parameters/fin_single_owner>`, :doc:`Installation costs <../installation-costs/index>`, and :doc:`Operating costs <../operating-costs/operating_costs>` pages.

The operating expenses are based on the first year or annual schedule costs you specify on the :doc:`Operating costs <../operating-costs/operating_costs>` page, and are adjusted by the inflation rate from the :doc:`Financial Parameters <../financial-parameters/fin_single_owner>` page and optional escalation rate from the Operating costs page.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ SAM calculates two types parasitic loss values. The first is an estimate of the
.. note:: Parasitic losses from components that do not exist in the system should be set to zero.

Parasitic Energy Consumption
............................
----------------------------

**Startup energy of a single heliostat, kWe-hr**
The electric energy in kilowatt-hours required to move each heliostat into position. Applies during hours when the heliostat is starting up.
Expand Down
Loading
Loading