Skip to main content

A simple simulator for household profiles.

Project description


This is pseudo simulator to serve residual load profiles to mosaik.


$ pip install mosaik-householdsim


You can run the tests with:

$ git clone
$ cd mosaik-householdsim
$ pip install -r requirements.txt
$ pip install -e .
$ pytest


This simulator consists of a model (householdsim/ and the mosaik API implementation (householdsim/

The model processes the data from a NumPy *.npz file (see householdsim/test/ for an example of its layout). Basically, the file contains a number of load profiles for a given period of time. It also contains ID lists that describe which load profile belongs to which node ID in a power grid. The first entry in an ID list relates to the first entry of the profiles list, the second entry in the ID list to the second load profile and so on. If the number of entries in the ID list is larger than the number of load profiles, we start again with the first load profile.

Internally, the model works with minute. Since mosaik allows to set the time resolution in the scenario (seconds as default), the mosaik API implementation converts between them.

Usually, residual load profiles have a resolution of 15 minutes. It is no problem for this simulator to step in 1 minute steps, though.


2.1.0 - 2021-05-21

  • [CHANGE] Updated to mosaik-api 3.0.

2.0.3 – 2019-09-27

  • [FIX] Fixed incompatibility with new arrow version.

  • [FIX] Fixed time offset bug.

2.0.2 – 2014-09-22

  • [CHANGE] Updated to mosaik-api 2.0.

2.0.1 – 2014-06-26

  • [CHANGE] Adopted latest changes of the mosaik low-level API.

2.0 – 2014-03-26

  • Updated API implementation for mosaik2.

1.0 – 2014-01-30

  • Initial release.


The household simulator was created by Stefan Scherfke and Ontje Lünsdorf.

Project details

Download files

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

Source Distribution

mosaik-householdsim-2.1.0.tar.gz (16.0 kB view hashes)

Uploaded source

Built Distribution

mosaik_householdsim-2.1.0-py2.py3-none-any.whl (17.2 kB view hashes)

Uploaded py2 py3

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