wiki:GettingStarted

Getting Started

Chaste requires users to obtain and compile the source code, which can be used to run cardiac electro-physiological and electro-mechanical simulations, discrete tissue simulations (including intestinal crypt simulations), and more.

Chaste can be used on Linux and Mac OS X, and has some limited and experimental support for Windows. The recommended operating system for using Chaste is Ubuntu Linux.

Chaste is primarily developed on Ubuntu Linux, and is regularly tested on all Long Term Support (LTS) versions, but should also work on other Linux/Unix systems. Since release 3.2 (May 2014), Chaste is additionally supported and tested on Mac OS X. While there is partial support for Windows, it is not currently recommended to use Chaste on Windows.

The recommended route for unsupported systems is to install Chaste on a virtual machine running Ubuntu Linux.

Updated svg version of Chaste Users file

Getting the Code

First, you need to decide whether to download a release, or check out a development version of the code.

Code Users

Users can access the Chaste source code on our GitHub repository. There are two options:

  1. Download a release of Chaste, found on the releases page
  2. Check out one of our tested development branches using git

The first option is most stable, and recommended for new users. The second option will give you access to the latest features we're working on.

Code Developers

New code developers should check out Chaste from the developer repository.

Reading ChasteGuides/ExternalDeveloperGuide is highly recommended, and then you can check out a copy of the development code as per ChasteGuides/AccessCodeRepository.


Perusing the release notes and latest news can give you a good overview of what features are in each release, and what has been added since.

Installing Dependencies

However you choose to access the source code, various things need to be installed.

Chaste uses cmake as the project builder; the third party dependencies include MPI, PETSc, HDF5 and others; and if you wish to do programming yourself, then we recommend using a C++ integrated development environment such as Eclipse or Clion.

All of these need to be installed. The easiest method is to use Ubuntu Linux, for which a package is available - see InstallGuides/UbuntuPackage. If you are not using Ubuntu Linux, go to the InstallGuide and follow the instructions on installing dependencies (or use the installation guide supplied with the release).

Once you installed the dependencies, and have obtained the source code, go to ChasteGuides and read and run the tutorials on the kind of simulation you wish to run.

Getting Help

For general discussion about Chaste, and questions regarding usage, we provide the Chaste users' mailing list. You can subscribe to the list by following these instructions. Public list archives are available.

Bug reports and feature requests may be submitted using this website; please register for an account in order to do so.

This Website

This is the Chaste developers' Trac system, which provides a wiki, access to the source repository, and ticketing system. If you wish to submit or comment on public bug reports and feature requests, please register for an account.

Last modified 6 days ago Last modified on May 19, 2017, 4:04:48 PM

Attachments (5)