Quickstart

Requirements

• Python 3.12.0

• Dependencies can be installed via pip install -r requirements.txt

Graphical User Interface

Provides a graphical user interface in a web app.

To run it locally:

blocks:

> streamlit run interface_gui.py

Command Line - Interactive

Provides an interactive prompt environment to set the simulation settings.

To get started run interface_cmd.py to activate a command line interface (CLI).

• simulate This command is used to run the simulation with the assigned settings.

• Using just simulate generates a default scenario.

• Predefined scenarios are available in the ./Scenarios/ folder. To use one of them, use load -sn <scenario name> and simulate.

• Results are stored in the directory ./SimulationResults/<results folder with datetime from simulation run time>

Plot the results

• plot This command is used to generate plots from the simulation results.

• plot -h lists the arguments that can be used with plot <arguments>

• plot with no arguments generates and saves all figures without displaying them.

• plot --all both generates and displays all figures.

Command Line - single command

Simulation settings are defined in a single command line.

Start by running interface_cli.py [OPTIONS].