Installation

When using HAI-CPS, you can either use the pre-compiled datasets or run the simulations locally.
For running the simulations locally, you must install all necessary requirements.
Alternatively, we provide a Dockerfile that allows you to run the simulations inside a Docker container — this is our recommended setup.

Requirements

For local installation:

Note: Local usage has only been tested on Ubuntu 22.04 LTS and Ubuntu 24.04 LTS. While the models run without issues in the OpenModelica Shell and OpenModelica Editor, the Python API may encounter problems.

You need an installation of OpenModelica 1.25 and the OpenModelica Standard Library 4.0.0 to run the benchmark.
All additional Python requirements are listed in the venv.yml file available in the benchmark’s GitHub repository.

Using Docker:

To run the simulation inside a Docker container, you need a current version of Docker and Docker Compose installed.

Installation

For local installation:

Install OpenModelica by following the instructions on the OpenModelica website.
Install all additional requirements:
- We recommend installing a recent version of Miniforge.
- Navigate to the directory containing the venv.yml file.
- Then, create the environment by running:
```
mamba env create -f env.yml
```

Using Docker:

Navigate to the directory where the Dockerfile is located.
Set up the container by running:
```
docker compose up -d
```