Skip to main content

Utilities to set up and analyze Modelica simulation experiments

Project description

#############
ModelicaRes
#############

**Utilities to set up and analyze Modelica simulation experiments**

ModelicaRes is a free, open-source tool to conveniently manage Modelica_
simulations, interpret results, and create publishable figures. It is possible
to

- auto-generate simulation scripts,
- browse data,
- perform custom calculations,
- produce various plots and diagrams, and
- export data to various formats via pandas_.

The figures are generated via matplotlib_, which offers a rich set of plotting
routines. ModelicaRes includes functions to automatically pre-format and label
some figures, like xy plots, Bode and Nyquist plots, and Sankey diagrams.
ModelicaRes can be scripted or used in an interactive Python_ session with math
and matrix functions from NumPy_.

Please see the tutorial, which is available as an `IPython notebook
<https://github.com/kdavies4/ModelicaRes/blob/master/examples/tutorial.ipynb>`_
or online as a `static page
<http://nbviewer.ipython.org/github/kdavies4/ModelicaRes/blob/master/examples/tutorial.ipynb>`_.
For the full documentation and many more examples, see the `main website`_.

Installation
~~~~~~~~~~~~

The easiest way to install this package is to use pip_::

pip install modelicares

On Linux, it may be necessary to have root privileges::

sudo pip install modelicares

Another way is to download and extract a copy of the package. The `main
website`_ and the `release branch at GitHub`_ have copies with built
documentation and compiled examples. The copy on the `PyPI page`_ only has the
files to install the package, build the documentation, and execute the examples.
Once you have a copy, run the following command from the base folder::

python setup.py install

Or, on Linux::

sudo python setup.py install

Some of the required packages may not install automatically.

- The SciPy_ stack, including matplotlib_ and pandas_, can be installed
according to the instructions at http://www.scipy.org/install.html.
- PyQt4_ can be downloaded from
http://www.riverbankcomputing.co.uk/software/pyqt/download.
- wxPython_ can be downloaded from http://www.wxpython.org/download.php.
However, it is only required for the `variable browser
<http://kdavies4.github.io/ModelicaRes/simres.html#modelicares.simres.SimRes.browse>`_.

The *matplotlibrc* file in the base folder has some recommended revisions to
matplotlib_'s defaults. To use it, copy it to the working directory or
matplotlib_'s configuration directory. See
http://matplotlib.org/users/customizing.html for details.

Credits
~~~~~~~

The main author is Kevin Davies. Code has been included from:

- Richard Murray (`python-control`_, `as repackaged
<https://pypi.python.org/pypi/control>`_ by James Goppert),
- Joerg Raedler (method to expand a Modelica_ variable tree---from DyMat_),
- Jason Grout (`ArrowLine class`_), and
- Jason Heeris (`efficient base-10 logarithm`_),

Suggestions and bug fixes have been provided by Arnout Aertgeerts, Kevin Bandy,
Thomas Beutlich, Martin Sjölund, Mike Tiller, and Michael Wetter.

License terms and development
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

ModelicaRes is published under a `BSD-compatible license
<https://github.com/kdavies4/ModelicaRes/blob/release/LICENSE.txt>`_. The
development site is https://github.com/kdavies4/ModelicaRes. Please share any
modifications you make (preferably as a pull request to the ``master`` branch
at that site) in order to help others. If you find a bug, please `report it
<https://github.com/kdavies4/ModelicaRes/issues/new>`_. If you have
suggestions, please `share them
<https://github.com/kdavies4/ModelicaRes/wiki/Suggestions>`_.

See also
~~~~~~~~

- awesim_: helps run simulation experiments and organize results
- BuildingsPy_: supports unit testing
- DyMat_: exports Modelica_ simulation data to comma-separated values
(CSV_), Gnuplot_, MATLAB®, and Network Common Data Form (netCDF_)
- PyFMI_: tools to work with models through the Functional Mock-Up Interface
(FMI_) standard
- PySimulator_: elaborate GUI; supports FMI_


.. _main website: http://kdavies4.github.io/ModelicaRes
.. _release branch at GitHub: https://github.com/kdavies4/ModelicaRes
.. _PyPI page: http://pypi.python.org/pypi/ModelicaRes

.. _Modelica: http://www.modelica.org
.. _Python: http://www.python.org
.. _pandas: http://pandas.pydata.org
.. _matplotlib: http://www.matplotlib.org
.. _NumPy: http://numpy.scipy.org
.. _SciPy: http://www.scipy.org/index.html
.. _PyQt4: http://www.riverbankcomputing.co.uk/software/pyqt
.. _wxPython: http://www.wxpython.org
.. _pip: https://pypi.python.org/pypi/pip
.. _awesim: https://github.com/saroele/awesim
.. _BuildingsPy: http://simulationresearch.lbl.gov/modelica/buildingspy
.. _DyMat: http://www.j-raedler.de/projects/dymat
.. _PyFMI: https://pypi.python.org/pypi/PyFMI
.. _PySimulator: https://github.com/PySimulator/PySimulator
.. _Gnuplot: http://www.gnuplot.info
.. _CSV: http://en.wikipedia.org/wiki/Comma-separated_values
.. _netCDF: http://www.unidata.ucar.edu/software/netcdf
.. _FMI: https://www.fmi-standard.org
.. _python-control: http://sourceforge.net/apps/mediawiki/python-control
.. _ArrowLine: http://old.nabble.com/Arrows-using-Line2D-and-shortening-lines-td19104579.html
.. _efficient base-10 logarithm: http://www.mail-archive.com/matplotlib-users@lists.sourceforge.net/msg14433.html

Project details


Release history Release notifications

History Node

0.12.2

History Node

0.12.1

History Node

0.12.0

History Node

0.11.1

This version
History Node

0.11.0

History Node

0.10.0

History Node

0.9.0

History Node

0.8.2

History Node

0.8.1

History Node

0.8.0

History Node

0.7.2

History Node

0.7.1

History Node

0.7.0

History Node

0.6.2

History Node

0.6.1

History Node

0.6.0

History Node

0.5.2

History Node

0.5.1

History Node

0.5

History Node

0.4

History Node

0.3

History Node

0.2

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
ModelicaRes-0.11.0.tar.gz (858.9 kB) Copy SHA256 hash SHA256 Source None May 21, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page