terratools: A Python package to analyse TERRA mantle convection simulations
terratools: A Python package to analyse TERRA mantle convection simulations - Published in JOSS (2025)
Science Score: 89.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 4 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
7 of 13 committers (53.8%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords from Contributors
Repository
Tools to read, analyse and visualise models written by the TERRA mantle convection code
Basic Info
- Host: GitHub
- Owner: mantle-convection-constrained
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://terratools.readthedocs.io/en/latest/
- Size: 1.87 MB
Statistics
- Stars: 7
- Watchers: 4
- Forks: 7
- Open Issues: 11
- Releases: 5
Metadata Files
README.md
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
Citing TerraTools
We are currently have a JOSS Paper in review, watch this space.
Installation
Requirements
TerraTools requires Python version 3.9 or newer.
If you want to use the map plotting functions (such as TerraModel.plot_layer), make sure you have a working installation of Cartopy.
Pre-installation
If you are using a Conda-like package manager (e.g.,
Miniconda or
Mamba), we recommend always
creating a new environment
for each project you are working on into which you install TerraTools.
For instance:
sh
conda create -n amazing_mantle_convection_project python=3.11
conda activate amazing_mantle_convection_project
This is entirely optional but often prevents issues with dependency version conflicts.
Installing the latest released version
Installation with pip
Before installing TerraTools with pip, first install and/or upgrade your
version of pip:
sh
python -m ensurepip --upgrade
To install the latest released version of TerraTools, then do:
sh
python -m pip install terratools
Installation with dependency management systems
If you use a dependency management system such as
Poetry or Pipenv
you should add terratools as a dependency of your project.
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:
sh
git clone https://github.com/mantle-convection-constrained/terratools.git
Then navigate to the top level directory and install in development mode:
sh
cd terratools; python -m pip install -ve .
Post-installation
Finally, check you have a fully working installation:
sh
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.
JOSS Publication
terratools: A Python package to analyse TERRA mantle convection simulations
Authors
School of Earth and Environment, University of Leeds, UK
School of Earth and Environmental Sciences, Cardiff University, UK
School of Earth and Environment, University of Leeds, UK
School of Earth Sciences, University of Bristol, UK
Department of Earth Sciences, University of Oxford, UK
School of Earth Sciences, University of Bristol, UK
School of Earth and Environmental Sciences, Cardiff University, UK
Editor
Kristen Thyng
Tags
Earth sciences mantle convectionGitHub Events
Total
- Issues event: 14
- Watch event: 1
- Delete event: 11
- Issue comment event: 41
- Push event: 26
- Pull request review comment event: 1
- Pull request review event: 3
- Pull request event: 25
- Fork event: 1
- Create event: 14
Last Year
- Issues event: 14
- Watch event: 1
- Delete event: 11
- Issue comment event: 41
- Push event: 26
- Pull request event: 24
- Pull request review comment event: 1
- Pull request review event: 3
- Fork event: 1
- Create event: 14
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Andy Nowacki | a****i@l****k | 94 |
| James Panton | p****c@c****k | 92 |
| Bob Myhill | m****b@g****m | 54 |
| James Ward | e****a@l****k | 37 |
| eejwa | e****a@l****k | 31 |
| James Panton | j****3@g****m | 23 |
| James Wookey | j****y@b****k | 9 |
| Andrew Walker | a****r@e****k | 7 |
| dependabot[bot] | 4****]@u****m | 2 |
| Andy Nowacki | a****i@g****m | 1 |
| Franck Latallerie | f****e@u****r | 1 |
| James Wookey | g****w@b****k | 1 |
| daviesjh2 | d****2@u****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 5 months ago
All Time
- Total issues: 41
- Total pull requests: 159
- Average time to close issues: 4 months
- Average time to close pull requests: 7 days
- Total issue authors: 9
- Total pull request authors: 8
- Average comments per issue: 1.66
- Average comments per pull request: 0.35
- Merged pull requests: 137
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 6
- Pull requests: 15
- Average time to close issues: 4 months
- Average time to close pull requests: about 2 months
- Issue authors: 3
- Pull request authors: 3
- Average comments per issue: 1.33
- Average comments per pull request: 0.33
- Merged pull requests: 8
- Bot issues: 0
- Bot pull requests: 1
Top Authors
Issue Authors
- anowacki (26)
- andreww (3)
- bobmyhill (3)
- jwookey (2)
- bch0w (2)
- jamespanton93 (2)
- eejwa (1)
- aadelfareed (1)
- FranckLatallerie (1)
Pull Request Authors
- jamespanton93 (57)
- bobmyhill (49)
- anowacki (39)
- eejwa (6)
- jwookey (5)
- andreww (1)
- daviesjh2 (1)
- dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 123 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 6
- Total maintainers: 3
pypi.org: terratools
Tools to read, analyse and visualise models written by the TERRA mantle convection code.
- Homepage: https://github.com/mantle-convection-constrained/terratools
- Documentation: https://readthedocs.org/projects/terratools
- License: MIT
-
Latest release: 1.2.0
published 3 months ago
Rankings
Maintainers (3)
Dependencies
- jinja2 >=3.0.2
- markdown >=3.2
- mkdocs >=1.3.0
- mkdocs-material-extensions >=1.0.3
- pygments >=2.12
- pymdown-extensions >=9.4
- ipython ^8.5.0 develop
- Cartopy ^0.21.0
- matplotlib ^3.5
- netcdf4 ^1
- numpy ^1.23
- python ^3.8
- scikit-learn ^1.1.2
- scipy ^1.6
- actions/checkout v2 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/upload-artifact v2 composite