Metadata-Version: 2.1
Name: terratools
Version: 0.1.0
Summary: Tools to read, analyse and visualise models written by the TERRA mantle convection code.
Home-page: https://github.com/mantle-convection-constrained/terratools
License: MIT
Author: James Panton
Author-email: pantonjc@cardiff.ac.uk
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Requires-Dist: Cartopy (>=0.21.0,<0.22.0)
Requires-Dist: matplotlib (>=3.5,<4.0)
Requires-Dist: netcdf4 (>=1,<2)
Requires-Dist: numpy (>=1.23,<2.0)
Requires-Dist: scikit-learn (>=1.1.2,<2.0.0)
Requires-Dist: scipy (>=1.6,<2.0)
Project-URL: Documentation, https://readthedocs.org/projects/terratools
Project-URL: Repository, https://github.com/mantle-convection-constrained/terratools
Description-Content-Type: text/markdown

# 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/](https://terratools.readthedocs.io/en/latest/)<br>
Documentation: [https://terratools.readthedocs.io/en/latest/](https://terratools.readthedocs.io/en/latest/)<br>
Source code: [https://github.com/mantle-convection-constrained/terratools](https://github.com/mantle-convection-constrained/terratools)

## Citing TerraTools
We are currently writing a paper for submission to JOSS. Watch this space.

## Reporting bugs
If you would like to report any bugs, please raise an issue on [GitHub](https://github.com/mantle-convection-constrained/terratools/issues).

## 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](https://github.com/mantle-convection-constrained/terratools/pulls).

## Acknowledgement and Support
This project is supported by [NERC Large Grant MC-squared](https://www.cardiff.ac.uk/research/explore/find-a-project/view/2592859-mc2-mantle-circulation-constrained).
