Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 2.07 KB

README.md

File metadata and controls

38 lines (28 loc) · 2.07 KB

Welcome to Chaste

If you are new to Chaste please see our Getting Started wiki page.

The files you have downloaded contain the source code for all Chaste functionality. Chaste makes use of a variety of external libraries and packages that need to be installed on your machine. The Install Guide wiki page provides a comprehensive guide on how to install these external tools.

Chaste is distributed as open source software under the 3-clause BSD licence. For full details see the file Copying.pdf. Chaste uses various third party libraries which have their own licences. For details of these licences and the impact they may have on your use of Chaste please see Licences.html.

Chaste includes a complete test suite covering all the source code. The easiest way to use existing source codes is to create a test file which can call upon any of the source files.
The Chaste build system can build this file for you and handle all of the dependencies and library calls.

We suggest you use the projects directory in this manner to store your own source and test files if you do not wish to modify the Chaste source code. For more information, see the User Projects wiki page.

For more information please refer to the Chaste website at: http://www.cs.ox.ac.uk/chaste/

Information on changes in this release can be found in the file ReleaseNotes.html.

Tutorial examples for this release are available at: https://chaste.cs.ox.ac.uk/chaste/tutorials/release_2018.1

API documentation generated from the code by Doxygen is available at: https://chaste.cs.ox.ac.uk/chaste/docs/release_2018.1

Chaste welcomes contributions from the community. For information on how to contribute to Chaste, and for support and bug reports, please see the file CONTRIBUTING.md.