Illuminator documentation

TThe Illuminator is a user-friendly development kit for simulating integrated energy systems. It supports the design of energy systems, the testing of advanced energy management concepts, and the demonstration of challenges posed by the energy transition. Illuminator builts on Mosaik. and supports both stand-alone simulations and distributed computing.

Getting Started

• Quick Start
  • Installation
  • From Source
  • Usage
  • Contact and Support

Educational tutorials

• Tutorials Overview
• Tutorial: Power Balancing
• Tutorial: Electricity Markets
• Tutorial: Grid Congestion

User's Documentation

• Simulation Configuration File
  • Example
• Running Simulations
  • Python Script
  • Command Line
• Illuminator Models
  • Illuminator Agent Models
    • GenerationCompanyAgent
    • JusticeAgent
    • Operator_Market
  • Illuminator Component Models
    • Battery
    • CSV
    • GridConnection
    • Load
    • PV
    • Wind
  • Illuminator Controller Models
    • Controller_T1
    • ControllerT3Congestion
  • Illuminator Data Models
    • CSV

Developer's Documentation

• Set Up Environment
  • Running Unit Tests
• Software Architecture
  • Users
  • Components
  • Use Cases
• Custom Model Development
  • Good Coding Practices
  • Project Documentation
  • Model Testing
• Testing: basic principles and ideas
  • Types of tests
  • How to write tests and future expectations
• Creating/writing tests
  • Writing unit tests
  • Mocking

Future Work

• Cluster Set Up
• Dashboard

References

• Scenario API
  • Python Interface
  • Utility Functions

Indices and tables

• Index