wiki:GettingStarted

Using Chaste

Chaste is a software library. To use it you need to obtain and compile the source code, which can then be used to build and run cardiac electro-physiological and electro-mechanical simulations, discrete tissue simulations (including intestinal crypt simulations), and more.

Supported Operating Systems

  • Linux: Chaste is primarily developed on Ubuntu Linux (recommended), and is regularly tested on all Long Term Support (LTS) versions of Ubuntu, but should also work on other Linux/Unix systems.
  • MacOS: Chaste is supported and tested on Mac OS X.
  • Windows: While there is partial/experimental 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.

Getting The Code

If you are primarily interested in using the code as it is, and don't plan to contribute new code or changes back to the core Chaste code you can either:

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

and follow subsequent User's guides. 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. Note: using this approach you can only download/get updates of the code, but can't contribute new code or changes back to the core Chaste code.

Alternatively, if you are planning on contributing back to the codebase, you should check out Chaste from the developer repository and follow the Developer's guides. Reading ChasteGuides/ExternalDeveloperGuide is highly recommended, and then you can check out a copy of the development code as per ChasteGuides/AccessCodeRepository.

The image below shows how the Github and developer repositories are related and the methods for obtaining code as Users and Developers.

Updated svg version of Chaste Users file


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

Chaste has several dependencies, including MPI, PETSc, HDF5 and others, which should be installed prior to compilation. If you are using Ubuntu Linux it is easiest to do this using the Chaste Debian package - see InstallGuides/UbuntuPackage.

Otherwise you should use the InstallGuide and follow the instructions on installing dependencies (or use the installation guide supplied with the release).

In addition to software dependencies, if you wish to do programming yourself, then we recommend using a C++ integrated development environment such as Eclipse or Clion.

Next Steps

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.

About 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 7 weeks ago Last modified on Jun 5, 2017, 11:40:50 AM

Attachments (5)