Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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 to install it:

$ pip install mosaik-api

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().

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:

$ 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:

(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:

(mosaik-api-python)$ tox

Mosaik’s documentation contains more details.

Changelog

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.

Metadata

Release files for mosaik-api 2.0a2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mosaik-api 2.0a2
File Size Uploaded
mosaik-api-2.0a2.tar.gz 19.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mosaik-api 2.0a2
File Interpreter ABI Platform
mosaik_api-2.0a2-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 33.3 kB

Release files / mosaik-api-2.0a2.tar.gz

Download URL mosaik-api-2.0a2.tar.gz
Size 19.4 kB
Tags Source
SHA-256 checksum
How to use checksums
1134df23b3b406f20222ab2df5566c3328f5744716ba33c7512798fb0bbe3098
BLAKE2b-256 checksum
How to use checksums
a6d8625c90a37ce30f26ce927d15427e454b8b8ac901b0eee886adff7192bec6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / mosaik_api-2.0a2-py2.py3-none-any.whl

Download URL mosaik_api-2.0a2-py2.py3-none-any.whl
Size 13.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
b3e6f4f1bd565ea1f027b41bf19e5605b1064585d8abd9fda83b29424304ae4a
BLAKE2b-256 checksum
How to use checksums
caf9a2e84e0b271ed4b22f30a4bbff876ec4ad402bb50f25b66bdaaca3ab1776
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page