Installation of openCARP Docker containers

First, install Docker for your platform.

There are 2 options for the openCARP installation using Docker.

1. After the Docker installation use docker commands to pull and use the docker images.
2. Alternatively, install using our script which will take care of all installation steps for you.

Install our docker script (Option 1)

Docker provides a variety of commands to utilize docker images:

docker --help

To help you quick start, our script opencarp-docker wraps the most commonly used docker commands.

To install the script, go to openCARP/docker, and run the install script:

cd <path-to-your-codebase>/openCARP/docker
./install_script.sh <installation-prefix>

Where installation-prefix should be replaced with the location where opencarp-docker should be installed (this location should be in your PATH). If you don't have admin rights, you may have to prefix the command with sudo.

For example, to install opencarp-docker to /usr/local/bin, run:

sudo ./install_script.sh /usr/local/bin

You can now run opencarp-docker followed by the appropriate subcommand.

Make sure the script is installed correctly:

opencarp-docker help

Pull the docker image:

opencarp-docker pull

Run openCARP:

opencarp-docker openCARP

For usage examples and more information, please refer to our docker/README.

Pull the docker image (Option 2)

Pull the latest openCARP docker image:

docker pull docker.opencarp.org/opencarp/opencarp:latest

Run the docker image using the following terminal command:

docker run -it docker.opencarp.org/opencarp/opencarp:latest

You are now in an isolated environment where openCARP is available. To get started, go to the directory containing the examples:

cd /openCARP/examples

and head over to the examples section.

NOTE: You can share a directory between your host machine and the docker container by running the container with the following command:

docker run -it -v /path/in/your/machine:/path/in/container docker.opencarp.org/opencarp/opencarp

Where /path/in/your/machine is the directory you want to access within the container, and /path/in/container is the location where it will be available within the container.

For usage examples and more information, please refer to our docker/README.

Visualization

For visualization, please refer to installation of meshalyzer and locally install meshalyzer because it is not included in the Docker container.