Reference Manual

The reference manual provides the documentation of the eELib regarding its architecture and the source code reference.

General Information about the eELib

Describing how eELib’s architecture is set up, why and how we use mosaik for simulations, and how the simulations are working for event-based triggering of the models

Glossary and FAQ

Glossary of some frequently used terms, devices, and units as well as parameters for scenario configuration and frequently asked questions (FAQ)

Forecasts and Schedules

How forecasts can be created, how to integrate them into simulations, and how to use them (to create schedules)

Helpful Tips for the Usage of Git Program

Instruction on how to work with various commands in Git (focused on Visual Studio Code)

Installation and Setup Guide

Full Guide for the installation of Python, Git, Visual Studio Code, your local working copy of the meELib, etc. and how to setup your working environment

mosaik

Describing the co-simulation framework mosaik and providing information on helpful mosaik tutorials

Folder Structure

Structure of the eELib’s models and functionalities based on folders and sub-folders

Overview of implemented Models

Listing of all implemented models in the eELib with their folder path and a tabular listing of all parameters for each model, including possible input types and values to initialize the model entities

API Reference

Explanations and documentation to the classes resp. modules and their methods, which are provided by the docstrings in the source code

Indices and Tables

Alphabetical ordering of all classes, methods, modules, and parameters

Alphabetical ordering of all eELib modules