Install Guide

Install Guide
1. Basic Installation
2. Configuring Chaste

This is the place to start if you want to be able to build the Chaste source code, to run your own tests or simulations on your machine.

The easiest ways to install Chaste are:

On Ubuntu - use the Ubuntu .deb package.
On any platform - using Docker.
Other Linux systems - try following the instructions provided lower down this page
Mac OS X 'Yosemite' (and possibly other versions) - see InstallGuides/ChasteInstallationOnOSXYosemite, currently testing on Mojave InstallGuides/ChasteInstallationOnMacOSMojave
Any system - install a virtual machine (e.g. using VirtualBox) running the latest long-term support Ubuntu Linux, and install the Ubuntu package as above

Then obtain the source code, deciding whether you are a user or developer; see GettingStarted.

If you encounter any problems, or have/want an unusual setup, then the full DeveloperInstallGuide, or alternative guides listed at InstallGuides, may be useful.

Basic Installation

These instructions have been tried successfully on:

Fedora 24 (May 2017)
Fedora 25 (June 2017)

The following instructions detail an installation using the preferred versions of our dependencies, for a non-root user. For a full list of the compatibility of various versions of our dependencies see DependencyVersions. Some alternative versions of the libraries are incompatible, and others may have minor bugs.

NB: The newest versions of the libraries may not have been tested yet, so don't simply install the top one on each external download page! Ideally follow these instructions, but if this isn't possible (or you have pre-installed versions) then check DependencyVersions first.

Some pre-requisites

The following tools are required or useful. Most systems will already have these installed, or provide an easy way to set them up:

gcc and g++
gfortran --- if you want to build PETSc with HYPRE support (--download-hypre option below).
wget
python-devel
git --- git, for Code Developers or Code Users of development branches.
valgrind --- for memory testing - optional.

Since version 3.1, Chaste requires you to be using a 64 bit system. Almost all modern systems will be 64 bit. In the terminal, type

uname -m

If this returns i686, you have a 32 bit system, and you will not be able to use modern versions of Chaste.

Many systems will also include some of the below Chaste dependencies already. You can usually have a look for them with locate, e.g.

locate petsc

