For Ubuntu/Debian systems, please download the DEB packages in https://opencarp.org/deb/
We recommand to install the package via
apt-get. For example,
cd <path-to-your-downloaded-deb-file> apt-get update apt-get install ./opencarp-0.1-Linux.deb
For CentOS/Fedora systems, please download the RPM packages in https://opencarp.org/rpm/
We recommand to install the package via
dnf. For example,
cd <path-to-your-downloaded-rpm-file> dnf install ./opencarp-0.1-Linux.rpm
We are currently setting up installers for macOS. At the moment, please use Docker or source installation (see below).
First, install Docker for your platform.
There are 2 options for the openCARP installation using Docker.
Pull the latest openCARP docker image:
docker pull docker.opencarp.org/opencarp/opencarp:latest
Pull the latest openCARP developer docker image (only required for openCARP developers):
docker pull docker.opencarp.org/opencarp/opencarp/dev:latest
Run the docker image using the following terminal command:
docker run -it docker.opencarp.org/opencarp/opencarp:latest
You can now use openCARP. Head over to the experiments section to get started.
Docker provides a variety of commands to utilize docker images:
To help you quick start, our script wraps the most commonly used docker commands.
Tell the install script where to place the binary files (should be a diretory in your
sudo if admin permission is required to write there:
cd <path-to-your-codebase>/openCARP/docker ./install_script.sh <path-to-your-bin>
For example, to install to
sudo ./install_script.sh /usr/local/bin
The script enables you to start with the keyword
opencarp-docker followed by the appropriate command.
Make sure the script is installed correctly:
Pull the docker image:
For usage examples and more information, please refer to our docker/README.
For visualization, please also refer to installation of meshalyzer and locally install meshalyzer because it is not included in the Docker container.
First install the following openCARP prerequisites using your package manager or from their official release.
Tips for installing
PETSc: If you are not experienced with its various configurations, please refer to the following suggestions.
--prefix= to the location you would install PETSc.
After installation, set the location installed PETSc for the environment variable
./configure \ --prefix=/opt/petsc \ --download-mpich \ --download-fblaslapack \ --download-metis \ --download-parmetis \ --download-hypre \ --with-debugging=0 \ COPTFLAGS='-O2' \ CXXOPTFLAGS='-O2' \ FOPTFLAGS='-O2' make all make install
If you have all the listed dependencies, a quick way to get openCARP up and running is the following:
Clone the repository and enter the codebase folder
git clone https://git.opencarp.org/openCARP/openCARP.git cd openCARP
We provide CMake files and Makefiles for building the codebase, choose one fits your workflow.
Run CMake to create the
_build build folder
cmake -S. -B_build
Compile the codebase, and all built executables are located in the
cmake --build _build
(Optional) You can also install the executables to the system using
cmake --build _build --target install
The codebase can be compiled using
This target includes updating the codebase (
make update) and code compilation (
Links to all compiled executables are located in the
If you would like to install everything locally, please also refer to, install carputils from source, the meshtool main page, and installation of meshalyzer.
Download the openCARP examples to the location of your choice using
git clone https://git.opencarp.org/openCARP/experiments.git.
A quick way to get started is pulling the openCARP docker image.
Install Python3 packages using
pip3 install --upgrade pip pip install scipy matplotlib numpy pandas scipy tables
Clone the carputils repository.
git clone https://git.opencarp.org/openCARP/carputils.git
carputils/bin to your
carputils to your
For example, if you clone carputils to
$HOME/install, add the following lines in your .bashrc:
export PATH=$PATH:$HOME/install/carputils/bin export PYTHONPATH=$PYTHONPATH:$HOME/install/carputils
Download a settings file for carputils. Specify the proper directories for openCARP-CPU and other openCARP tools if you use them. For example,
Rename the settings file to
settings.yaml and put it in the root directory of the carputils.
Meshalyzer is a graphical program for display time dependent data on 3D finite elment meshes. Of course, it can show static data on fewer dimensions as well. It is developed to be compatible with the cardiac simulation environment openCARP.
It uses IGB and its own file formats which are simple and easily converted to/from more popular formats like VTK.
Meshalyzer is regularly used on Linux and Mac machines. It has worked under Windows as well.
Except for fltk, using your package manager is recommended for installing these packages if possible. On macOS, you could use homebrew.
If VTK is installed, edit the make.conf to set the
VTK_DIR variables to point to the directories containing the VTK header files and libraries, respectively. Comment them out otherwise.
For the windowless version, type
The compiled executables will be found in the src/ directory.
To compile the doucmentation a LaTeX package is required. Follow the steps described below to create the Meshalyzer manual.