diff --git a/Tutorial/Details.md b/Tutorial/Details.md index aa639df..4d4f110 100644 --- a/Tutorial/Details.md +++ b/Tutorial/Details.md @@ -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 diff --git a/Tutorial/ModelicaPackage.md b/Tutorial/ModelicaPackage.md new file mode 100644 index 0000000..9562941 --- /dev/null +++ b/Tutorial/ModelicaPackage.md @@ -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. diff --git a/Tutorial/TestHallUseCase.md b/Tutorial/TestHallUseCase.md index ae40177..64c5d4e 100644 --- a/Tutorial/TestHallUseCase.md +++ b/Tutorial/TestHallUseCase.md @@ -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. @@ -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,