- A Python framework that supports the develoment of machine learning models, big and small, for Earth system science
- Suitable for students and newcomers, as well as for domain specialists and scientists
- Runs effectively on HPC (supercomputers), cloud, workstations and laptops
- Suitable for use with megabytes to petabytes of data
- Still under early-stage development - things are likely to change a lot. If you notice an issue, please feel free to raise it on GitHub
![]() A weather prediction from a model trained with PyEarthTools. |
A data processing flow composed for working with climate data. |
|---|
Source Code: github.com/ACCESS-Community-Hub/PyEarthTools
Documentation: pyearthtools.readthedocs.io
Tutorial Gallery: available here
New Users Guide: available here
If you use PyEarthTools for your work or a publication, please cite our work.
Here is the quickest way to install the complete framework and get started:
We strongly recommend using either a Conda or Python virtual environment.
Run the following commands to install PyEarthTools in a Conda environment:
git clone [email protected]:ACCESS-Community-Hub/PyEarthTools.git
cd PyEarthTools
conda create -y -p ./venv python=3.13 graphviz
conda activate ./venv
pip install -r requirements.txt
cd notebooks
jupyter labAlternatively, run the following commands to install PyEarthTools in a Python virtual environment:
git clone [email protected]:ACCESS-Community-Hub/PyEarthTools.git
python3 -m venv ./venv
source venv/bin/activate
pip install -r requirements.txt
cd notebooks
jupyter labTip
(Optional) Install Graphviz (not installable via pip) to display pipelines.
PyEarthTools comprises multiple sub-packages which may be installed and used separately. See the installation guide for more details.
PyEarthTools is a Python framework containing modules for:
- loading and fetching data;
- pre-processing, normalising and standardising data into a normal form suitable for machine learning;
- defining machine learning (ML) models;
- training ML models and managing experiments;
- performing inference with ML models;
- and evaluating ML models (coming soon).
PyEarthTools runs effectively on HPC (supercomputers), cloud, workstations and laptops.
PyEarthTools comprises multiple sub-packages which can be used individually or together.
| Sub-Package | Purpose |
|---|---|
| Data | Loading and indexing Earth system data into xarray |
| Utils | Code for common functionality across the sub-packages |
| Pipeline | Process and normalise Earth system data ready for machine learning |
| Training | Training processes for machine learning models |
| Tutorial | Contains helper code for data sets used in tutorials |
| Bundled Models | Maintained versions of specific, bundled models which can be easily trained and run |
| Zoo | Contains code for managing registered models (such as the bundled models) |
| Evaluation | (Coming soon) Contains code for producing standard evaluations (such as benchmarks and scorecards) |
If you use PyEarthTools for your work, we would appreciate you citing our software as below:
Leeuwenburg, T., Cook, H., Rio, M., Hobeichi, S., Miller, J., Mason, G., Ramanathan, N., Pill, J., Haddad, S., Stassen, C., de Burgh-Day, C., Holmes, R., Potokina, M., Bogacheva, J., James, M., & Sullivan, B. (2025). PyEarthTools: Machine learning for Earth system science (0.5.1). Zenodo. https://doi.org/10.5281/zenodo.17544431
BibTeX:
@software{leeuwenburg_2025_17544431,
author = {Leeuwenburg, Tennessee and
Cook, Harrison and
Rio, Maxime and
Hobeichi, Sanaa and
Miller, Joel and
Mason, Gemma and
Ramanathan, Nikeeth and
Pill, John and
Haddad, Stephen and
Stassen, Christian and
de Burgh-Day, Catherine and
Holmes, Ryan and
Potokina, Margarita and
Bogacheva, Jenya and
James, Matthew and
Sullivan, Ben},
title = {PyEarthTools: Machine learning for Earth system
science
},
month = nov,
year = 2025,
publisher = {Zenodo},
version = {0.5.1},
doi = {10.5281/zenodo.17544431},
url = {https://doi.org/10.5281/zenodo.17544431},
}
