Skip to content

Commit

Permalink
* Further extend documentation, #47
Browse files Browse the repository at this point in the history
  • Loading branch information
MBaranskiEBC committed Mar 31, 2019
1 parent abff1e6 commit df703b0
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Tutorial/Details.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,14 @@ Currenty, FMUs are used only for simulating the controlled system. In the Init,
the user can choose if an FMU should be generated automatically (which can
sometimes lead to trouble with the Dymola license) or choose to provide an
existing FMU.

### test_main.py
This module is used to test the functionality. It calls the GenerateSubSys()
from the System module to create the subsystems. It creates all the necessary
directories and generates and FMU or loads an existing FMU as controlled system.
It further triggers each of the subsytem agents to take action.

### System.py
System is a class that generates the various subsystems.

### Subsystem.py
11 changes: 11 additions & 0 deletions Tutorial/ModelicaPackage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Modelica package descritpion

## Overview
The Modelica package currently contains models for the AHU and the test hall
use case. The most important thing to keep in mind is that there are subsystems
and subsystem models. The difference is that the subsystem models are the ones
that are actually used by the DMPC algorithms. The subsystems, however, are
used in Software-in-the-loop experiments to construct the controlled system.
Both Modelica classes extend a common base class. This ensures that, in SiL
experiments, we have exactly the same parameters in the components that appear
both in the subsystem and in its model, thus ensuring a perfect model.
5 changes: 5 additions & 0 deletions Tutorial/TestHallUseCase.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Test hall use case

## Overview
This is a demonstration, in which four different model types are used with the
BExMoC algorithm.

Expand Down Expand Up @@ -32,3 +34,6 @@ and stored in a .mat file readable by Modelica models.
The "hall-short" model is a simple linear equation that controls the air
temperature perfectly, so that the air flow into the hall is always equal to
the temperature that was assumed for the long simulation.

## Tutorial
In order to run this example,

0 comments on commit df703b0

Please sign in to comment.