CARPentry - The Simulation Core

The CARPentry Modelling Environment (CME) is currently available and supported for both Mac OS X and Linux. It has also been used on Windows 10 with Windows Subsystem for Linux (WSL). CME comes with electrophysiology support on up to 16 cores and is available for public use by researchers with citation. To install, please download the relevant CME package [Linux download , Mac OS X download] and follow the system specific installation instructions detailed below.

The source CARP with support of electrophysiology, mechanics, and fluids with no limitation on compute cores is only available to specific collaborators and partners.


System Requirements

Installations have only been tested on OS X 10.11 to 10.13. General system requirements include:

  • homebrew
/usr/bin/ruby -e "$(curl -fsFL"
  • Xcode: download from App Store. If working with an older OSX, Xcode can be downloaded from apple developer.
xcode-select --install


The CME Mac OSX package is a tarball consisting of:

  • CME Mac OSX binaries
  • Installer script:
  • Empty settings file: settings.yaml

Within a terminal window, please create an installation directory ($INSTALL_DIR). For example, a suggested location is $INSTALL_DIR=$HOME/install/cme. Then move the to the install directory and unpackage it:

cp ~/Downloads/ .
tar -xvf

Navigate into directory and run the installation script.


If not already installed, the install script will install and update necessary dependencies including wget and libpng. Throughout installation, input is required:

  • root passwoord for system linking of fltk (dependency for meshalyzer)
  • Permission for manual configuration of environment in bashrc file (~/.bashrc)

After completion, the shell environment needs to be reloaded. Please test the installation using the testing instructions below. If you experience troubles with the installation, please send the build.log to Christoph.


System Requirments

All linux distributions are currently supported. The requirements for building PETSc and MPICH are:

  • C and Fortran compilers
  • cmake
  • git

Please install using your specific system’s package management software.


The Linux CME releases are provided as tarballs consisting of:

  • CME binaries
  • Carp-examples: tutorials and carputils
  • MPICH MPI sources
  • PETSc sources
  • Installer script:

The CME binaries have been compiled using PETSc (with external packages) and MPICH MPI. The provided installer script can be used to build PETSc and MPI and install the CME binaries. When installing multiple releases, PETSc and MPI do not need to be installed multiple times. Instead, the associated setup steps can be skipped.

Then, the installer script should be executed. After completion, the shell environment needs to be reloaded. Please test the installation using the instructions below.


After reloading your shell environment, please test that the following binaries are executable outside the CME bin directory.

  • bench
  • carpentry
  • meshtool
  • meshalyzer