mosaik is a flexible smart-grid co-simulation framework

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mosaik from gravatar.com mosaik

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

Mosaik

Mosaik is a simulation compositor for Smart Grid simulations.

It lets you re-use existing simulators and couple them to simulate large-scale Smart Grid scenarios. Mosaik offers powerful mechanisms to specify and compose these scenarios.

License: LGPL

Example

A simple demo scenario with mosaik:

>>> import mosaik
>>> sim_config = {
...   'ExampleSim': {'python': 'example_sim.mosaik:ExampleSim'},
... }
>>> def create_scenario(world):
...   sim_1 = world.start('ExampleSim')
...   sim_2 = world.start('ExampleSim')
...   a_set = [sim_1.A(init_val=0) for i in range(3)]
...   b_set = sim_2.B.create(2, init_val=0)
...   for i, j in zip(a_set, b_set):
...     world.connect(i, j, ('val_out', 'val_in'))
...
>>> world = mosaik.World(sim_config)
>>> create_scenario(world)
2022-11-21 15:39:48.554 | INFO     | mosaik.scenario:start:255 - Starting "ExampleSim" as "ExampleSim-0" ...
2022-11-21 15:39:48.555 | INFO     | mosaik.scenario:start:255 - Starting "ExampleSim" as "ExampleSim-1" ...
>>> world.run(until=2)
2022-11-21 15:40:05.187 | INFO     | mosaik.scenario:run:532 - Starting simulation.
100%|█████████████████████████████████████████████████████████████████████████████████| 2/2 [00:00<00:00, 539.56steps/s]
2022-11-21 15:40:05.193 | INFO     | mosaik.scenario:run:576 - Simulation finished successfully.

Installation

Mosaik requires Python >= 3.8. Use pip to install it, preferably into a virtualenv:

$ pip install mosaik

Documentation, Source Code and Issues

The documentation is available at https://mosaik.readthedocs.io.

Please report bugs and ideas for improvement to our issue tracker.

How to cite mosaik

If you want to cite mosaik, e.g. in a work in which you use mosaik, you can use this publication:

C. Steinbrink, M. Blank-Babazadeh, A. El-Ama, S. Holly, B. Lüers, M. Nebel-Wenner, R.P. Ramirez Acosta, T. Raub, J.S. Schwarz, S. Stark, A. Nieße, and S. Lehnhoff, “CPES Testing with mosaik: Co-Simulation Planning, Execution and Analysis”, Applied Sciences, vol. 9, no. 5, 2019.

Or as bibtex:

