Metadata-Version: 1.1
Name: mosaik-api
Version: 2.0a4
Summary: Python implementation of the mosaik API.
Home-page: https://mosaik.offis.de
Author: Stefan Scherfke
Author-email: stefan.scherfke at offis.de
License: UNKNOWN
Description: 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
        ------------
        
        Just use `pip <https://pip.pypa.io>`_ to install it:
        
        .. sourcecode:: bash
        
            $ pip install mosaik-api
        
        
        Documentation
        -------------
        
        Please refer to `mosaik’s documentation`__ of the API.
        
        __ http://mosaik.readthedocs.org/en/latest/mosaik-api/high-level.html
        
        
        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()``.
        
        
        Example MAS
        -----------
        
        This distribution contains an example "multi-agent system" that uses the
        asyncronous remote calls to mosaik (``get_progress()``,
        ``get_related_entities()``, ``get_data()``, ``set_data()``).
        
        It can be started via the ``pyexamplemas`` command; ``pyexamplemas --help``
        shows you how to use it.
        
        It can also be run in-process by importing and calling
        ``example_mas.mosaik.main()``.
        
        
        Development setup
        -----------------
        
        To setup a devleopment environment, create a virtualenv and install the
        packages from ``requirements.txt``:
        
        .. code-block:: bash
        
           $ mkvirtualenv --python=/usr/bin/python3 mosaik-api-python
           (mosaik-api-python)$ pip install -r requirements.txt
        
        To run the tests for the Python version you are currently using, execute
        ``py.test``. You should also add the test coverage check:
        
        .. code-block:: bash
        
           (mosaik-api-python)$ py.test --cov=example_mas --cov=example_sim --cov=mosaik_api
        
        To run the tests for all supported Python versions, run ``tox``:
        
        .. code-block:: bash
        
           (mosaik-api-python)$ tox
        
        Mosaik's `documentation
        <https://mosaik.readthedocs.org/en/latest/dev/setup.html>`_ contains more
        details.
        
        
        Changelog
        =========
        
        2.0a4 – 2014-07-31
        ------------------
        
        - [CHANGE] Adopted latest changes of the mosaik low-level API.
        
        
        2.0a3 – 2014-06-26
        ------------------
        
        - [CHANGE] Adopted latest changes of the mosaik low-level API.
        
        
        2.0a2 – 2014-05-05
        ------------------
        
        - [NEW] Enabled ``set_data()`` RPC.
        - [NEW] Added *example_mas* that uses the async. remote calls.
        - [REMOVED] Support for Python 2.6.
        
        
        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.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
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
