Updated users guide

lbl-srg · Sep 5, 2023 · 3635e7f · 3635e7f
1 parent 91b966a
commit 3635e7f
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 10 deletions.
diff --git a/...dings/Resources/Documentation/userGuide/build/html/_sources/development.rst.txt b/...dings/Resources/Documentation/userGuide/build/html/_sources/development.rst.txt
@@ -537,7 +537,7 @@ The following rules need to be followed, in addition to the guidelines described
        but prioritize groupings based on model specific similarities.
 
 #. Each block must have a ``defaultComponentName`` annotation and a ``%name`` label placed above the icon.
-   See for example the `CDL.Logical.Sources.Constant <https://github.com/lbl-srg/modelica-buildings/blob/f2bb4670f66b6385b3081fc1fcd70e6c6a131323/Buildings/Controls/OBC/CDL/Logical/Sources/Constant.mo#L13>`_
+   See for example line 13 in the `CDL.Logical.Sources.Constant <https://github.com/lbl-srg/modelica-buildings/blob/f2bb4670f66b6385b3081fc1fcd70e6c6a131323/Buildings/Controls/OBC/CDL/Logical/Sources/Constant.mo>`_
    block.
 
 #. To aid readability, the formatting of the Modelica source code file must be consistent with other

diff --git a/...gs/Resources/Documentation/userGuide/build/html/_sources/gettingStarted.rst.txt b/...gs/Resources/Documentation/userGuide/build/html/_sources/gettingStarted.rst.txt
@@ -19,7 +19,7 @@ Although the `Modelica Language Tutorial <https://modelica.org/documents/Modelic
 Links to papers that describe or used the `Buildings` library are available at https://simulationresearch.lbl.gov/modelica/publications.html.
 The model documentation from the download page contains user guides that describe the individual packages of the `Buildings` library.
 
-The `IEA EBC Annex 60 <http://www.iea-annex60.org/final-report.html>`_ final report
+The `IEA EBC Annex 60 <https://www.iea-annex60.org/final-report.html>`_ final report
 summarizes the development of Modelica models, approaches and tools
 for co-simulation based on the Functional Mockup Interface standard,
 Building Information Modeling technologies based on the Industry Foundation Classes,

diff --git a/...dings/Resources/Documentation/userGuide/build/html/_sources/performance.rst.txt b/...dings/Resources/Documentation/userGuide/build/html/_sources/performance.rst.txt
@@ -27,7 +27,7 @@ helpful to log which state variables dominate the integration error
 or the integrator time step control.
 This usually points to the control loop that is unstable.
 There are various methods for tuning a controller, and the documentation of
-`Buildings.Controls.OBC.CDL.Reals.PIDWithReset <https://simulationresearch.lbl.gov/modelica/releases/v10.0.0/help/Buildings_Controls_OBC_CDL_Continuous.html#Buildings.Controls.OBC.CDL.Reals.PIDWithReset>`_
+`Buildings.Controls.OBC.CDL.Reals.PIDWithReset <https://simulationresearch.lbl.gov/modelica/releases/v10.0.0/help/Buildings_Controls_OBC_CDL_Reals.html#Buildings.Controls.OBC.CDL.Reals.PIDWithReset>`_
 outlines one approach for tuning the gains of a PI-controller.
 
 

diff --git a/Buildings/Resources/Documentation/userGuide/build/html/development.html b/Buildings/Resources/Documentation/userGuide/build/html/development.html
@@ -669,7 +669,7 @@ <h3><span class="section-number">5.4.3. </span>Control sequences using the Contr
 </div></blockquote>
 </li>
 <li><p>Each block must have a <code class="docutils literal notranslate"><span class="pre">defaultComponentName</span></code> annotation and a <code class="docutils literal notranslate"><span class="pre">%name</span></code> label placed above the icon.
-See for example the <a class="reference external" href="https://github.com/lbl-srg/modelica-buildings/blob/f2bb4670f66b6385b3081fc1fcd70e6c6a131323/Buildings/Controls/OBC/CDL/Logical/Sources/Constant.mo#L13">CDL.Logical.Sources.Constant</a>
+See for example line 13 in the <a class="reference external" href="https://github.com/lbl-srg/modelica-buildings/blob/f2bb4670f66b6385b3081fc1fcd70e6c6a131323/Buildings/Controls/OBC/CDL/Logical/Sources/Constant.mo">CDL.Logical.Sources.Constant</a>
 block.</p></li>
 <li><p>To aid readability, the formatting of the Modelica source code file must be consistent with other
 implemented blocks, e.g., use two spaces for indentation (no tabulators),

diff --git a/Buildings/Resources/Documentation/userGuide/build/html/gettingStarted.html b/Buildings/Resources/Documentation/userGuide/build/html/gettingStarted.html
@@ -181,7 +181,7 @@ <h2><span class="section-number">1.1. </span>Literature for Users<a class="heade
 <p>Although the <a class="reference external" href="https://modelica.org/documents/ModelicaTutorial14.pdf">Modelica Language Tutorial</a> is for an older version (Modelica 1.4), it is still instructive and relevant to understand the concepts of the language.</p>
 <p>Links to papers that describe or used the <cite>Buildings</cite> library are available at <a class="reference external" href="https://simulationresearch.lbl.gov/modelica/publications.html">https://simulationresearch.lbl.gov/modelica/publications.html</a>.
 The model documentation from the download page contains user guides that describe the individual packages of the <cite>Buildings</cite> library.</p>
