Skip to main content

A simple simulator for household profiles.

Project description


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


Pipeline status Coverage Report Libraries status License badge PyPI version Python Versions


$ pip install mosaik-householdsim


You can run the tests with:

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


This simulator consists of a a model (householdsim/ and the mosaik API implemenation (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 entires 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 is based on seconds, 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.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

Release history Release notifications | RSS feed

Download files

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

Files for mosaik.HouseholdSim-SemVer, version 2.0.4rc20211021000434
Filename, size File type Python version Upload date Hashes
Filename, size mosaik.HouseholdSim_SemVer-2.0.4rc20211021000434-py2.py3-none-any.whl (15.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page