Xarray Tutorial

This is the repository for a Jupyter Book website with tutorial material for Xarray, an open source project and Python package that makes working with labelled multi-dimensional arrays simple, efficient, and fun!

The website is hosted at https://tutorial.xarray.dev

Tutorials are written as interactive Jupyter Notebooks with executable code examples that you can easily run and modify:

On the Cloud

All notebooks can be run via the Mybinder.org 'Launch Binder' badge at the top of this page. This will load a pre-configured JupyterLab interface with all tutorial notebooks for you to run. You have minimal computing resources and any changes you make will not be saved.

Locally

You can also run these notebooks on your own computer! We recommend using micromamba or conda-lock to ensure a fully reproducible Python environment:

git clone https://github.com/xarray-contrib/xarray-tutorial.git
cd xarray-tutorial

conda-lock install conda/conda-lock.yml --name xarray-tutorial
# Or `micromamba create -n xarray-tutorial -f conda-lock.yml`
# Or latest package versions: `mamba env create -f conda/environment-unpinned.yml`

conda activate xarray-tutorial
jupyter lab

Contributing

Contributions are welcome and greatly appreciated! See our CONTRIBUTING.md document.

Thanks to our contributors so far!

Acknowledgements

This website is the result of many contributions from the Xarray community! We're very grateful for everyone's volunteered effort as well as sponsored development. Funding for SciPy 2022, SciPy 2023 tutorial materialdevelopment specifically was supported by NASA's Open Source Tools, Frameworks, and Libraries Program (award 80NSSC22K0345).