Skip to content

Latest commit

 

History

History
91 lines (70 loc) · 3.64 KB

README.md

File metadata and controls

91 lines (70 loc) · 3.64 KB

ModelicaRes

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

  • Auto-generate simulation scripts,
  • Browse data,
  • Perform custom calculations, and
  • Produce various plots and diagrams.

Plot of Chua circuit with varying parameters Sankey diagram of three tanks example

The figures are generated via 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 interpreter with math and matrix functions from NumPy.

For more information, please see the main project site or the doc folder for the full documentation and many examples.

Installation

An installable copy of this package can be downloaded from the main project site or the PyPI page. After extracting the package, run the set up script (setup.py) from the base folder. On Windows, use the following command:

python setup.py install

On Linux, use:

sudo python setup.py install

The matplotlibrc file has some recommended revisions to matplotlib's defaults. To use it, move or copy the file 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. Kevin Bandy also helped with the development. Third-party code has been included from:

License terms and development

ModelicaRes is published under the terms of the BSD license (see LICENSE.txt). Please share any modifications you make (preferably on a Github fork from https://github.com/kdavies4/ModelicaRes) so that others may benefit from your work. If you find a bug, please report it. If you have suggestions for improvements, please share them here.

See also

The following Python projects are related: