Folder Structure

This is to give an overview of where different parts of the eELib are stored:

• docs : Files for the documentation with AutodocSphinx into the GitLab Pages style. Documentation is stored in .rst files within the source subfolder.

• eelib : This stores the main part of the elenia Energy Library, as it contains the models and all other functionalities.

  • core : Here all of the models are stored. This is divided into the devices (like PV system or electric vehicle), control models (like energy management system), grid models (for power flow calculation), forecasting, and market models (like intraday market).

  • data : This contains all models that are “just” retrieving input data (like a simple csv-reader). It also includes the functionalities for simulation data to be collected and assessed.

  • model_connections : Exchange values between all models of the eELib and functionalities to extract them.

  • testing : Contains all of the testing for the models and functionalities of the library.

  • utilsContains helper functions and classes, exemplarily for running a simulation or

    evaluating and plotting/presenting outputs of simulations.

• examples : This folder provides data and scripts for some test scenarios and provides an overview of how the eELib can be used. The data subfolder contains some exemplary data and also contains results after running simulations.

The highest folder also contains various files that are used for setup of the environment, gitlab communication, a README for information etc.

You can also familiarize with the folder structure of the eElib package by exploring the API Reference and browsing through the source code documentation in there.