-<p>The <a class="reference external" href="http://www.iea-annex60.org/final-report.html">IEA EBC Annex 60</a> final report
+<p>The <a class="reference external" href="https://www.iea-annex60.org/final-report.html">IEA EBC Annex 60</a> final report
 summarizes the development of Modelica models, approaches and tools
 for co-simulation based on the Functional Mockup Interface standard,
 Building Information Modeling technologies based on the Industry Foundation Classes,

diff --git a/Buildings/Resources/Documentation/userGuide/build/html/performance.html b/Buildings/Resources/Documentation/userGuide/build/html/performance.html
@@ -202,7 +202,7 @@ <h2><span class="section-number">3.1. </span>Unstable control loops<a class="hea
 or the integrator time step control.
 This usually points to the control loop that is unstable.
 There are various methods for tuning a controller, and the documentation of
-<a class="reference external" href="https://simulationresearch.lbl.gov/modelica/releases/v10.0.0/help/Buildings_Controls_OBC_CDL_Continuous.html#Buildings.Controls.OBC.CDL.Reals.PIDWithReset">Buildings.Controls.OBC.CDL.Reals.PIDWithReset</a>
+<a class="reference external" href="https://simulationresearch.lbl.gov/modelica/releases/v10.0.0/help/Buildings_Controls_OBC_CDL_Reals.html#Buildings.Controls.OBC.CDL.Reals.PIDWithReset">Buildings.Controls.OBC.CDL.Reals.PIDWithReset</a>
 outlines one approach for tuning the gains of a PI-controller.</p>
 </section>
 <section id="control-input-signal-of-equipment">

diff --git a/Buildings/Resources/Documentation/userGuide/build/html/searchindex.js b/Buildings/Resources/Documentation/userGuide/build/html/searchindex.js
diff --git a/Buildings/Resources/Documentation/userGuide/source/development.rst b/Buildings/Resources/Documentation/userGuide/source/development.rst
@@ -537,7 +537,7 @@ The following rules need to be followed, in addition to the guidelines described
        but prioritize groupings based on model specific similarities.
 
 #. Each block must have a ``defaultComponentName`` annotation and a ``%name`` label placed above the icon.
-   See for example the `CDL.Logical.Sources.Constant <https://github.com/lbl-srg/modelica-buildings/blob/f2bb4670f66b6385b3081fc1fcd70e6c6a131323/Buildings/Controls/OBC/CDL/Logical/Sources/Constant.mo#L13>`_
+   See for example line 13 in the `CDL.Logical.Sources.Constant <https://github.com/lbl-srg/modelica-buildings/blob/f2bb4670f66b6385b3081fc1fcd70e6c6a131323/Buildings/Controls/OBC/CDL/Logical/Sources/Constant.mo>`_
    block.
 
 #. To aid readability, the formatting of the Modelica source code file must be consistent with other

diff --git a/Buildings/Resources/Documentation/userGuide/source/gettingStarted.rst b/Buildings/Resources/Documentation/userGuide/source/gettingStarted.rst
@@ -19,7 +19,7 @@ Although the `Modelica Language Tutorial <https://modelica.org/documents/Modelic
 Links to papers that describe or used the `Buildings` library are available at https://simulationresearch.lbl.gov/modelica/publications.html.
 The model documentation from the download page contains user guides that describe the individual packages of the `Buildings` library.
 
-The `IEA EBC Annex 60 <http://www.iea-annex60.org/final-report.html>`_ final report
+The `IEA EBC Annex 60 <https://www.iea-annex60.org/final-report.html>`_ final report
 summarizes the development of Modelica models, approaches and tools
 for co-simulation based on the Functional Mockup Interface standard,
 Building Information Modeling technologies based on the Industry Foundation Classes,

diff --git a/Buildings/Resources/Documentation/userGuide/source/performance.rst b/Buildings/Resources/Documentation/userGuide/source/performance.rst
@@ -27,7 +27,7 @@ helpful to log which state variables dominate the integration error
 or the integrator time step control.
 This usually points to the control loop that is unstable.
 There are various methods for tuning a controller, and the documentation of
-`Buildings.Controls.OBC.CDL.Reals.PIDWithReset <https://simulationresearch.lbl.gov/modelica/releases/v10.0.0/help/Buildings_Controls_OBC_CDL_Continuous.html#Buildings.Controls.OBC.CDL.Reals.PIDWithReset>`_
+`Buildings.Controls.OBC.CDL.Reals.PIDWithReset <https://simulationresearch.lbl.gov/modelica/releases/v10.0.0/help/Buildings_Controls_OBC_CDL_Reals.html#Buildings.Controls.OBC.CDL.Reals.PIDWithReset>`_
 outlines one approach for tuning the gains of a PI-controller.