Merge pull request #1413 from NREL/sam-help-patch-3

Help updates for SAM 2022.11.21 r3

deploy/runtime/help/html/battery_storage_btm.htm

@@ -344,8 +344,8 @@ <h4 class="p_Heading4"><span class="f_Heading4">Electrochemical Model</span></h4
 <p class="p_VariableDescription"><span class="f_VariableDescription">This parameter determines the shape of the voltage curve between the end of the nominal zone and 100% discharge.</span></p>
 <h4 class="p_Heading4"><span class="f_Heading4">Voltage Table</span></h4>
 <p class="p_Text"><span class="f_Text">The voltage table option defines the voltage curve using data from the voltage table. It can be used for any type of battery, but requires data not often provided on manufacturer data sheets.</span></p>
-<p class="p_Text"><span class="f_Text">SAM uses linear interpolation with an adjustment for cell internal resistance for cell voltage calculations during simulations.</span></p>
-<p class="p_Text"><span class="f_Text">The voltage table must contain at least two values, and must include cell voltage values less than and greater than the cell nominal voltage.</span></p>
+<p class="p_Text"><span class="f_Text">SAM uses linear interpolation with an adjustment for cell internal resistance for cell voltage calculations during simulations. Each row in the table must have a different voltage value.</span></p>
+<p class="p_Text"><span class="f_Text">The voltage table must contain at least two values, and must include cell voltage values less than and greater than the cell nominal voltage. </span></p>
 <p class="p_TitleProcedure" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_TitleProcedure">To use the voltage table to define the voltage curve:</span></p>
 <p class="p_ProcedureStep" style="text-indent: 0; padding-left: 24px; margin-left: 24px;"><span class="f_ProcedureStep" style="display:inline-block;width:24px;margin-left:-24px">1.</span><span class="f_ProcedureStep">Choose </span><span class="f_CHInterfaceElement">Voltage table</span><span class="f_ProcedureStep">.</span></p><p class="p_ProcedureStep" style="text-indent: 0; padding-left: 24px; margin-left: 24px;"><span class="f_ProcedureStep" style="display:inline-block;width:24px;margin-left:-24px">2.</span><span class="f_ProcedureStep">For </span><span class="f_CHInterfaceElement">Rows</span><span class="f_ProcedureStep">, type the number of pairs of voltage - depth of discharge pairs you want to use to define the voltage. The table will expand to the number of rows you type.</span></p><p class="p_ProcedureStepNoNumber"><span class="f_ProcedureStepNoNumber">You can also click Import to import data from a text file. Try clicking Export to create a template file to see what the text format should be.</span></p>
 <p class="p_ProcedureStepLast" style="text-indent: 0; padding-left: 24px; margin-left: 24px;"><span class="f_ProcedureStep" style="display:inline-block;width:24px;margin-left:-24px">3.</span><span class="f_ProcedureStepLast">Type values in the depth of discharge and cell voltage columns. The Voltage Discharge graph will update as you type.</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;"><a id="losses" class="hmanchor"></a><span class="f_Heading3_atocs_">Battery Losses</span></h3>

deploy/runtime/help/html/battery_storage_fom.htm

@@ -345,8 +345,8 @@ <h4 class="p_Heading4"><span class="f_Heading4">Electrochemical Model</span></h4
 <p class="p_VariableDescription"><span class="f_VariableDescription">This parameter determines the shape of the voltage curve between the end of the nominal zone and 100% discharge.</span></p>
 <h4 class="p_Heading4"><span class="f_Heading4">Voltage Table</span></h4>
 <p class="p_Text"><span class="f_Text">The voltage table option defines the voltage curve using data from the voltage table. It can be used for any type of battery, but requires data not often provided on manufacturer data sheets.</span></p>
