mosaik.API-SemVer


Namemosaik.API-SemVer JSON
Version 2.4.2rc20220703000508 PyPI version JSON
download
home_pagehttps://mosaik.offis.de
SummaryPython implementation of the mosaik API.
upload_time2022-07-03 00:05:10
maintainerBengt Lüers
docs_urlNone
authorStefan Scherfke
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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.

Status
------

.. image:: https://gitlab.com/offis.energy/mosaik/mosaik.api-python_semver/badges/master/pipeline.svg
    :target: https://gitlab.com/offis.energy/mosaik/mosaik.api-python_semver/-/jobs
    :alt: Pipeline status

.. image:: https://gitlab.com/offis.energy/mosaik/mosaik.api-python_semver/badges/master/coverage.svg
    :target: https://gitlab.com/offis.energy/mosaik/mosaik.api-python_semver/commits/master
    :alt: Coverage Report

.. image:: https://img.shields.io/pypi/l/mosaik.api-SemVer.svg
    :target: https://gitlab.com/offis.energy/mosaik/mosaik.api-python_semver/blob/master/LICENSE.txt
    :alt: PyPI - License

.. image:: https://img.shields.io/pypi/v/mosaik.api_SemVer
    :target: https://pypi.org/project/mosaik.api_SemVer/#history
    :alt: PyPI version

.. image:: https://img.shields.io/librariesio/release/pypi/mosaik.api_SemVer
    :target: https://libraries.io/pypi/mosaik.api_SemVer
    :alt: Libraries status

.. image:: https://img.shields.io/pypi/pyversions/mosaik.api_SemVer
    :target: https://pypi.org/project/mosaik.api_SemVer/
    :alt: Python Versions

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
``pytest``. You should also add the test coverage check:

.. code-block:: bash

   (mosaik-api-python)$ pytest --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.4.1 - 2019-05-15
------------------

- [NEW] Introduce semantic versioning.

2.4 - 2019-02-05
----------------

- [NEW] Simulator can now be started on a different node than mosaik, using the
  remote flag "-r" and the timeout flag "-t". Mosaik can the integrate the simulator
  using the "connect" method of the simmanager.

2.3 – 2019-01-24
----------------

- [BugFix] Bugfix Tests


2.2 – 2016-02-15
----------------

- [NEW] API version 2.2: Added an optional "setup_done()" method.

- [CHANGE] API version validation: The API version is no longer an integer but
  a "major.minor" string.  The *major* part has to math with mosaiks major
  version.  The *minor* part may be lower or equal to mosaik's minor version.

- [FIX] Various minor fixes and stability improvements.


2.1 – 2014-10-24
----------------

- [NEW] Allow extra API methods to be called. See
  http://mosaik.readthedocs.org/en/2.0/mosaik-api/high-level.html#mosaik_api.Simulator

- [CHANGE] The *rel* entry in the entity description returned by *create()* is
  now optional.


2.0 – 2014-09-22
----------------

- Initial release of the mosaik 2 Sim API for Python.


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.



            