@Article{app9050923,
    AUTHOR = {Steinbrink, Cornelius and Blank-Babazadeh, Marita and El-Ama, André and Holly, Stefanie and Lüers, Bengt and Nebel-Wenner, Marvin and Ramírez Acosta, Rebeca P. and Raub, Thomas and Schwarz, Jan Sören and Stark, Sanja and Nieße, Astrid and Lehnhoff, Sebastian},
    TITLE = {CPES Testing with mosaik: Co-Simulation Planning, Execution and Analysis},
    JOURNAL = {Applied Sciences},
    VOLUME = {9},
    YEAR = {2019},
    NUMBER = {5},
    ARTICLE-NUMBER = {923},
    URL = {https://www.mdpi.com/2076-3417/9/5/923},
    ISSN = {2076-3417},
    DOI = {10.3390/app9050923}
}

Get in touch, ask questions, discuss 💬

You have a question, a feature request or want to generally discuss the amazing possibilities with co-simulation and mosaik? We are curious to hear from you! Join us on GitHub Discussions. Changelog =========

3.3.3 - 2024-05-21

3.3.2 - 2024-04-12

  • [FIX] Fix versioning issue

3.3.1 - 2024-04-12

3.3.0 - 2024-04-08

3.2.0 - 2023-08-31

3.1.1 - 2023-01-11

3.1.0 - 2022-11-23

3.0.2 - 2022-06-01

  • [CHANGE] Updated mosaik-api version to 3.0.2

3.0.1 - 2022-05-02

  • [CHANGE] Set external events via highlevel function call

  • [FIX] Allow PATCH version to be included in the mosaik-api version format

3.0.0 - 2021-06-07

  • This is a major upgrade to improve the discrete-event capabilities. Simulators’ steps can now also be triggered by the output of other simulators.

  • [NEW] Native support of discrete-event simulations

  • [NEW] A global time resolution can be set for the scenario.

  • [NEW] Simulators can request steps asynchronously via set_event() to react to external events.

  • [NEW] Ability to specify output data as non-persistent (i.e. transient)

  • [CHANGE] New api 3: - Simulators have now a type (‘time-based’|’event-based’|’hybrid’). - time_resolution is passed as argument of the init function. - max_advance is passed as argument of the step function.

  • [CHANGE] Update of the documentation

2.6.1 - 2021-06-04

  • [CHANGE] Updated ReadTheDocs to support versioning

  • [CHANGE] Updated setup: mosaik-api>=2.3,<3

  • [CHANGE] Updated networkx version to 2.5

2.6.0 - 2020-05-08

  • [NEW] The print of the simulation progress is now optional and can be disabled via a flag world.run(END, print_progress=False).

  • [NEW] Additional starters can now be added via external packages (the standard ones are ‘python’, ‘cmd’, and ‘connect’).

2.5.3 - 2020-04-30

  • [FIX] Constrain simpy version to <4.0.0 due to simpy.io incompatibility

  • [CHANGE] Updated Odysseus tutorial

  • [CHANGE] Eliminated shifted_cache which reduces memory consumption

2.5.2 - 2019-11-01

  • [NEW] Special characters are now allowed in path names

  • [NEW] Compatible to the new versions of networkx

  • [CHANGE] python 3.6, 3.7 and 3.8 are currently supported, python 3.4 and 3.5 not anymore.

  • [FIX] Various minor internal changes

  • [FIX] Various documentation updates and fixes

2.5.1 - 2018-11-29

  • [NEW] When calling the world.start() command for a simulator, users can now set a predefined value for the posix flag (e.g. True) to prevent automatic detection of the operating system. This facilitates the creation of some co-simulation cases across OS (e.g. Windows and Linux).

2.5.0 - 2018-09-05

  • [NEW] Connection option “time_shifted” added as alternative to async_requests. This will make creating cyclic data dependencies between simulators more usable since usage of set_data with an API implementation will no longer be needed.

2.4.0 - 2017-12-06

  • [NEW] Compatible to the new versions of networkx, simpy and simpy.io

  • [CHANGE] python 3.4, 3.5 and 3.6 are currently supported python 3.3 is no longer supported

  • [FIX] Various bug fixes

2.3.0 - 2016-04-26

  • [NEW] Allow passing environment vars to sup processes

  • [FIX] Fixed a bug in the version validation which raised an error when using a floating point for the version

2.2.0 - 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 match with mosaik’s major version. The minor part may be lower or equal to mosaik’s minor version.

  • [FIX] Various minor fixes and stability improvements.

  • [FIX] Various documentation updates and fixes.

2.1.2 – 2014-10-29

  • [FIX] World.shutdown() now checks if the socket still exists before attempting to close it.

  • [FIX] Fixed a bug that made the last extra method of a simulator shadow all previous ones.

2.1.1 – 2014-10-28

  • [NEW] World.run() now prints a warning if you forget to connect a simulator’s entities.

  • [FIX] Fixed some problems with the data-flow cache.

2.1 – 2014-10-24

  • [NEW] Mosaik can now perform real-time simulations. Before, this functionality needed to be implemented by simulators. Now it’s just World.run(until=x, rt_factor=y), where rt_factor defines the simulation speed relative to the wall-clock time (issue #24).

  • [NEW] Simulators can now expose extra methods via their API that can be called from a mosaik scenario. This allows you to, e.g., store static data in a data base. These extra API methods need to be specified in the simulator’s meta data (issue #26).

  • [NEW] util.connect_many_to_one() helper function.

  • [NEW] More and better documentation:

    • Tutorial for integrating simulators, control strategies and for creating scenarios.

    • Sim API description

    • Scenario API description

    • Sim Manager documentation

    • Scheduler documentation

    • Discussion of design decisions

    • Logo, colors, CI

  • [NEW] Added util.sync_call() which eases calling proxied methods of a simulator synchronously.

  • [CHANGE] The rel attribute in the entity description returned by create() is now optional.

  • [CHANGE] Moved proxied methods from SimProxy to SimProxy.proxy in order to avoid potential name clashes with other attributes.

  • [CHANGE] Check a simulator’s models and extra API methods for potential name clashes with the built-in API methods.

  • [CHANGE] The argument execution_graph of World was renamed to debug. The execution graph now also stores the time after a simulation step (in addition to the time before the step).

  • [FIX] issue #22: The asynchronous requests get_data() and set_data() now check if the async_requests flag was set in World.connect().

  • [FIX] issue #23: finalize() is now called for in-process Python simulators.

  • [FIX] issue #27: Dramatically improved simulation performance (30 times as fast in some cases) if simulators use different step sizes (e.g. 1 minute and 1 hour) by improving some internal data structures.

2.0 – 2014-09-22

  • Mosaik 2 is a complete rewrite of mosaik 1 in order to improve its maintainability and flexibility.

  • Removed features:

    • The mosl DSL (including Eclipse xtext and Java) are now gone. Mosaik now only uses Python.

    • Mosaik now longer has executables but is now used as a library.

    • The platform manager is gone.

    • The database is now a separate package, see mosaik-hdf5.

    • The old web UI is gone.

  • Mosaik now consists of four core components with the following feature sets:

    • mosaik Sim API

      • The API has bean cleaned up and simplified.

      • Simulators and control strategies share the same API.

      • There are only four calls from mosaik to a simulator: init, create, step and get_data.

      • Simulators / processes can make asynchronous requests to mosaik during a step: get_progress, get_related_entities, get_data, set_data.

      • ZeroMQ with JSON is replaced by plain network sockets with JSON.

    • Scenarios:

      • Pure Python is now used to describe scenarios. This offers you more flexibility to create complex scenarios.

      • Scenario creation simplified: Start a simulator to get a model factory. Use the factory to create model instances (entities). Connect entities. Run simulation.

      • Connection rules are are no based on a primitive connect function that only connects two entities with each other. On top of that, any connection strategy can be implemented.

    • Simulation Manager:

      • Simulators written in Python 3 can be executed in process.

      • Simulators can be started as external processes.

      • Mosaik can connect to an already running instance of a simulator. This can be used as a replacement for the now gone platform manager.

    • Simulation execution:

      • The simulation is now event-based. No schedule and no synchronization points need to be computed.

      • Simulators can have different and varying step sizes.

  • Mosaik ecosystem:

You can find information about older versions on the history page

Authors

The original concepts for mosaik were developed by Steffen Schütte and Stefan Scherfke.

The author of mosaik version 2 is Stefan Scherfke.

Current and former members of the mosaik team: Sharaf Alsharif, Tobias Brandt, Reef Eilers, André El-Ama, Bengt Lüers, Okko Nannen, Annika Ofenloch, Mostafa Ramezani, Thomas Raub, Stefan Scherfke, Florian Schloegl, Eike Schulte, Steffen Schütte, Jan Sören Schwarz, Cornelius Steinbrink, Malte Stomberg, Deborah Tolk

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mosaik from gravatar.com mosaik

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

This version

3.3.3

3.3.2

3.3.1

3.3.0

3.3.0b1 pre-release

3.2.0

3.1.1

3.1.0

3.0.2

3.0.1

3.0.0

2.6.1

2.6.0

2.5.3

2.5.2

2.5.1

2.5.0

2.4.0

2.3.1

2.3.0

2.2.0

2.1.3

2.1.2

2.1.1

2.1

2.0

2.0a4 pre-release

2.0a3 pre-release

2.0a2 pre-release

2.0a1 pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mosaik-3.3.3.tar.gz (64.7 kB view details)

Uploaded Source

Built Distribution

mosaik-3.3.3-py3-none-any.whl (66.2 kB view details)

Uploaded Python 3

File details

Details for the file mosaik-3.3.3.tar.gz.

File metadata

  • Download URL: mosaik-3.3.3.tar.gz
  • Upload date:
  • Size: 64.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for mosaik-3.3.3.tar.gz
Algorithm Hash digest
SHA256 ed5c805c1972514dd23b5fad7ff42623bb40373932af56cf2b2bccca7e904af2
MD5 ccad1cccacfab1aec42dace68a6326e9
BLAKE2b-256 17fac372655e710cce81cbf11c0f97fde39e86d6d337883b06d67f239ad395ea

See more details on using hashes here.

File details

Details for the file mosaik-3.3.3-py3-none-any.whl.

File metadata

  • Download URL: mosaik-3.3.3-py3-none-any.whl
  • Upload date:
  • Size: 66.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for mosaik-3.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b49c1845c88deb709f9a3f736ffe8be28ab0fce702f1179e01a40dbb48f2bcd2
MD5 ecad4b76a2411ac1af2b0f7e7fde3c27
BLAKE2b-256 8fbcd6fb726759adb744a8201e7f7c5028f65203f9b421d556acb945b37a6c22

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page