-<p class="p_Text"><span class="f_Text">SAM uses linear interpolation with an adjustment for cell internal resistance for cell voltage calculations during simulations.</span></p>
-<p class="p_Text"><span class="f_Text">The voltage table must contain at least two values, and must include cell voltage values less than and greater than the cell nominal voltage.</span></p>
+<p class="p_Text"><span class="f_Text">SAM uses linear interpolation with an adjustment for cell internal resistance for cell voltage calculations during simulations. Each row in the table must have a different voltage value.</span></p>
+<p class="p_Text"><span class="f_Text">The voltage table must contain at least two values, and must include cell voltage values less than and greater than the cell nominal voltage. </span></p>
 <p class="p_TitleProcedure" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_TitleProcedure">To use the voltage table to define the voltage curve:</span></p>
 <p class="p_ProcedureStep" style="text-indent: 0; padding-left: 24px; margin-left: 24px;"><span class="f_ProcedureStep" style="display:inline-block;width:24px;margin-left:-24px">1.</span><span class="f_ProcedureStep">Choose </span><span class="f_CHInterfaceElement">Voltage table</span><span class="f_ProcedureStep">.</span></p><p class="p_ProcedureStep" style="text-indent: 0; padding-left: 24px; margin-left: 24px;"><span class="f_ProcedureStep" style="display:inline-block;width:24px;margin-left:-24px">2.</span><span class="f_ProcedureStep">For </span><span class="f_CHInterfaceElement">Rows</span><span class="f_ProcedureStep">, type the number of pairs of voltage - depth of discharge pairs you want to use to define the voltage. The table will expand to the number of rows you type.</span></p><p class="p_ProcedureStepNoNumber"><span class="f_ProcedureStepNoNumber">You can also click Import to import data from a text file. Try clicking Export to create a template file to see what the text format should be.</span></p>
 <p class="p_ProcedureStepLast" style="text-indent: 0; padding-left: 24px; margin-left: 24px;"><span class="f_ProcedureStep" style="display:inline-block;width:24px;margin-left:-24px">3.</span><span class="f_ProcedureStepLast">Type values in the depth of discharge and cell voltage columns. The Voltage Discharge graph will update as you type.</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;"><a id="losses" class="hmanchor"></a><span class="f_Heading3_atocs_">Battery Losses</span></h3>

deploy/runtime/help/html/default.css

