Skip to content

Commit

Permalink
Merge pull request #1359 from NREL/help-sam-2022.11.21-patch1
Browse files Browse the repository at this point in the history
Help updates for 2022.11.21 Patch 1
  • Loading branch information
sjanzou authored Feb 23, 2023
2 parents 8606322 + 8b17e0e commit 7145371
Show file tree
Hide file tree
Showing 33 changed files with 6,101 additions and 5,740 deletions.
152 changes: 92 additions & 60 deletions deploy/runtime/help/html/battery_results.htm

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion deploy/runtime/help/html/cc_ptes.htm
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ <h1 class="p_Heading1"><span class="f_Heading1">PTES Installation Costs</span></

<!-- Placeholder for topic body. -->
<table style="width:100%;border:none;border-spacing:0px"><tr style="vertical-align:top"><td style="text-align:left;padding:5px">
<p class="p_Text"><span class="f_Text" style="font-weight: bold;">**REVISE FOR PTES**</span></p>
<p class="p_Text"><span class="f_Text">&nbsp;</span></p>
<p class="p_Text"><span class="f_Text">Installation Costs are costs associated with installing the system, and include equipment, labor, engineering, permitting, and any other costs that apply in Year 0 of the project cash flow. Some costs, such as debt-related and sales tax costs are specified on the <a href="financial_parameters.htm" class="topiclink">Financial Parameters</a> page.</span></p>
<p class="p_Text"><span class="f_Text">SAM uses the variables on the Installation Costs page to calculate the project investment cost.</span></p>
<p class="p_Text"><span class="f_Text">Recurring costs that apply in Years 1 and later of the project cash flow are on the <a href="operating_costs.htm" class="topiclink">Operating Costs</a> page.</span></p>
Expand Down
2 changes: 1 addition & 1 deletion deploy/runtime/help/html/electric_load.htm
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h4 class="p_Heading4"><span class="f_Heading4">Adjust Load Profile to Monthly U
<h4 class="p_Heading4"><span class="f_Heading4">Download</span></h4>
<p class="p_Text"><span class="f_Text">Click </span><span class="f_CHInterfaceElement">Download Electric Load Data</span><span class="f_Text"> to download hourly load data for a selection residential or commercial building types. Clicking the button is the same as running the &quot;Download Electric Load&quot; macro from the Macros page, which you can access by clicking </span><span class="f_CHInterfaceElement">Macros</span><span class="f_Text"> under the simulate button.</span></p>
<p class="p_Text"><span class="f_Text">The macro downloads an hourly load file from the <a href="https://data.openei.org/submissions/153" target="_blank" class="weblink" title="https://data.openei.org/submissions/153">Commercial and Residential Hourly Load Profiles for all TMY3 Locations in the United States</a> dataset and imports it to the Electric Load input page. </span><span class="f_Emphasis">This dataset has limitations that are described on its web page.</span><span class="f_Text"> These files are a collection of 8,760 hourly load profiles for a range of building types for each of the 1,020 U.S. locations in the legacy NSRDB TMY3 data set. The modeled load profiles were generated using typical meteorological year weather files. The macro identifies the TMY3 location nearest the latitude and longitude in your weather file, and downloads the load file for your building type for that TMY3 location. If the script cannot identify the latitude and longitude from your weather file, it prompts you for the values. </span></p>
<p class="p_Note"><span class="f_CHNote">Note.</span><span class="f_Note"> This older dataset has been superseded by the <a href="https://data.openei.org/submissions/4520" target="_blank" class="weblink" title="https://data.openei.org/submissions/4520">End-Use Load Profiles for the U.S. Building Stock</a>. The new dataset provides access to thousands of 15-minute load profiles for many residential and commercial building types modeled using single-year NSRDB weather files for more recent years than the TMY3 data. You can use the <a href="https://github.com/NREL/SAM/tree/patch/samples/Python%20Scripts/End%20Use%20Load%20Profiles" target="_blank" class="weblink" title="https://github.com/NREL/SAM/tree/patch/samples/Python%20Scripts/End%20Use%20Load%20Profiles">End Use Load Profiles Python package</a> to access the data to use with SAM. Because of the much larger number of load profiles and building types represented in the data, it is not possible to create a short list of building types to choose from in the same way as the macro does for the older dataset. An API for the newer dataset may be available in the future that will make this possible.</span></p>
<p class="p_Note"><span class="f_CHNote">Note.</span><span class="f_Note"> The <a href="https://data.openei.org/submissions/4520" target="_blank" class="weblink" title="https://data.openei.org/submissions/4520">End-Use Load Profiles for the U.S. Building Stock</a> provides access to thousands of 15-minute load profiles for many residential and commercial building types modeled using single-year NSRDB weather files for more recent years than the TMY3 data. You can use the <a href="https://github.com/NREL/SAM/tree/patch/samples/Python%20Scripts/End%20Use%20Load%20Profiles" target="_blank" class="weblink" title="https://github.com/NREL/SAM/tree/patch/samples/Python%20Scripts/End%20Use%20Load%20Profiles">End Use Load Profiles Python package</a> to access the data to use with SAM. Because of the much larger number of load profiles and building types represented in the data, it is not possible to create a short list of building types to choose from in the same way as the macro does for the older dataset. An API for the newer dataset may be available in the future that will make this possible.</span></p>
<h4 class="p_Heading4"><span class="f_Heading4">Monthly Load Summary</span></h4>
<p class="p_Text"><span class="f_Text">SAM displays the table of monthly and annual totals to help you verify that the load data is correct. SAM calculates these values from the time series load data. To change the monthly values, you have to either change the time series data, or change scaling factors.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Energy (kWh)</span></p>
Expand Down
24 changes: 18 additions & 6 deletions deploy/runtime/help/html/electricity_rates.htm
Original file line number Diff line number Diff line change
Expand Up @@ -224,15 +224,15 @@ <h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after:
<td class="ToggleContentTable"><p class="p_Text"><span class="f_Text">SAM uses the information in the energy rate table and weekday and weekend schedules to calculate the energy charge portion of each month's electricity bill based on the quantity of electricity delivered to the load from the grid over the month.</span></p>
<h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after: avoid; border-top: none; border-right: none; border-left: none;"><span class="f_Heading3_atocs_">Energy Rate Table</span></h3>
<p class="p_Text"><span class="f_Text">The energy rate table is where you define the energy rate structure that SAM uses to calculate the energy charge portion of the monthly electricity bill.</span></p>
<p class="p_Text"><span class="f_Text">Each row in the table defines the rates and tier limit for one period and tier. You can define up to 12 time-of-use periods and 12 tiers.</span></p>
<p class="p_Text"><span class="f_Text">Each row in the table defines the rates and tier limit for one period and tier. You can define up to 36 time-of-use periods and 12 tiers.</span></p>
<p class="p_Note"><span class="f_CHNote">Tip.</span><span class="f_Note"> It may be easier to create and modify a complex rate table in a text editor or spreadsheet program than in the table. You can use the </span><span class="f_CHInterfaceElement">Import</span><span class="f_Note"> and </span><span class="f_CHInterfaceElement">Export</span><span class="f_Note"> buttons to work with the data as comma-separated text outside of SAM. To see what the data format looks like, create a table in SAM and export it to a text file.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Number of entries</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">The total number of energy rates in the structure, equal to the product of the number of time-of-use periods and tiers. The number of rows in the table is equal to the number of entries. When you change the number of entries, SAM changes the number of rows in the table.</span></p>
<p class="p_Note"><span class="f_CHNote">Note.</span><span class="f_Note"> If you change the number of entries to a smaller number, you will lose data in the rows when SAM resizes the table.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Period (1-12)</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">Each period number represents a time-of-use period for energy charges. For example, for a simple rate structure with one summer period and one period, you could assign Period 1 to the summer months and Period 2 to the winter months. The time-of-use period must be a number between 1 and 12 and each period must be associated with a time defined by the <a href="weekday-schedule.htm" class="topiclink">weekday and weekend schedules</a>.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Period (1-36)</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">Each period number represents a time-of-use period for energy charges. For example, for a simple rate structure with one summer period and one period, you could assign Period 1 to the summer months and Period 2 to the winter months. The time-of-use period must be a number between 1 and 36 and each period must be associated with a time defined by the <a href="weekday-schedule.htm" class="topiclink">weekday and weekend schedules</a>.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Tier</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">For each time-of-use period, you can define one or more tiers. Each tier is defined by a maximum usage, buy rate, and optional sell rate.</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">For each time-of-use period, you can define one or more tiers, up to 12 tiers. Each tier is defined by a maximum usage, buy rate, and optional sell rate.</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">SAM accumulates tiers on a monthly basis, so any period that occurs in a given month must have the same number of tiers. For example, in the weekday schedule if the row for March contains Periods 2, 3, and 6, then those three periods must have the same number of tiers.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Max. Usage</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">For rate structures with tiered rates, the maximum usage is the maximum cumulative consumption over the time-of-use period in the month for which the tier's rates apply.</span></p>
Expand All @@ -247,8 +247,11 @@ <h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after:
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Sell ($/kWh)</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">The price paid to the project in dollars per kilowatt-hour by the electric service provider for electricity delivered to the grid for each period and tier.</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">Sell rates are not available for the Net Energy Billing metering option that treats excess generation as a reduction in kWh consumed instead of a dollar amount.</span></p>
<h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after: avoid; border-top: none; border-right: none; border-left: none;"><span class="f_Heading3_atocs_">Weekday and Weekend Schedules</span></h3>
<p class="p_Text"><span class="f_Text">The Weekday and Weekend schedules determine the time of day and time of year for each time-of-use period you define in the energy rates table. For each time-of-use period in the energy rate table, select a rectangle in the weekday or weekend schedule that represents the period and type the period number. For example, if Period 1 represents a summer rate, and the summer months are June through August, select all of the squares in the </span><span class="f_CHInterfaceElement">Jun</span><span class="f_Text">, </span><span class="f_CHInterfaceElement">Jul</span><span class="f_Text">, and </span><span class="f_CHInterfaceElement">Aug</span><span class="f_Text"> rows type the number 1 on your keyboard. See <a href="weekday-schedule.htm" class="topiclink">Weekday Weekend Schedules</a> for detailed instructions.</span></p>
<h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after: avoid; border-top: none; border-right: none; border-left: none;"><span class="f_Heading3_atocs_">Weekday and Weekend Schedules for Energy Charges</span></h3>
<p class="p_Text"><span class="f_Text">The Weekday and Weekend schedules determine the time of day and time of year for each time-of-use period you define in the energy rates table.</span></p>
<p class="p_Text"><span class="f_Text">For each time-of-use period in the energy rate table, select a rectangle in the weekday or weekend schedule that represents the period and type a period number 1-9, a 0 for Period 10, or a letter a-z for Periods 11 through 36.</span></p>
<p class="p_Text"><span class="f_Text">For example, if Period 1 represents a summer rate, and the summer months are June through August, select all of the squares in the </span><span class="f_CHInterfaceElement">Jun</span><span class="f_Text">, </span><span class="f_CHInterfaceElement">Jul</span><span class="f_Text">, and </span><span class="f_CHInterfaceElement">Aug</span><span class="f_Text"> rows type the number 1 on your keyboard. </span></p>
<p class="p_Text"><span class="f_Text">See <a href="weekday-schedule.htm" class="topiclink">Weekday Weekend Schedules</a> for detailed instructions.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Weekday</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">The time-of-day and month-of-year matrix that assigns a period representing set of time-of-use rates to the five working days of the week. For electricity bill calculations, SAM assumes that weekdays are Monday through Friday and that the year begins on Monday, January 1, in the hour ending at 1:00 am.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Weekend</span></p>
Expand Down Expand Up @@ -356,6 +359,15 @@ <h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after:
<p class="p_VariableDescription"><span class="f_VariableDescription">The peak demand for the tier and period.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Charge ($/kW)</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">The demand rate that applies to the tier and period.</span></p>
<h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after: avoid; border-top: none; border-right: none; border-left: none;"><span class="f_Heading3_atocs_">Weekday and Weekend Schedules for Demand Charges</span></h3>
<p class="p_Text"><span class="f_Text">The Weekday and Weekend schedules determine the time of day and time of year for each time-of-use period you define in the Demand Rates by Time-of-use Period and/or Tiers table.</span></p>
<p class="p_Text"><span class="f_Text">For each time-of-use period in the table, select a rectangle in the weekday or weekend schedule that represents the period and type a period number 1-9, or 0=10, a=11, b=12.</span></p>
<p class="p_Text"><span class="f_Text">For example, if Period 1 represents a summer rate, and the summer months are June through August, select all of the squares in the </span><span class="f_CHInterfaceElement">Jun</span><span class="f_Text">, </span><span class="f_CHInterfaceElement">Jul</span><span class="f_Text">, and </span><span class="f_CHInterfaceElement">Aug</span><span class="f_Text"> rows type the number 1 on your keyboard. </span></p>
<p class="p_Text"><span class="f_Text">See <a href="weekday-schedule.htm" class="topiclink">Weekday Weekend Schedules</a> for detailed instructions.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Weekday</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">The time-of-day and month-of-year matrix that assigns a period representing set of time-of-use rates to the five working days of the week. For electricity bill calculations, SAM assumes that weekdays are Monday through Friday and that the year begins on Monday, January 1, in the hour ending at 1:00 am.</span></p>
<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Weekend</span></p>
<p class="p_VariableDescription"><span class="f_VariableDescription">The time-of-day and month-of-year matrix that assigns time-of-use periods to the two weekend days of the week: Saturday and Sunday.</span></p>
</td>
</tr>
</table>
Expand Down
Loading

0 comments on commit 7145371

Please sign in to comment.