Raw data

            {
    "_id": null,
    "home_page": "https://mosaik.offis.de",
    "name": "mosaik.API-SemVer",
    "maintainer": "Bengt L\u00fcers",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "bengt.lueers@gmail.com",
    "keywords": "",
    "author": "Stefan Scherfke",
    "author_email": "mosaik@offis.de",
    "download_url": "",
    "platform": null,
    "description": "Mosaik API for Python\n=====================\n\nThis is an implementation of the mosaik API for simulators written in Python.\nIt hides all the messaging and networking related stuff and provides a simple\nbase class that you can implement.\n\nStatus\n------\n\n.. image:: https://gitlab.com/offis.energy/mosaik/mosaik.api-python_semver/badges/master/pipeline.svg\n    :target: https://gitlab.com/offis.energy/mosaik/mosaik.api-python_semver/-/jobs\n    :alt: Pipeline status\n\n.. image:: https://gitlab.com/offis.energy/mosaik/mosaik.api-python_semver/badges/master/coverage.svg\n    :target: https://gitlab.com/offis.energy/mosaik/mosaik.api-python_semver/commits/master\n    :alt: Coverage Report\n\n.. image:: https://img.shields.io/pypi/l/mosaik.api-SemVer.svg\n    :target: https://gitlab.com/offis.energy/mosaik/mosaik.api-python_semver/blob/master/LICENSE.txt\n    :alt: PyPI - License\n\n.. image:: https://img.shields.io/pypi/v/mosaik.api_SemVer\n    :target: https://pypi.org/project/mosaik.api_SemVer/#history\n    :alt: PyPI version\n\n.. image:: https://img.shields.io/librariesio/release/pypi/mosaik.api_SemVer\n    :target: https://libraries.io/pypi/mosaik.api_SemVer\n    :alt: Libraries status\n\n.. image:: https://img.shields.io/pypi/pyversions/mosaik.api_SemVer\n    :target: https://pypi.org/project/mosaik.api_SemVer/\n    :alt: Python Versions\n\nInstallation\n------------\n\nJust use `pip <https://pip.pypa.io>`_ to install it:\n\n.. sourcecode:: bash\n\n    $ pip install mosaik-api\n\n\nDocumentation\n-------------\n\nPlease refer to `mosaik\u2019s documentation`__ of the API.\n\n__ http://mosaik.readthedocs.org/en/latest/mosaik-api/high-level.html\n\n\nExample Simulator\n-----------------\n\nThis distribution contains an example simulator in the ``example_sim`` package.\n\nIt can be started via the ``pyexamplesim`` command; ``pyexamplesim --help``\nshows you how to use it.\n\nIt can also be run in-process by importing and calling\n``example_sim.mosaik.main()``.\n\n\nExample MAS\n-----------\n\nThis distribution contains an example \"multi-agent system\" that uses the\nasyncronous remote calls to mosaik (``get_progress()``,\n``get_related_entities()``, ``get_data()``, ``set_data()``).\n\nIt can be started via the ``pyexamplemas`` command; ``pyexamplemas --help``\nshows you how to use it.\n\nIt can also be run in-process by importing and calling\n``example_mas.mosaik.main()``.\n\n\nDevelopment setup\n-----------------\n\nTo setup a devleopment environment, create a virtualenv and install the\npackages from ``requirements.txt``:\n\n.. code-block:: bash\n\n   $ mkvirtualenv --python=/usr/bin/python3 mosaik-api-python\n   (mosaik-api-python)$ pip install -r requirements.txt\n\nTo run the tests for the Python version you are currently using, execute\n``pytest``. You should also add the test coverage check:\n\n.. code-block:: bash\n\n   (mosaik-api-python)$ pytest --cov=example_mas --cov=example_sim --cov=mosaik_api\n\nTo run the tests for all supported Python versions, run ``tox``:\n\n.. code-block:: bash\n\n   (mosaik-api-python)$ tox\n\nMosaik's `documentation\n<https://mosaik.readthedocs.org/en/latest/dev/setup.html>`_ contains more\ndetails.\n\n\nChangelog\n=========\n\n2.4.1 - 2019-05-15\n------------------\n\n- [NEW] Introduce semantic versioning.\n\n2.4 - 2019-02-05\n----------------\n\n- [NEW] Simulator can now be started on a different node than mosaik, using the\n  remote flag \"-r\" and the timeout flag \"-t\". Mosaik can the integrate the simulator\n  using the \"connect\" method of the simmanager.\n\n2.3 \u2013\u00a02019-01-24\n----------------\n\n- [BugFix] Bugfix Tests\n\n\n2.2 \u2013\u00a02016-02-15\n----------------\n\n- [NEW] API version 2.2: Added an optional \"setup_done()\" method.\n\n- [CHANGE]\u00a0API version validation: The API version is no longer an integer but\n  a \"major.minor\" string.  The *major* part has to math with mosaiks major\n  version.  The *minor* part may be lower or equal to mosaik's minor version.\n\n- [FIX] Various minor fixes and stability improvements.\n\n\n2.1 \u2013 2014-10-24\n----------------\n\n- [NEW]\u00a0Allow extra API methods to be called. See\n  http://mosaik.readthedocs.org/en/2.0/mosaik-api/high-level.html#mosaik_api.Simulator\n\n- [CHANGE]\u00a0The *rel* entry in the entity description returned by *create()* is\n  now optional.\n\n\n2.0 \u2013 2014-09-22\n----------------\n\n- Initial release of the mosaik 2 Sim API for Python.\n\n\nAuthors\n=======\n\nThe original concepts for the mosaik API were developed by Steffen Sch\u00fctten and\nStefan Scherfke.\n\nThe author of the mosaik API version 2 is Stefan Scherfke.\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Python implementation of the mosaik API.",
    "version": "2.4.2rc20220703000508",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "63733148b849609f2e19c33d30557615",
                "sha256": "c11b43803552ad0e86ae4a6c0d08d46ce729d58a354f1aab000d9fa0903bab7b"
            },
            "downloads": -1,
            "filename": "mosaik.API_SemVer-2.4.2rc20220703000508-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "63733148b849609f2e19c33d30557615",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 20981,
            "upload_time": "2022-07-03T00:05:10",
            "upload_time_iso_8601": "2022-07-03T00:05:10.553919Z",
            "url": "https://files.pythonhosted.org/packages/e0/bf/63c1a4424b527ac8d25d039a65e624049a2b51411d25b7e74542d589de33/mosaik.API_SemVer-2.4.2rc20220703000508-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-07-03 00:05:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "mosaik.api-semver"
}
        
Elapsed time: 0.45061s