Loss adjustment widget fixes (#1408)

* Add properties to example widgets for testing

* Revise label text for lifetime data widgets

* Revise default text for loss adjustment widget

* Make default text match text in widget implementation to make it less confusing for UI developers

* Clean up loss adjustment widget

* Automatically set descriptive text based on context
* Change "hourly" to "time series" in labels
* Add text describing how total loss is combined from constant, time series, custom periods
* Delete old commented-out code
* Change text that appears on UI form to not show average time series loss to avoid confusion

* Help revisions for adjustment factors

deploy/runtime/help/html/battery_results.htm

@@ -317,23 +317,23 @@ <h4 class="p_Heading4"><span class="f_Heading4">Lifetime Data</span></h4>
 </td>
 <td class="DefaultShadedRows" style="width:54px;"><p class="p_TableTextCenter" style="page-break-inside: avoid;"><span class="f_TableTextCenter">kWac</span></p>
 </td>
-<td class="DefaultShadedRows"><p class="p_TableTextLeft" style="page-break-inside: avoid;"><span class="f_TableTextLeft">For AC-connected PV-battery systems, AC power discharged to power generating system parasitic loads from the battery. For DC-connected systems, the inverter shuts off when the PV array is not generating power, so the battery cannot discharge to the AC side of the inverter.</span></p>
+<td class="DefaultShadedRows"><p class="p_TableTextLeft" style="page-break-inside: avoid;"><span class="f_TableTextLeft">For AC-connected PV-battery systems, AC power discharged from the battery to the power generating system parasitic loads. For DC-connected systems, the inverter shuts off when the PV array is not generating power, so the battery cannot discharge to the AC side of the inverter.</span></p>
 </td>
 </tr>
 <tr class="DefaultShadedRows">
 <td class="DefaultShadedRows" style="width:285px; background-color:#C0C0C0;"><p class="p_TableTextLeft" style="page-break-inside: avoid;"><span class="f_TableTextLeft">Electricity to/from battery AC</span></p>
 </td>
 <td class="DefaultShadedRows" style="width:54px; background-color:#C0C0C0;"><p class="p_TableTextCenter" style="page-break-inside: avoid;"><span class="f_TableTextCenter">kWac</span></p>
 </td>
-<td class="DefaultShadedRows" style="background-color:#C0C0C0;"><p class="p_TableTextLeft" style="page-break-inside: avoid;"><span class="f_TableTextLeft">Power delivered to the battery (positive) from the grid and/or power generating system, and power delivered to the load and/or grid (negative) from the battery. Measured on the AC side of the inverter, before AC losses.</span></p>
+<td class="DefaultShadedRows" style="background-color:#C0C0C0;"><p class="p_TableTextLeft" style="page-break-inside: avoid;"><span class="f_TableTextLeft">Power discharged from the battery (positive) to the load or grid, and power to charge the battery (negative) from the grid and/or power generating system. Measured on the AC side of the inverter, before AC losses.</span></p>
 </td>
 </tr>
 <tr class="DefaultShadedRows">
 <td class="DefaultShadedRows" style="width:285px;"><p class="p_TableTextLeft" style="page-break-inside: avoid;"><span class="f_TableTextLeft">Electricity to/from battery DC</span></p>
 </td>
 <td class="DefaultShadedRows" style="width:54px;"><p class="p_TableTextCenter" style="page-break-inside: avoid;"><span class="f_TableTextCenter">kWdc</span></p>
 </td>
-<td class="DefaultShadedRows"><p class="p_TableTextLeft" style="page-break-inside: avoid;"><span class="f_TableTextLeft">Power delivered to the battery (positive) from the grid and/or power generating system, and power delivered to the load and/or grid (negative) from the battery. Measured on the DC side of the inverter or battery management system.</span></p>
+<td class="DefaultShadedRows"><p class="p_TableTextLeft" style="page-break-inside: avoid;"><span class="f_TableTextLeft">Power discharged from the battery (positive) to the load or grid, and power to charge the battery (negative) from the grid and/or power generating system. Measured on the DC side of the inverter or battery management system.</span></p>
 </td>
 </tr>
 <tr class="DefaultShadedRows">

deploy/runtime/help/html/edit_losses.htm

@@ -38,17 +38,18 @@ <h1 class="p_Heading1"><span class="f_Heading1">Edit Losses</span></h1>
 
 <!-- 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">The Edit Losses window allows you to define losses that apply to the system's power output in each hour:</span></p>
-<p class="p_List" style="text-indent: 0; padding-left: 24px; margin-left: 24px;"><span class="f_List" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:24px;margin-left:-24px">&#8226;</span><span class="f_List">Constant loss is a single loss that applies to the system's entire output.</span></p><p class="p_ListLast" style="text-indent: 0; padding-left: 24px; margin-left: 24px;"><span class="f_List" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:24px;margin-left:-24px">&#8226;</span><span class="f_ListLast">Hourly losses apply to specific hours of the year.</span></p><p class="p_Text"><span class="f_Text">SAM reduces the system's output in each hour step by the percentage you specify for that hour. For a given hour, a loss of zero would result in no adjustment. A loss of 5% would reduce the output by 5%, and a loss of -5% would increase the output value by 5%. For subhourly simulations, SAM applies the percentage for a given hour to each time step in that hour.</span></p>
+<p class="p_Text"><span class="f_Text">The Edit Losses window allows you to define losses in the system.</span></p>
+<p class="p_List" style="text-indent: 0; padding-left: 24px; margin-left: 24px;"><span class="f_List" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:24px;margin-left:-24px">&#8226;</span><span class="f_List">Constant loss is a single loss that applies to all simulation time steps.</span></p><p class="p_ListLast" style="text-indent: 0; padding-left: 24px; margin-left: 24px;"><span class="f_List" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:24px;margin-left:-24px">&#8226;</span><span class="f_ListLast">Time series losses apply to specific time steps.</span></p><p class="p_Text"><span class="f_Text">SAM applies the loss percentages to each applicable simulation time step as appropriate. For a given time step, a loss of zero would result in no adjustment. A loss of 5% would result in a reduction of 5%, while a loss of -5% would result in an increase of 5%.</span></p>
+<p class="p_Note"><span class="f_CHNote">Note.</span><span class="f_Note"> SAM applies all losses that apply to a given time step. If the constant loss is not zero, and both a time series loss and custom period loss apply to the same time step, all three losses would apply to that time step. For example, if you specify a constant loss of 5%, time series losses in hourly mode of 2% for Hours 745-468, and custom period losses of 25% for the first seven days in February, and the loss is being applied to a value of 455 for February 1 at 11:00 am, the value after losses would be 455 × ( 1 - 0.05 ) × ( 1 - 0.02 ) × ( 1 - 0.25 ) = 317.7.</span></p>
 <p class="p_Text" style="text-align: center;"><img alt="SS_Hourly_Factors" width="600" height="318" style="margin:0 auto 0 auto;width:600px;height:318px;border:none" src="ss_hourly_factors.png"/></p>
 <p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Constant loss</span></p>
-<p class="p_VariableDescription"><span class="f_VariableDescription">SAM reduces the hourly power output value for each time step by the percentage that you specify, which effectively reduces the system's total annual output by that amount.</span></p>
-<p class="p_VariableDescription"><span class="f_VariableDescription">For example, a loss of 5% for a system with a net annual output of 100,000 kWh results in a delivered electrical output of 95,000 kWh.</span></p>
-<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Enable hourly losses</span></p>
-<p class="p_VariableDescription"><span class="f_VariableDescription">Check the box when you have a table of 8,760 loss values. Click </span><span class="f_CHInterfaceElement">Edit data</span><span class="f_VariableDescription">, and either cut and paste a column of 8,760 values into the table, or import a text file with a header row (column label) in the first row followed by 8,760 rows of loss values. The first row of data applies to the hour beginning at 12 a.m. on January 1.</span></p>
-<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Enable hourly losses with custom periods</span></p>
-<p class="p_VariableDescription"><span class="f_VariableDescription">Check the box when you want to apply losses to specific time periods. Choose a month, date, and time for the start time and end time, and specify a loss for that period. Click </span><span class="f_CHInterfaceElement">Add period</span><span class="f_VariableDescription"> to specify more than one time period. In the example above, the system's output is reduced by 5% between 12:15 am April 1 and 11:30 pm April 7. The system's output is reduced by 2% starting at 8 a.m. September 15 and ending at 6 p.m. September 20.</span></p>
-<p class="p_Note"><span class="f_CHNote">Note.</span><span class="f_VariableDescription"> </span><span class="f_Note">If you use combinations of loss values, SAM combines them to calculate the total loss in each time step. For example, if you specify a constant loss of 5% and hourly losses of 25% for the first seven days in February, and the system's output at 7 a.m. on February 1 is 455 kW, the output after losses would be 455 kW × ( 1 - 0.05 ) × ( 1 - 0.25 ) = 324 kW.</span></p>
+<p class="p_VariableDescription"><span class="f_VariableDescription">A loss that applies to all simulation time steps.</span></p>
+<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Enable time series losses</span></p>
+<p class="p_VariableDescription"><span class="f_VariableDescription">Check the box to enable losses by time step. Click </span><span class="f_CHInterfaceElement">Edit time series losses</span><span class="f_VariableDescription"> to open the <a href="edit_data_lifetime.htm" class="topiclink">Edit Lifetime Data</a> window, and use the table in the window to specify the losses.</span></p>
+<p class="p_VariableDescription"><span class="f_VariableDescription">The check box allows you to enable and disable time series losses without deleting the data in the loss table.</span></p>
+<p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Enable time series losses with custom periods</span></p>
+<p class="p_VariableDescription"><span class="f_VariableDescription">Check the box when you want to apply losses to specific time periods. Choose a date and time for the start time and end time, and specify a loss for that period. Click </span><span class="f_CHInterfaceElement">Add period</span><span class="f_VariableDescription"> to specify more than one time period. In the example above, a 5% loss applies from April 1 12:15 pm to April 7 11:30 pm, and a 2% loss applies from September 15 8:30 am to September 20 5:00 pm.</span></p>
+<p class="p_VariableDescription"><span class="f_VariableDescription">The check box allows you to enable custom period losses without deleting the loss schedule. </span></p>
 
 </td></tr></table>
 

deploy/runtime/help/html/electricity_rates.htm

@@ -179,9 +179,11 @@ <h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after:
 <td class="ToggleContentTable"><p class="p_Text"><span class="f_Text">Minimum charges apply when either the monthly or annual electricity bill falls below a minimum value.</span></p>
 <p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Monthly minimum charge, $</span></p>
 <p class="p_VariableDescription"><span class="f_VariableDescription">If the monthly electricity bill with system for a given month is less than the monthly minimum, the bill for that month is the monthly minimum charge.</span></p>
+<p class="p_VariableDescription"><span class="f_Note">If the monthly bill is negative due to the value of excess generation, the monthly minimum charge decreases the value of excess generation. SAM does not force the negative bill amount to the minimum charge.</span></p>
 <p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Annual minimum charge, $</span></p>
 <p class="p_VariableDescription"><span class="f_VariableDescription">The minimum annual charge for Year 1. If the annual electricity bill with system for Year 1 is less than the minimum value, SAM sets the Year 1 annual bill to the minimum value. For the purposes of the annual minimum charge, the year starts January 1 and ends December 31. The annual minimum charge does not affect the monthly electricity bill.</span></p>
-<p class="p_Note"><span class="f_CHNote">Note.</span><span class="f_Note"> Like all of the dollar values on the Electricity Rates page, the minimum charge amounts are Year 1 values. If you apply an annual minimum charge, the monthly electricity bill with system data shown in the <a href="utility_bill_results.htm" class="topiclink">Results</a> does not reflect the annual minimum charge.</span></p>
+<p class="p_VariableDescription"><span class="f_Note">If the annual bill is negative due to the value of excess generation, the annual minimum charge decreases the value of excess generation. SAM does not force the negative bill amount to the minimum charge.</span></p>
+<p class="p_Note"><span class="f_CHNote">Note. </span><span class="f_Note">Like all of the dollar values on the Electricity Rates page, the minimum charge amounts are Year 1 values. If you apply an annual minimum charge, the monthly electricity bill with system data shown in the <a href="utility_bill_results.htm" class="topiclink">Results</a> does not reflect the annual minimum charge.</span></p>
 </td>
 </tr>
 </table>

deploy/runtime/help/html/fin_all_equity_partnership.htm

@@ -203,7 +203,7 @@ <h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after:
 <h4 class="p_Heading4"><span class="f_Heading4">Major Equipment Replacement Reserve Accounts</span></h4>
 <p class="p_Text"><span class="f_Text">Major equipment replacement reserves are funds that the project sets aside to cover the cost of replacing equipment during the analysis period. You can specify up to three replacement reserve accounts.</span></p>
 <p class="p_Text"><span class="f_Text">SAM assumes that the cost of each major equipment replacement is capitalized rather than expensed. You can specify a depreciation schedule for each the major equipment replacement cost.</span></p>
-<p class="p_Text"><span class="f_Text">SAM calculates the inflation-adjusted cost of each major equipment replacement and funds a reserve account in each of the replacement cycle. At the time of each major equipment replacement, funds are released from the reserve account in an amount sufficient to cover the expense.</span></p>
+<p class="p_Text"><span class="f_Text">SAM calculates the inflation-adjusted cost of each major equipment replacement and funds a reserve account in each replacement cycle. At the time of each major equipment replacement, funds are released from the reserve account in an amount sufficient to cover the cost.</span></p>
 <p class="p_Note"><span class="f_CHNote">Note.</span><span class="f_Note"> In SAM, equipment replacement reserve funding is separate from the operating costs that you specify on the <a href="operating_costs.htm" class="topiclink">Operating Costs</a> page.</span></p>
 <p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Account Name</span></p>
 <p class="p_VariableDescription"><span class="f_VariableDescription">The name of the reserve account for your reference. SAM reports value associated with each account in the cash flow and other graphs and tables using the name Reserve Account 1, 2, and 3, regardless of the name you enter.</span></p>

deploy/runtime/help/html/fin_leveraged_partnership.htm

@@ -241,7 +241,7 @@ <h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after:
 <h4 class="p_Heading4"><span class="f_Heading4">Major Equipment Replacement Reserve Accounts</span></h4>
 <p class="p_Text"><span class="f_Text">Major equipment replacement reserves are funds that the project sets aside to cover the cost of replacing equipment during the analysis period. You can specify up to three replacement reserve accounts.</span></p>
 <p class="p_Text"><span class="f_Text">SAM assumes that the cost of each major equipment replacement is capitalized rather than expensed. You can specify a depreciation schedule for each the major equipment replacement cost.</span></p>
-<p class="p_Text"><span class="f_Text">SAM calculates the inflation-adjusted cost of each major equipment replacement and funds a reserve account in each of the replacement cycle. At the time of each major equipment replacement, funds are released from the reserve account in an amount sufficient to cover the expense.</span></p>
+<p class="p_Text"><span class="f_Text">SAM calculates the inflation-adjusted cost of each major equipment replacement and funds a reserve account in each replacement cycle. At the time of each major equipment replacement, funds are released from the reserve account in an amount sufficient to cover the cost.</span></p>
 <p class="p_Note"><span class="f_CHNote">Note.</span><span class="f_Note"> In SAM, equipment replacement reserve funding is separate from the operating costs that you specify on the <a href="operating_costs.htm" class="topiclink">Operating Costs</a> page.</span></p>
 <p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Account Name</span></p>
 <p class="p_VariableDescription"><span class="f_VariableDescription">The name of the reserve account for your reference. SAM reports value associated with each account in the cash flow and other graphs and tables using the name Reserve Account 1, 2, and 3, regardless of the name you enter.</span></p>

deploy/runtime/help/html/fin_merchant_plant.htm

@@ -196,7 +196,7 @@ <h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after:
 <h4 class="p_Heading4"><span class="f_Heading4">Major Equipment Replacement Reserve Accounts</span></h4>
 <p class="p_Text"><span class="f_Text">Major equipment replacement reserves are funds that the project sets aside to cover the cost of replacing equipment during the analysis period. You can specify up to three replacement reserve accounts.</span></p>
 <p class="p_Text"><span class="f_Text">SAM assumes that the cost of each major equipment replacement is capitalized rather than expensed. You can specify a depreciation schedule for each the major equipment replacement cost.</span></p>
-<p class="p_Text"><span class="f_Text">SAM calculates the inflation-adjusted cost of each major equipment replacement and funds a reserve account in each of the replacement cycle. At the time of each major equipment replacement, funds are released from the reserve account in an amount sufficient to cover the expense.</span></p>
+<p class="p_Text"><span class="f_Text">SAM calculates the inflation-adjusted cost of each major equipment replacement and funds a reserve account in each replacement cycle. At the time of each major equipment replacement, funds are released from the reserve account in an amount sufficient to cover the cost.</span></p>
 <p class="p_Note"><span class="f_CHNote">Note.</span><span class="f_Note"> In SAM, equipment replacement reserve funding is separate from the operating costs that you specify on the <a href="operating_costs.htm" class="topiclink">Operating Costs</a> page.</span></p>
 <p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Account Name</span></p>
 <p class="p_VariableDescription"><span class="f_VariableDescription">The name of the reserve account for your reference. SAM reports value associated with each account in the cash flow and other graphs and tables using the name Reserve Account 1, 2, and 3, regardless of the name you enter.</span></p>