midas-store 2.0.0a1

A database simulator that stores every input.

MIDAS Store

Description

This package contains a MIDAS module providing a database simulator. This works like most other collectors for mosaik, i.e., it accepts any number of inputs and stores them in a database file.

Although this package is intended to be used with MIDAS, it does not depend from anything MIDAS-related except for the midas-util package. You can use in any mosaik simulation scenario.

Installation

This package will usually installed automatically together with midas-mosaik. It is available on pypi, so you can install it manually with

pip install midas-store

Usage

The complete documentation is available at https://midas-mosaik.gitlab.io/midas.

Inside of MIDAS

To use the store inside of MIDAS, just add store to your modules

my_scenario:
  modules:
    - store
    - ...

and configure it with (filename is required, everything else is optional and can be left out if the default values, shown below, are used):

  store_params:
    filename: my_db.hdf5
    step_size: 900
    overwrite: False
    buffer_size: 0

All simulators that have something to store will then automatically connect to the store simulator.

Any mosaik scenario

If you don't use MIDAS, you can add the store manually to your mosaik scenario file. First, the entry in the sim_config:

sim_config = {
    "MidasHdf": {"python": "midas.modules.store:MidasHdf5"},
    # ...
}

Next, you need to start the simulator (assuming a step_size of 900):

store_sim = world.start("MidasHdf", step_size=900)

Finally, the model needs to be started:

store = store_sim.Database(filename="path/to/my_db.hdf5", buffer_size=0, overwrite=False)

Afterwards, you can define world.connect(other_entity, store, attrs) as you like.

License

This software is released under the GNU Lesser General Public License (LGPL). See the license file for more information about the details.