Title here
Summary here
Code Repository Access
We offer read-only access to the Chaste repository for anyone. This access is
provided with the caveat that the code is always in development (and the
develop branch is not guaranteed to be passing all tests), and we will not be
able to provide full support for between-release versions of the code. New users
should therefore download one of the source releases, or instructions are given
here on how to use git to get a released version. If you want to develop Chaste
and contribute back to the project you have to create a new branch off the
develop branch.
The repository uses Git to manage code versioning. You can clone from GitHub via an IDE plug-in, or by using a command-line client. To create a new directory called Chaste with a copy of the Chaste repository do:
git clone -b develop https://github.com/Chaste/Chaste.git
Note that this command will setup your local branch to point to the develop
branch of the remote repository. There are other options:
| Branch | What it’s for |
|---|---|
develop | Bleeding-edge development code, new feature (issue) branches should branch off here to minimise conflicts |
| Release Tags | Released code for a certain Chaste version (e.g. 2024.1), also accessible from GitHub with nice instructions! |
Which branch you use is up to you, if you are using Chaste for the basis of a paper we’d suggest either using:
develop– you might have to wait a few months for an official release, but will get most of the latest features; or- The latest release tag – for the latest full release of Chaste. Past releases are all tagged in the git repository, or you can download them from GitHub.
To get a release via the source code do the above git clone command then:
cd Chaste
git tag
This will list all available release tags. It should be evident which is which and you can get a copy with e.g.
git checkout 2024.1
Alternatively, you can clone a release tag directly with a single command:
git clone -b 2024.1 https://github.com/Chaste/Chaste.git