Skip to content

Commit

Permalink
Updated user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mwetter committed Sep 5, 2023
1 parent dbebe75 commit 29815fd
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ The Modelica language specification does not specify a scripting language for si
To provide scripts that automate simulation of models and post-processing of results, LBNL created the `BuildingsPy <https://simulationresearch.lbl.gov/modelica/buildingspy/>`_ Python library.
This library can be used

* to run Modelica simulations using Dymola,
* to process ``*.mat`` output files that were generated by Dymola or OpenModelica, and
* to run Modelica simulations using Dymola, OpenModelica or OPTIMICA,
* to process ``*.mat`` output files that were generated by these programs, and
* to run unit tests as part of the library development.

See the separate documentation at https://simulationresearch.lbl.gov/modelica/buildingspy/ for information on how to use this library.

In addition, Dymola provides MATLAB scripts that can be used to process ``*.mat`` output files that were generated by Dymola. See the Dymola documentation for how to use these scripts.

To optimize cost functions that are computed by Dymola, the `GenOpt <https://simulationresearch.lbl.gov/GO/>`_ optimization program can be used. See GenOpt's directory ``example/dymola`` for examples that use Dymola to compute the cost function in an optimal control problem.
To optimize cost functions that are computed by Dymola, OpenModelica or OPTIMICA,
the `GenOpt <https://simulationresearch.lbl.gov/GO/>`_ optimization program can be used.
See GenOpt's directory ``example/dymola`` for examples that use Dymola to compute the cost function in an optimal control problem.
Original file line number Diff line number Diff line change
Expand Up @@ -168,14 +168,16 @@ <h1><span class="section-number">4. </span>Pre- and Post-Processing<a class="hea
This library can be used</p>
<blockquote>
<div><ul class="simple">
<li><p>to run Modelica simulations using Dymola,</p></li>
<li><p>to process <code class="docutils literal notranslate"><span class="pre">*.mat</span></code> output files that were generated by Dymola or OpenModelica, and</p></li>
<li><p>to run Modelica simulations using Dymola, OpenModelica or OPTIMICA,</p></li>
<li><p>to process <code class="docutils literal notranslate"><span class="pre">*.mat</span></code> output files that were generated by these programs, and</p></li>
<li><p>to run unit tests as part of the library development.</p></li>
</ul>
</div></blockquote>
<p>See the separate documentation at <a class="reference external" href="https://simulationresearch.lbl.gov/modelica/buildingspy/">https://simulationresearch.lbl.gov/modelica/buildingspy/</a> for information on how to use this library.</p>
<p>In addition, Dymola provides MATLAB scripts that can be used to process <code class="docutils literal notranslate"><span class="pre">*.mat</span></code> output files that were generated by Dymola. See the Dymola documentation for how to use these scripts.</p>
<p>To optimize cost functions that are computed by Dymola, the <a class="reference external" href="https://simulationresearch.lbl.gov/GO/">GenOpt</a> optimization program can be used. See GenOpt’s directory <code class="docutils literal notranslate"><span class="pre">example/dymola</span></code> for examples that use Dymola to compute the cost function in an optimal control problem.</p>
<p>To optimize cost functions that are computed by Dymola, OpenModelica or OPTIMICA,
the <a class="reference external" href="https://simulationresearch.lbl.gov/GO/">GenOpt</a> optimization program can be used.
See GenOpt’s directory <code class="docutils literal notranslate"><span class="pre">example/dymola</span></code> for examples that use Dymola to compute the cost function in an optimal control problem.</p>
</section>


Expand Down
Loading

0 comments on commit 29815fd

Please sign in to comment.