illuminator
The Illuminator is an easy-to-use Energy System Integration Development kit to demystify energy system operation, illustrate challenges that arise due to the energy transition and test state-of-the-art energy management concepts.
Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Keywords
Repository
The Illuminator is an easy-to-use Energy System Integration Development kit to demystify energy system operation, illustrate challenges that arise due to the energy transition and test state-of-the-art energy management concepts.
Basic Info
- Host: GitHub
- Owner: Illuminator-team
- License: other
- Language: Python
- Default Branch: main
- Homepage: https://illuminator-team.github.io/Illuminator/
- Size: 91.7 MB
Statistics
- Stars: 11
- Watchers: 1
- Forks: 12
- Open Issues: 39
- Releases: 13
Topics
Metadata Files
readme.md
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:
shell
pip install illuminator
Using Conda
The environment.yml provides all dependecies to create a conda environment called illuminator.
```shell 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.
- The Illuminator project is supported by TU Delft PowerWeb and Stichting 3E.
- The development of the Illuminator was supported by the Digital Competence Centre, Delft University of Technology.
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:
Owner
- Name: Illuminator-team
- Login: Illuminator-team
- Kind: user
- Repositories: 1
- Profile: https://github.com/Illuminator-team
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: The Illuminator
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Aihui
family-names: Fu
email: A.Fu@tudelft.nl
affiliation: Delft University of Technology
- given-names: Raghav
family-names: Saini
- given-names: Remko
family-names: Koornneef
affiliation: Delft University of Technology
- family-names: Meer
name-particle: van der
given-names: Arjen
affiliation: Delft University of Technology
- given-names: Peter
family-names: Palensky
affiliation: Delft University of Technology
- given-names: Milos
family-names: Cvetkovic
affiliation: Delft University of Technology
email: M.Cvetkovic@tudelft.nl
identifiers:
- type: doi
value: 10.1109/PowerTech55446.2023.10202816
description: IEEE deposit of the encompassing paper
repository-code: 'https://github.com/Illuminator-team/Illuminator'
abstract: >-
The Illuminator is primarily a modular software platform
developed to run on a Raspberry Pi (RasPi) cluster
keywords:
- energy system integration
- energy transition
- education
license: LGPL-2.1
version: 2.0.0
date-released: '2024-01-11'
GitHub Events
Total
- Create event: 26
- Release event: 8
- Issues event: 32
- Watch event: 4
- Delete event: 13
- Member event: 6
- Issue comment event: 17
- Push event: 201
- Pull request review comment event: 20
- Pull request review event: 44
- Pull request event: 107
- Fork event: 4
Last Year
- Create event: 26
- Release event: 8
- Issues event: 32
- Watch event: 4
- Delete event: 13
- Member event: 6
- Issue comment event: 17
- Push event: 201
- Pull request review comment event: 20
- Pull request review event: 44
- Pull request event: 107
- Fork event: 4
Dependencies
- actions/checkout v4 composite
- actions/setup-python v5 composite
- pandoc/actions/setup v1 composite
- peaceiris/actions-gh-pages v4 composite
- actions/checkout v4 composite
- actions/setup-python v4 composite
- pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
- Sphinx ==7.4.7
- arrow ==1.2.3
- jupyterlab >=4.3.0
- lxml ==4.9.3
- matplotlib ==3.7.2
- mosaik >=3.3.3
- myst-parser ==3.0.1
- nbsphinx ==0.9.5
- paho-mqtt ==1.6.1
- pandapower ==2.13.1
- pandas ==1.5.3
- pandoc >=2.4.0
- ruamel.yaml >=0.18.5
- schema >=0.7.0
- sphinx-copybutton ==0.5.2
- sphinx-rtd-theme ==2.0.0
- actions/checkout v3 composite
- actions/setup-python v5 composite
- arrow 1.2.3.*
- lxml 4.9.3.*
- matplotlib 3.7.2.*
- paho-mqtt 1.6.1.*
- pandapower 2.13.1.*
- pandas 1.5.3.*
- pip
- python >=3.11
- setuptools 68.0.0.*
- arrow ==1.2.3
- lxml ==4.9.3
- matplotlib ==3.7.2
- mosaik >=3.3.3
- numpy ==1.26.4
- paho-mqtt ==1.6.1
- pandapower ==2.13.1
- pandas ==1.5.3
- ruamel.yaml >= 0.18.5
- schema >=0.7.7
- typer >=0.12.5