Skip to main content

A development toolkit for simulating energy systems

Project description

License: GPL v2 documentation

Illuminator

The Illuminator is an easy-to-use Energy System Integration Development kit to demystify energy system's operation, illustrate challenges that arise due to the energy transition and test state-of-the-art energy management concepts. The kit utilises Raspberry Pi's as individual components of an energy system emulator, and the simulation engine is based on Mosaik.

Installation

Requirements

  • Python >= 3.8 & < 3.12
  • Miniconda (optional)
  • A Rasberry Pi cluster, for cluster deployment (optional)

Using Pip

The simplest way to install Illuminator is from PYPI, using pip:

pip install illuminator

Using Conda

The environment.yml provides all dependecies to create a conda environment called illuminator.

conda env create -f environment.yml

conda activate illuminator

Refer to the Quick Start guide for a brief explanation on how to set up and run your first simulation.

Illuminator Raspberry Pi Cluster

Refer to the Cluster Pi Setup documentation for instructions on how to set up an Illuminator cluster.

Contributing Guidelines

The Illuminator team accepts contributions to the Illuminator source, test files, documentation, and other materials distributed with the program. To contribute read our guidelines

License

Illuminator is available under a GNU Lesser General Public License (LGPL). The Illuminator team does not take responsibility for any damage or loss derive from using this sourcecode.

Citation

Please cite this software as follows:

A. Fu, R. Saini, R. Koornneef, A. van der Meer, P. Palensky and M. Cvetković, "The Illuminator: An Open Source Energy System Integration Development Kit," 2023 IEEE Belgrade PowerTech, Belgrade, Serbia, 2023, pp. 01-05, doi: 10.1109/PowerTech55446.2023.10202816.

Contributors

Many people have contributed to the development of Illuminator, we list their names and contributions below:

Role Contributor
v3 Core Developers J. Groen, D. Georgiadi
Conceptualization A. Fu, A. Neagu, M. Cvetkovic, M. Garcia Alvarez, M. Rom
Funding acquisition A. Fu, M. Cvetkovic, P. Palensky
Project management A. Neagu, M. Cvetkovic
Research A. Fu, M. Cvetkovic, N. Balassi, R. Saini, S.K. Trichy Siva Raman
Resources R. Koornneef
Software A. Fu, J. Grguric, J. Pijpker, M. Garcia Alvarez, M. Rom., D. Georgiadi, J. Groen
Model Development J. Groen, D. Georgiadi, L. Klootwijk
Tutorials J. Riedler
Supervision A. Neagu, M. Cvetkovic

Acknowledgements

The Illuminator team extends its sincere gratitude for the invaluable support and contributions from our dedicated members:

  • Aihui Fu, who played a pivotal role as the main developer for both Versions 1.0 and 2.0.
  • Remko Koornneef, whose expertise in hardware development has been instrumental.
  • Siva Kaviya, for her significant contributions to the development of the initial version.
  • Raghav Saini, for his substantial involvement in developing the models for Version 1.0.
  • Niki Balassi, for his crucial role in advancing the multi-energy system models in Version 2.0.

Each of these individuals has been essential in shaping the success and evolution of our project. We are profoundly thankful for their dedication and expertise.

Contact and Support

For more comprehensive support, please contact us at illuminator@tudelft.nl. Additionally, you can reach out to the main contributors for specific inquiries:

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

illuminator-3.1b0.tar.gz (62.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

illuminator-3.1b0-py3-none-any.whl (11.1 MB view details)

Uploaded Python 3

File details

Details for the file illuminator-3.1b0.tar.gz.

File metadata

  • Download URL: illuminator-3.1b0.tar.gz
  • Upload date:
  • Size: 62.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for illuminator-3.1b0.tar.gz
Algorithm Hash digest
SHA256 70d42faf8cf3f79aeb4cb52b0b7cab95b95de013b2587f3ee0eb09d6b154bf82
MD5 ea8f3184d3e9e868e35ffc86b34fe0d4
BLAKE2b-256 9e0480e9fd564e7d7be2d57530ed319b76719549deb6b8b4a527f7cb38a66c9e

See more details on using hashes here.

File details

Details for the file illuminator-3.1b0-py3-none-any.whl.

File metadata

  • Download URL: illuminator-3.1b0-py3-none-any.whl
  • Upload date:
  • Size: 11.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for illuminator-3.1b0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce3660ddfd8e53587d4422443ae9c0f1c5db3f8bcc1ed3129e1f00cd357420ff
MD5 bf4028b831501b7179e9f18ba2c974fd
BLAKE2b-256 933bc5abf4c74e8315d9f652e9b81e1fcd6e065a6dcc2df7e93dcd5ec65473db

See more details on using hashes here.

Supported by

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