Skip to content

Commit

Permalink
Added link to Spawn user guide in getting started (#2603)
Browse files Browse the repository at this point in the history
* Added link to Spawn user guide in getting started
  • Loading branch information
mwetter authored Sep 8, 2021
1 parent 714889c commit bbee276
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,18 @@ The example models can be found in the packages `Examples`.
Study the detailed tutorials with step-by-step instructions for how to build system models,
which can be found in the `Tutorial package <https://simulationresearch.lbl.gov/modelica/releases/v8.0.0/help/Buildings_Examples_Tutorial.html>`_.

Note that heat transfer models, which can be found in `Buildings.HeatTransfer.*.Examples` are easier to understand than fluid flow models because;
Note that heat transfer models, which can be found in `Buildings.HeatTransfer.*.Examples`
are easier to understand than fluid flow models because;

* handling fluid flow adds more complexity due to flow reversal (i.e., if the mass flow rate changes its direction),
* fluid flow models may need to handle multiple species such as air and water vapor, as well as trace substances such as CO2, and
* fluid flow models use packages that define medium models, such as dry air, moist air, water or other fluids.

To get started with Spawn of EnergyPlus, we recommend to first familiarize yourself with Modelica, as described above.
Next, read the
`user guide for the Spawn models <https://simulationresearch.lbl.gov/modelica/releases/v8.0.0/help/Buildings_ThermalZones_EnergyPlus_UsersGuide.html>`_
which provides step-by-step instructions and points to various examples.


Software Requirements
---------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -197,12 +197,17 @@ <h2>1.2. Running the First Simulations<a class="headerlink" href="#running-the-f
The example models can be found in the packages <cite>Examples</cite>.</p>
<p>Study the detailed tutorials with step-by-step instructions for how to build system models,
which can be found in the <a class="reference external" href="https://simulationresearch.lbl.gov/modelica/releases/v8.0.0/help/Buildings_Examples_Tutorial.html">Tutorial package</a>.</p>
<p>Note that heat transfer models, which can be found in <cite>Buildings.HeatTransfer.*.Examples</cite> are easier to understand than fluid flow models because;</p>
<p>Note that heat transfer models, which can be found in <cite>Buildings.HeatTransfer.*.Examples</cite>
are easier to understand than fluid flow models because;</p>
<ul class="simple">
<li><p>handling fluid flow adds more complexity due to flow reversal (i.e., if the mass flow rate changes its direction),</p></li>
<li><p>fluid flow models may need to handle multiple species such as air and water vapor, as well as trace substances such as CO2, and</p></li>
<li><p>fluid flow models use packages that define medium models, such as dry air, moist air, water or other fluids.</p></li>
</ul>
<p>To get started with Spawn of EnergyPlus, we recommend to first familiarize yourself with Modelica, as described above.
Next, read the
<a class="reference external" href="https://simulationresearch.lbl.gov/modelica/releases/v8.0.0/help/Buildings_ThermalZones_EnergyPlus_UsersGuide.html">user guide for the Spawn models</a>
which provides step-by-step instructions and points to various examples.</p>
</div>
<div class="section" id="software-requirements">
<h2>1.3. Software Requirements<a class="headerlink" href="#software-requirements" title="Permalink to this headline"></a></h2>
Expand Down
Loading

0 comments on commit bbee276

Please sign in to comment.