Metadata-Version: 2.0
Name: mosaik-api
Version: 2.0a1
Summary: Python implementation of the mosaik API.
Home-page: http://mosaik.offis.de
Author: Stefan Scherfke
Author-email: stefan.scherfke at offis.de
License: LGPLv2
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: docopt (>=0.6.1)
Requires-Dist: simpy (>=3.0.2)
Requires-Dist: simpy.io (>=0.1)

Mosaik API for Python
=====================


This is an implementation of the mosaik API for simulators written in Python.
It hides all the messaging and networking related stuff and provides a simple
base class that you can implement.


Installation
------------

Change to the ``mosaik-api-python`` repo and use `pip
<http://www.pip-installer.org/en/latest/>`_ to install it:

.. sourcecode:: bash

    $ cd mosaik-api-python
    $ pip install .


Documentation
-------------

Please refer to mosaik’s documentation of the API.


Example Simulator
-----------------

This distribution contains an example simulator in the ``example_sim`` package.

It can be started via the ``pyexamplesim`` command; ``pyexamplesim --help``
shows you how to use it.

It can also be run in-process by importing and calling
``example_sim.mosaik.main()``.


Changelog
=========

2.0a1 – 2014-03-26
------------------

- Initial release. Note, that mosaik is still alpha and not yet done.


Authors
=======

The original concepts for the mosaik API were developed by Steffen Schütten and
Stefan Scherfke.

The author of the mosaik API version 2 is Stefan Scherfke.


