Installation:

Follow those steps to set up the model on a new system:

1) Install Pycharm (or other IDE)

• URL: https://www.jetbrains.com/de-de/pycharm/

2) Install Python

• URL: https://www.python.org/
• Version requirement: 3.11 or newer

3) Install Poetry Package Manager:

Poetry can be installed using windows powershell or pipx:

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

pipx install poetry

• URL: https://python-poetry.org/docs/
• Version requirement: 1.7 or newer

The path to the poetry-executable file must be specified within the path-environment-variable!

4) Install Gurobi

Download Gurobi from the official website:

• URL: Gurobi Downloads
• Version Requirement: 11.0.0 or newer

5) Copy repository from git

• URL: https://github.com/KammererSimon/FactoryFlexibilityModel.git

6) Create Poetry Python environment

In the python terminal execute:

poetry install

7) Create Desktop Shortcut to Tool GUI

In the python terminal execute:

poetry run create_shortcut

This will create a batch file to execute the kivy-gui as well as a shortcut to it on your Desktop

Quickstart Instructions

1) Opening the GUI

To start the user interface for simulation architecture setup, use the desktop shortcut or run the following command:

poetry run gui

2) Performing a simulation:

To simulate a session save it with the gui and then call:

poetry run simulate [session_folder_path]

To simulate the session of the SPIES 2024 Paper execute:

poetry run simulate examples\SPIES_2024 

3) Showing result dashboard on a simulated model run:

To show the results of a performed simulation execute:

poetry run dashboard [simulation_object]

with [simulation_object] being a .sim file within the session_folder

Copyright (c) [2024]

[Institute of Energy Systems, Energy Efficiency and Energy Economics

TU Dortmund

Simon Kammerer (simon.kammerer@tu-dortmund.de)]

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

-----------------------------------------------------------------------------