Skip to main content

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

Metadata

Release files for mosaik-api 2.0

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.0
File Size Uploaded
mosaik-api-2.0.tar.gz 20.1 kB Details

Built distribution (wheel)

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

Total release size: 32.0 kB

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

Download URL mosaik-api-2.0.tar.gz
Size 20.1 kB
Tags Source
SHA-256 checksum
How to use checksums
5d2499a099d559266106136ce99c14f5cff305ad5fd522ffdf717ecfe7d6d5e5
BLAKE2b-256 checksum
How to use checksums
0909f057bdc82ebbf8963ab24b873c7df1354ba1eb74230df91142ae62e48dde
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL mosaik_api-2.0-py2.py3-none-any.whl
Size 11.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
ef115486090fb2e90d2ca4968979224a05923a50e3a1c823479bb2266bbaad6c
BLAKE2b-256 checksum
How to use checksums
3b9e619e2d5d98d97ed59c066d0cfad6dc29a6f1ec56304d6af2b828e86a4892
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