Modelicares

- Improved installation script and documentation

- Updated documentation
- General cleanup of code and development scripts
- Re-enabled setup_requires to automatically install requirements

- Fixed issues with Unicode_ in Python 3.
- Fixed sorting and ordering of :class:`~modelicares.simres.SimRes` and
:class:`~modelicares.linres.LinRes` instances in Python 3.
- :meth:`~modelicares.simres._VarList.arrays` is now available as
:meth:`~modelicares.simres.Variable.array` instead.
- *fbase* is now a property instead of a method of
:class:`~modelicares.simres.SimRes` and
:class:`~modelicares.linres.LinRes`. Likewise, *n_constants* is now a
property of :class:`~modelicares.simres.SimRes` and *basedir* is a property
of :class:`~modelicares.simres.SimResList` and
:class:`~modelicares.linres.LinResList`.
- Added *dirname* as a property to :class:`~modelicares.simres.SimRes` and
:class:`~modelicares.linres.LinRes`.
- *basename*, *dirname*, *fname*, *n_constants*, *sys*, and *tool* are now
properties of :class:`~modelicares.simres.SimResList` and
:class:`~modelicares.linres.LinResList` (as applicable) which give lists of
the corresponding properties across all of the simulations or
linearizations in those lists.
- Deleted :meth:`~modelicares.simres.SimResList.fnames`. Use the *fname*
property of :class:`~modelicares.simres.SimResList` instead.
- :meth:`~modelicares.simres.Variable.is_constant` is now a property instead
of a method of :class:`~modelicares.simres.Variable`.
- :func:`sort` now correctly sorts :class:`~modelicares.simres.SimResList`
and :class:`~modelicares.linres.LinResList` by absolute file path.
- Improved the generation of defaults for the Bode and Nyquist plots.
- Fixed an issue with slicing a :class:`~modelicares.simres.SimResList`.
- Removed :func:`~modelicares.util.pow10`. It is not used internally and
probably is not very helpful externally.
- Change the default value of *roman* in
:func:`~modelicares.texunit.quantity_str` to *False*.
- Renamed and/or reordered the arguments of
:func:`~modelicares.util.setup_subplots`, and
:func:`~modelicares.exps.modelica_str` for clarity and simplicity.
- Supported Qt_ via several installations: PyQt4_, guidata_, and PySide_.
PySide_ is no longer required, but if no Qt_ installation is available,
then file dialogs are not available in :func:`~modelicares.util.save` or
the `loadres <loadres.html>`_ script.

- Fixed the release to PyPI_.

- Added IPython notebooks (`tutorial
<http://nbviewer.ipython.org/github/kdavies4/ModelicaRes/blob/master/examples/tutorial.ipynb>`_
and
`advanced <http://nbviewer.ipython.org/github/kdavies4/ModelicaRes/blob/master/examples/advanced.ipynb>`_).
- Decoupled the Dymola-specific algorithms and placed them in a submodule.
ModelicaRes is now independent with respect to the simulation tool.
- New classes :class:`~modelicares.simres.SimResList` and
:class:`~modelicares.linres.LinResList` to manage, sort, and plot multiple
simulation and linearization results (based on the old
:mod:`~modelicares.multi` submodule).
- Now supports Python 3.
- Now supports format version 1.0 Dymola/OpenModelica files (previously only
1.1).
- Improved the speed of loading files and retrieving data.
- Improved test coverage, with continuous integration testing (thanks to
`Travis CI <https://travis-ci.org/>`_).
- Improved installation setup and instructions.
- Added a simpler, more powerful API for accessing data attributes; removed
the *get_* methods of :class:`~modelicares.simres.SimRes`.
- Added time-based indexing to :class:`~modelicares.simres.SimRes.arrays`,
:class:`~modelicares.simres.SimRes.time`, and
:class:`~modelicares.simres.SimRes.values`; accepts time, list of times, or
slice of time.
- Added :meth:`~modelicares.simres.SimRes.to_pandas` to return a
`pandas DataFrame`_ of selected data.
- Added *f1* and *f2* arguments to plot additional expressions using
:meth:`~modelicares.simres.SimRes.plot`.
- Plotting examples are now included as scripts in the *examples* folder.
Only the plots are show in the documentation, with links to the source
files.
- :class:`~modelicares.simres.SimRes` and :class:`~modelicares.linres.LinRes`
now require the file extension to load files.
- Added :meth:`~modelicares.simres.SimRes.n_constants` to return the number
of constants in a simulation.
- wx is now optional---only required for variable browser.
- Added option to :class:`~modelicares.simres.SimRes.names` to list only the
constants.
- Added :mod:`~modelicares.util.si_prefix` (previously nested in
:mod:`~modelicares.texunit`)
- The *fname* attribute in :class:`~modelicares.simres.SimRes` and
:class:`~modelicares.linres.LinRes` now includes the absolute path.
:meth:`~modelicares.simres.SimRes.fbase` returns the base filename without
directory or extension.
- Added :meth:`~modelicares.linres.LinRes.to_tf` to return a selected
transfer function from the state-space representation.
- Added pattern matching to :meth:`~modelicares.simres.SimRes.nametree`.
- Proper handling of Unicode_ in simulation files.
- Eliminated the dependence on :mod:`easygui`; using :mod:`PySide` (Qt)
instead.
- Renamed :mod:`~modelicares.base` to :mod:`~modelicares.util` for clarity.
It is a package of utility functions and classes, not base classes.
- Renamed internal submodules with leading underscore to denote that they
are not meant for external use.
- Renamed :func:`~modelicares.texunit.label_number` to
:func:`~modelicares.texunit.label_number` and
:func:`~modelicares.texunit.label_quantity` to
:func:`~modelicares.texunit.quantity_str`.
- Merged :func:`~modelicares.exps.modelica_array` and
:func:`~modelicares.exps.modelica_boolean` into a new function,
:func:`~modelicares.exps.modelica_str`.
- Removed :class:`~modelicares.util.Quantity` and
:func:`~modelicares.util.convert` from :mod:`~modelicares.util`.
- Removed :func:`~modelicares.simres.merge_times`. It is not used internally
and probably is not very helpful externally.
- Removed :func:`~modelicares.util.animate`. matplotlib_ now has built-in
methods for this; see http://matplotlib.org/api/animation_api.html.

- Added :meth:`~modelicares.simres.SimRes.get_tuple` to get time, value
tuples for variables.
- Removed the *external/control* folder. Instead, using PyPI/distutils to
install the `control package <https://pypi.python.org/pypi/control>`_.
- Added functions to calculate the minimum, maximum, and mean of variables
(:meth:`~modelicares.simres.SimRes.get_min`,
:meth:`~modelicares.simres.SimRes.get_max`, and
:meth:`~modelicares.simres.SimRes.get_mean`).
- Removed :meth:`~modelicares.simres.SimRes.variables`,
:meth:`~modelicares.simres.SimRes.variables`, and
:meth:`~modelicares.simres.SimRes.glob` from
:meth:`~modelicares.simres.SimRes`. Use
:meth:`~modelicares.simres.SimRes.names` instead.
- Merged the pattern-matching functionality of
:meth:`~modelicares.simres.SimRes.glob` into
:meth:`~modelicares.simres.SimRes.names` and added the option to use
regular expressions. By default, :meth:`~modelicares.simres.SimRes.names`
still returns all variable names.