CME - Installation

The CME is distributed in binary form only.

Flavor

The CME is made available as

  • Free version The free version comprises all electrophysiology components, but excludes any other physics. Further, the number of cores that can be used in a single simulation is limited to \le 16.
  • Full version supports multiphysics simulations, there is no number on the number of cores that can be used in a single simulation.

Operating systems

The main operating system for running CARPentry is Linux. There are working installations under Mac OS X, but binary packaging is not in place yet. With the advent of Linux-subsystems in Win 10 supporting this platform as well seems feasible, but this will depend on resources available for packaging and user demands.

Status of Availability

Installing the Linux version

The Linux CME releases are provided as tarballs consisting of:

  • CME binaries
  • MPICH MPI sources
  • PETSc sources
  • Installer script
  • License file

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 and the license file. When installing multiple releases, PETSc and MPI do not need to be installed multiple times. Instead, the associated setup steps can be skipped.

The requirements for building PETSc and MPICH are:

  • C and Fortran compilers
  • cmake
  • git

First those requirements need to be installed using the system’s package management software. Then, the installer script should be executed. After completion, the shell environment needs to be reloaded. Now you are ready for simulations using the CARPentry Modeling Environment.

Installing the Mac OSX verison

Warning

The CME binary for Mac OS X is still under developement. The current version may not be complete or apply to all systems. For this reason, the linux version is highly recommended. For questions, feedback, or concerns please contact karli.gillette@medunigraz.at .

The Mac OSX CME releases are provided as tarballs consisting of:

  • CME Mac OSX binaries
  • Installer script
  • License file
  • Empty settings file

The requirements for running the installer script and running cme.free.osx include:

  • homebrew
/usr/bin/ruby -e "$(curl -fsFL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  • Xcode: download from App Store. If working with an older OSX, Xcode can be downloaded from apple developer.
xcode-select --install
  • gcc, wget, and libpng:
brew install gcc
brew install wget
brew install libpng

The installer script will automatically download carp-examples and meshalyzer, as well as configure all settings. Please execute the installer script from the root directory cme.free.osx. Note that if you have a working installation of carp-examples and meshalyzer already, please configure settings manually and do not run the installation script.