Illuminator documentation

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. we utilise Raspberry Pis as the individual components of the energy system emulator, and the simulation engine is based on Mosaik.

Getting Started

• Quick Start
  • Installation
  • From Source
  • Usage
  • Contact and Support
• Cluster Pi Setup
  • Hardware Requirements
  • Set up
  • Contact and Support

User's Documentation

• Models
  • Battery storage
  • Electric Boiler
  • Electrolyser
  • Fuel Cell
  • Hydrogen Storage
  • Heat Pump
  • Heat Storage
  • PV Model
  • Wind Model
  • Load, Heat demand, Heat Product, Hydrogen product and Hydrogen demand
  • Electricity network, Hydrogen network and Heat network
  • Distribution network
• Simulation Configuration File
  • Example
• Simulations
  • Python Interface
  • CLI

Developer's Documentation

• Set Up Environment
  • Running Unit Tests
• Software Architecture
  • Users
  • Components
  • Use Cases
• Docstrings
  • Short summary
  • Missing data in older docstrings
• Testing: basic principles and ideas
  • Types of tests
  • How to write tests and future expectations
• Creating/writing tests
  • Writing unit tests
  • Mocking

References

• Illuminator Models
  • BatteryModel
• Engine API
  • Python Interface
  • Utility Functions

Indices and tables

• Index

• Module Index

• Search Page