If you find pre-existing versions, then check DependencyVersions to see if they are compatible with Chaste, if so you may be able to skip their installation below, but make sure that you have the 'includes' and 'libraries' where required (if you don't know what this means then just follow all the below instructions!).

Define a folder to install all the dependencies in

First define the folder where you want to install the libraries that Chaste depends on. It is generally best if this is on a local hard disk for speed. We will also add the binary directory to the path right away, so we can run cmake (which we are about to install) without having to type the full path to this directory. How to do this depends on your shell, but if you are running bash the easiest way is to add it to your .bashrc file, e.g. using

gedit ~/.bashrc

At the end of the file add the following lines:

export CHASTE_LIBS=/home/scratch/chaste-libs

Save, quit and then re-load .bashrc (or log out and back in again):

source ~/.bashrc

If it doesn't already exist, create this directory:

mkdir -p $CHASTE_LIBS

The following instructions assume that:

wget is installed.
You are connected to the internet.

If either of these is not true, then download the http links in your browser and copy them onto the machine you wish to install on.

CMake

CMake is the recommended build system for Chaste, and is needed to build several of the dependencies listed below. Install CMake instead of Scons, unless you have a reason for doing otherwise.

On Fedora machines try the following line

sudo dnf install cmake

To install manually, use

wget http://www.cmake.org/files/v3.5/cmake-3.5.1.tar.gz
tar -zxf cmake-3.5.1.tar.gz
cd cmake-3.5.1
./bootstrap --prefix=$CHASTE_LIBS --parallel=4 && make -j4 && make install
cd ..
rm -rf cmake-3.5.1.tar.gz cmake-3.5.1

SCONS

Scons has been deprecated in favour of Cmake. These instructions are for legacy use of Scons only: unless you have a reason for installing Scons, it is recommended to skip this step.

wget http://prdownloads.sourceforge.net/scons/scons-2.3.1.tar.gz
tar zxf scons-2.3.1.tar.gz
cd scons-2.3.1
python setup.py install --prefix=$CHASTE_LIBS
cd ..
rm -rf scons-2.3.1.tar.gz scons-2.3.1

BOOST

On Fedora machines try the following line

sudo dnf install boost-system boost-filesystem boost-serialization boost-program-options

To install manually, use

wget http://downloads.sourceforge.net/project/boost/boost/1.58.0/boost_1_58_0.tar.gz
tar -zxf boost_1_58_0.tar.gz
cd boost_1_58_0
./bootstrap.sh --prefix=$CHASTE_LIBS --with-libraries=system,filesystem,serialization,program_options
./b2 install
cd ..
rm -rf boost_1_58_0.tar.gz boost_1_58_0

PETSc

Fedora provides a PETSc package, but unfortunately this does not currently contain all the files required to use PETSc with Chaste.

PETSc can install a lot of Chaste's dependencies for us.

(There is a --download-boost option, but this doesn't include the particular libraries we need, so we can't use that.)

These steps can take some time (potentially an hour or more).

cd $CHASTE_LIBS
wget http://ftp.mcs.anl.gov/pub/petsc/release-snapshots/petsc-lite-3.6.2.tar.gz
tar -zxf petsc-lite-3.6.2.tar.gz
rm -f petsc-lite-3.6.2.tar.gz
cd petsc-3.6.2

# Define package versions
MPICH=https://www.mpich.org/static/downloads/3.2/mpich-3.2.tar.gz
HDF5=https://support.hdfgroup.org/ftp/HDF5/releases/hdf5-1.8/hdf5-1.8.16/src/hdf5-1.8.16.tar.bz2

export PETSC_DIR=`pwd`

If you want to build PETSc with hypre, optionally remove --with-fc=0 and add --download-hypre=1 in the following code blocks. If you are not sure whether you want to build PETSc with hypre, leave the following as is.

export PETSC_ARCH=linux-gnu
./configure --with-make-np=4 --with-cc=gcc --with-cxx=g++ --with-fc=0 --with-x=false --with-ssl=false --download-f2cblaslapack=1 --download-mpich=$MPICH --download-hdf5=$HDF5 --download-parmetis=1 --download-metis=1 --download-sundials=1 --with-shared-libraries
make all test

# Optional - optimised petsc build too.
export PETSC_ARCH=linux-gnu-opt
./configure --with-make-np=4 --with-cc=gcc --with-cxx=g++ --with-fc=0 --with-x=false --with-ssl=false --download-f2cblaslapack=1 --download-mpich=$MPICH --download-hdf5=$HDF5 --download-parmetis=1 --download-metis=1 --download-sundials=1 --with-shared-libraries --with-debugging=0
make all test

unset PETSC_ARCH
unset PETSC_DIR

XSD

On Fedora machines try the following line

sudo dnf install xsd

To install manually, use the distributed binaries.

cd $CHASTE_LIBS
wget http://www.codesynthesis.com/download/xsd/4.0/linux-gnu/x86_64/xsd-4.0.0-x86_64-linux-gnu.tar.bz2
tar -xjf xsd-4.0.0-x86_64-linux-gnu.tar.bz2
ln -s $CHASTE_LIBS/xsd-4.0.0-x86_64-linux-gnu/bin/xsd $CHASTE_LIBS/bin/xsd
rm -f xsd-4.0.0-x86_64-linux-gnu.tar.bz2

XERCES

On Fedora machines try the following line

sudo dnf install xerces-c xerces-c-devel

For machines without a system Xerces package:

wget https://archive.apache.org/dist/xerces/c/3/sources/xerces-c-3.1.4.tar.gz
tar -zxf xerces-c-3.1.4.tar.gz
cd xerces-c-3.1.4/
export XERCESCROOT=`pwd`
./configure --prefix=$CHASTE_LIBS
make all
make install
cd $CHASTE_LIBS
rm -rf xerces-c-3.1.4 xerces-c-3.1.4.tar.gz

PyCml dependencies

On Fedora machines try the following line

sudo dnf install python-lxml python-amara python-rdflib python-dateutil

If you cannot get these via your package manager, python package installs are generally smoothest using pip. Either install as a system package, e.g. sudo dnf install python-pip, or follow the instructions here. Unfortunately some of Amara's dependencies are so old, we need to use easy_install for that. It will probably already be installed, but you can sudo dnf install python-setuptools or similar if not.

pip install --user "python-dateutil==1.5"
easy_install --user "Amara==1.2.0.2"
pip install --user "rdflib==2.4.2"
pip install --user lxml

VTK

One of the following commands may well work on your system:

sudo apt-get install libvtk6-dev       #(Ubuntu/Debian)
sudo dnf install vtk-devel             #(Fedora/RedHat)

Otherwise, from source:

wget http://www.vtk.org/files/release/6.2/VTK-6.2.0.tar.gz
tar -zxf VTK-6.2.0.tar.gz
rm -f VTK-6.2.0.tar.gz
cd VTK-6.2.0
cmake -DCMAKE_INSTALL_PREFIX=$CHASTE_LIBS . && make -j4 && make install
cd ..
rm -rf VTK-6.2.0

You may need to:

sudo dnf install mesa-libGL-devel (or similar) to get OpenGL headers installed before this point, if you get a configure error stating that these headers have not been found
sudo dnf install redhat-rpm-config (or similar) if you get gcc: error: /usr/lib/rpm/redhat/redhat-hardened-cc1: No such file or directory
sudo dnf install libxt-devel (or similar) if you get an error about X11

Setting paths automatically

You probably then want to add various environment variables specifying these dependency locations to your .bashrc file, e.g. using

gedit ~/.bashrc

At the end of the file add the lines (leaving out packages you installed via a package manager):

export PETSC_DIR=$CHASTE_LIBS/petsc-3.6.2
export PETSC_ARCH=linux-gnu

export SUNDIALS_ROOT=$PETSC_DIR/$PETSC_ARCH

export HDF5_ROOT=$PETSC_DIR/$PETSC_ARCH

export XERCES_INCLUDE_DIR=$CHASTE_LIBS/include
export XERCES_LIBRARY_DIR=$CHASTE_LIBS/lib

export XSD_ROOT=$CHASTE_LIBS/xsd-4.0.0-x86_64-linux-gnu

Save, quit and then re-load .bashrc (or log out and back in again):

source ~/.bashrc

Configuring Chaste

Once you've installed the dependencies as above, you need to get hold of the Chaste code. See GettingStarted for the options to pick here.

Again, machines that use the Ubuntu package are handled automatically - you are ready to go.

Once you've done this, you are ready to build and run the test suite, see ChasteGuides/CmakeFirstRun.