ModelicaRes 0.1

ModelicaRes
===========

**Python utilities to set up and analyze Modelica simulation experiments**

The goal of ModelicaRes is to provide an open-source tool to effectively
manage Modelica_ simulations, interpret results, and create publishable
figures. It is currently possible to auto-generate simulation scripts, run
model executables with varying parameters, browse data, perform calculations,
and produce various plots and diagrams. The figures are generated by
matplotlib_, which offers a rich set of plotting routines. ModelicaRes
includes convenient functions to automatically pre-format and label some
figures, like xy plots, Bode and Nyquist plots, and Sankey diagrams.
ModelicaRes can be scripted or run from a Python_ command-line interpreter with
math and matrix functions from NumPy_.

The main project site, http://kdavies4.github.com/ModelicaRes, includes the
full documentation and many examples. The development site is
https://github.com/kdavies4/modelicares.

The authors are Kevin Davies and Kevin Bandy. Third-party code has been
included from Jason Grout (`ArrowLine
<http://old.nabble.com/Arrows-using-Line2D-and-shortening-lines-td19104579.html>`_
class), Jason Heeris (`efficient base-10 logarithm
<http://www.mail-archive.com/matplotlib-users@lists.sourceforge.net/msg14433.html>`_),
Richard Murray (`python-control
<http://sourceforge.net/apps/mediawiki/python-control>`_), and Joerg Raedler
(method to expand a Modelica_ variable tree, from `DyMat
<http://www.j-raedler.de/projects/dymat/>`_)

To install on Linux, do the following from the base folder:

.. code-block:: sh

$ python ./setup.py build
$ sudo python ./setup.py install

.. Seealso:: The `buildingspy
<http://simulationresearch.lbl.gov/modelica/buildingspy/>`_ and DyMat_
projects provide other Python_ modules that are related.

.. _Python: http://www.python.org/
.. _Modelica: http://www.modelica.org/
.. _matplotlib: http://www.matplotlib.org/
.. _python-control: http://sourceforge.net/apps/mediawiki/python-control