@@ -30,7 +30,7 @@ span.f_CHInterfaceElement /* CH Interface Element */
 }
 span.f_CHNote /* CH Note */
 {
- text-decoration: bold;
+ text-decoration: underline;
 }
 span.f_CHUIElement /* CH UI Element */
 {

deploy/runtime/help/html/installation.htm

@@ -45,15 +45,15 @@ <h3 class="p_Heading3_atocs_" style="page-break-inside: avoid; page-break-after:
 <p class="p_Text"><span class="f_Text">Your SAM installation contains the SAM executable file and supporting files and folders. You may need to access the SAM installation to find resource data files, SAM libraries, or to <a href="installation.htm#removesam" class="topiclink">remove SAM</a> from your computer. Be careful not to modify, move, or delete any files in the folder unless you understand how SAM uses the file.</span></p>
 <p class="p_Text"><span class="f_Text">The SAM installation folder is the folder that contains the SAM executable and its supporting files:</span></p>
 <p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Windows</span></p>
-<p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">By default, the SAM installation is in </span><span class="f_CHFileName">c:\SAM\SAM 2022.11.21 r1</span><span class="f_VariableDescription">, although you can install SAM in any folder on your computer.</span></p><p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Mac</span></p>
-<p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">On a Mac, the SAM installation is the SAM application bundle, which is distributed on a disk image named </span><span class="f_CHFileName">sam-osx-2/22/2023.dmg</span><span class="f_VariableDescription">.</span></p><p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">SAM runs directly from the disk image, which can be in the Applications folder, desktop, or other folder on your computer.</span></p><p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">To open the application bundle, in Finder, control-click (or right-click) the SAM name and click </span><span class="f_CHInterfaceElement">Show Contents</span><span class="f_VariableDescription">. If SAM is in your Applications folder, command-click the name to open it in Finder.</span></p><p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Linux</span></p>
-<p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_CHFileName" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">In Linux, SAM installs by default in </span><span class="f_CHFileName">home/&lt;user&gt;/SAM/SAM 2022.11.21 r1, although you can install SAM in any folder on your computer.</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;"><a id="removesam" class="hmanchor"></a><span class="f_Heading3_atocs_">Removing SAM from your computer</span></h3>
+<p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">By default, the SAM installation is in </span><span class="f_CHFileName">c:\SAM\SAM 2022.11.21 r3</span><span class="f_VariableDescription">, although you can install SAM in any folder on your computer.</span></p><p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Mac</span></p>
+<p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">On a Mac, the SAM installation is the SAM application bundle, which is distributed on a disk image named </span><span class="f_CHFileName">sam-osx-6/2/2023.dmg</span><span class="f_VariableDescription">.</span></p><p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">SAM runs directly from the disk image, which can be in the Applications folder, desktop, or other folder on your computer.</span></p><p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">To open the application bundle, in Finder, control-click (or right-click) the SAM name and click </span><span class="f_CHInterfaceElement">Show Contents</span><span class="f_VariableDescription">. If SAM is in your Applications folder, command-click the name to open it in Finder.</span></p><p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Linux</span></p>
+<p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_CHFileName" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">In Linux, SAM installs by default in </span><span class="f_CHFileName">home/&lt;user&gt;/SAM/SAM 2022.11.21 r3, although you can install SAM in any folder on your computer.</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;"><a id="removesam" class="hmanchor"></a><span class="f_Heading3_atocs_">Removing SAM from your computer</span></h3>
 <p class="p_Text"><span class="f_Text">When you install a new version of SAM or no longer need the software, you can remove it from your computer:</span></p>
 <p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Windows</span></p>
 <p class="p_VariableDescription" style="text-indent: 0; padding-left: 20px; margin-left: 24px;"><span class="f_VariableDescription" style="display:inline-block;width:20px;margin-left:-20px">1.</span><span class="f_VariableDescription">In the Windows Control Panel, under </span><span class="f_CHInterfaceElement">Programs</span><span class="f_VariableDescription">, click </span><span class="f_CHInterfaceElement">Uninstall a Program</span><span class="f_VariableDescription"> (</span><span class="f_CHFileName">Control Panel\Programs\Programs and Features</span><span class="f_VariableDescription">), and select the SAM version you want to uninstall from the list. The SAM program is listed as SAM &lt;version number&gt;.</span></p><p class="p_VariableDescription" style="text-indent: 0; padding-left: 20px; margin-left: 24px;"><span class="f_VariableDescription" style="display:inline-block;width:20px;margin-left:-20px">2.</span><span class="f_VariableDescription">Click </span><span class="f_CHInterfaceElement">Uninstall</span><span class="f_VariableDescription">.</span></p><p class="p_Note"><span class="f_CHNote">Note.</span><span class="f_Note"> Any files in the <a href="installation.htm#installationfolder" class="topiclink">SAM installation folder</a> that you added or modified are not removed by the uninstall process. You can safely delete the folder if you do not need those files.</span></p>
 <p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Mac</span></p>
 <p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">Drag the SAM application bundle to the Trash.</span></p><p class="p_VariableName" style="page-break-inside: avoid; page-break-after: avoid;"><span class="f_VariableName">Linux</span></p>
-<p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">Open a terminal window and run </span><span class="f_VariableDescription" style="font-style: italic;">rm -rf /path/to/SAM/SAM 2022.11.21 r1</span><span class="f_VariableDescription">.</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_">Running multiple versions of SAM</span></h3>
+<p class="p_VariableDescription" style="text-indent: 0; padding-left: 13px; margin-left: 24px;"><span class="f_VariableDescription" style="font-family: Arial,'Lucida Sans Unicode','Lucida Grande','Lucida Sans';display:inline-block;width:13px;margin-left:-13px">&#8226;</span><span class="f_VariableDescription">Open a terminal window and run </span><span class="f_VariableDescription" style="font-style: italic;">rm -rf /path/to/SAM/SAM 2022.11.21 r3</span><span class="f_VariableDescription">.</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_">Running multiple versions of SAM</span></h3>
 <p class="p_Text"><span class="f_Text">You can keep different versions of SAM installed on your computer and run them simultaneously as separate pieces of software. When you install a new version of SAM, unless you install it in the same folder as another version of SAM, it installs as a separate installation. You may want to keep multiple versions of SAM on your computer to compare results between versions or if your work with SAM requires that you use a specific version.</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_">Installing SAM in a laboratory environment</span></h3>
 <p class="p_Text"><span class="f_Text">If you are installing SAM on more than one computer in a teaching laboratory or other setting, please <a href="mailto:[email protected]?subject=SAM%20HELP:%20Registration%20in%20laboratory%20environment" class="weblink" title="[email protected]">email us</a> for instructions to register the entire laboratory with a single key.</span></p>