TerraTools
Tools to read, analyse and visualise models written by the TERRA mantle convection code. TerraTools is released under an MIT License.
Homepage: https://terratools.readthedocs.io/en/latest/
Documentation: https://terratools.readthedocs.io/en/latest/
Source code: https://github.com/mantle-convection-constrained/terratools
DOI for this version: 10.5281/zenodo.10797186
Citing TerraTools
We are currently writing a paper for submission to JOSS. Watch this space.
Installation
Pre-installation
Before installing TerraTools, first install and/or upgrade your version of pip:
python -m ensurepip --upgrade
TerraModel.plot_layer), make sure you have a working installation of Cartopy, as installation of Cartopy using pip requires additional dependencies are met first. On Mac machines, you may find that after you follow the instructions on that site, you still need to add the following command to your ~/.bashrc or equivalent:
export DYLD_LIBRARY_PATH=/opt/homebrew/opt/geos/lib/
Installing the latest released version
To install the latest released version of TerraTools, please use:
python -m pip install terratools
Installing the development version
You can also install the latest development version of TerraTools from source. To do this, first clone the repository onto your local machine using git:
git clone git@github.com:mantle-convection-constrained/terratools.git
cd terratools; python -m pip install -ve .
Post-installation
Finally, check you have a fully working installation:
python -c "import terratools"
Reporting bugs
If you would like to report any bugs, please raise an issue on GitHub.
Contributing to TerraTools
If you would like to contribute bug fixes, new functions or new modules to the existing codebase, please fork the terratools repository, make the desired changes and then make a pull request on GitHub.
Acknowledgement and Support
This project is supported by NERC Large Grant MC-squared.