Metadata-Version: 1.1
Name: ModelicaRes
Version: 0.10.0
Summary: Utilities to set up and analyze Modelica simulation experiments
Home-page: http://kdavies4.github.io/ModelicaRes/
Author: Kevin Davies
Author-email: kdavies4@gmail.com
License: BSD-compatible (see LICENSE.txt)
Description: #############
         ModelicaRes
        #############
        
        ModelicaRes_ is a free, open-source tool to manage Modelica_ simulations,
        interpret results, and create publishable figures. It is possible to
        
        - Auto-generate simulation scripts,
        - Browse data,
        - Perform custom calculations, and
        - Produce various plots and diagrams.
        
        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 of
        the package for the full documentation and many examples.  The  development site
        is https://github.com/kdavies4/modelicares.
        
        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 from the 
        `main project site`_, the `master branch at GitHub 
        <https://github.com/kdavies4/ModelicaRes>`_, or the `PyPI page`_.  Run the 
        following command from the base folder::
        
            python setup.py install
        
        Or, on Linux::
        
            sudo python setup.py install
        
        The *matplotlibrc* file in the base folder has some recommended revisions to
        matplotlib_'s defaults.  To use it, move or 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.  Improvements, bug fixes, and suggestions have 
        been provided by Arnout Aertgeerts, Kevin Bandy, Thomas Beutlich, 
        Martin Sjölund, Mike Tiller, and Michael Wetter.
        
        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_).
        
        License terms and development
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        ModelicaRes_ is published under a BSD license (see LICENSE.txt).  Please share 
        any modifications you make (preferably on a Github fork from 
        https://github.com/kdavies4/ModelicaRes) 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
        ~~~~~~~~
        
        The following Python_ projects are related:
        
        - awesim_: helps run simulation experiments and organize results
        - BuildingsPy_: supports unit testing
        - DyMat_: exports Modelica_ simulation data to comma-separated values (CSV),
          `Gnuplot <http://www.gnuplot.info/>`_, MATLAB®, and `Network Common Data Form
          (netCDF) <http://www.unidata.ucar.edu/software/netcdf/>`_
        - PyFMI_: tools to work with models through the Functional Mock-Up Interface
          (FMI) standard
        - PySimulator_: elaborate GUI; supports FMI
        
        
        .. _ModelicaRes: http://kdavies4.github.io/ModelicaRes/
        .. _Modelica: http://www.modelica.org
        .. _matplotlib: http://www.matplotlib.org
        .. _Python: http://www.python.org
        .. _NumPy: http://numpy.scipy.org
        .. _main project site: http://kdavies4.github.io/ModelicaRes/
        .. _PyPI page: http://pypi.python.org/pypi/ModelicaRes
        .. _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
        
Keywords: Modelica,plot,results,simulation,experiment,Dymola,matplotlib
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2.7
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Requires: python (==2.7)
Requires: scipy (>=0.10.0)
Requires: numpy
Requires: matplotlib (>=1.1.0)
Requires: control
Requires: wx
Requires: easygui
Provides: modelicares
