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:
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.
This tutorial is available to run within Github Codespaces - "a development environment that's hosted in the cloud"
☝️ Click the button above to go to options window to launch a Github codespace.
GitHub currently gives every user 120 vCPU hours per month for free, beyond that you must pay. So be sure to explicitly stop or shut down your codespace when you are done by going to this page (https://github.com/codespaces).
You can also use the GitHub CLI to launch a codespace
# This will output a URL to use VSCode in the browser
gh codespace create --repo xarray-contrib/xarray-tutorial
# Optionally launch JupyterLab instead of vscode (after codespace has been created)
gh codespace jupyter
You can also run these notebooks on your own computer! We recommend using pixi to ensure a fully reproducible Python environment:
git clone https://github.com/xarray-contrib/xarray-tutorial.git
cd xarray-tutorial
pixi run tutorialTo build and serve the tutorial website locally with live reload:
pixi run watch
This watches for changes, rebuilds, and serves at http://localhost:8000.
To build without serving:
pixi run build
Contributions are welcome and greatly appreciated! See our CONTRIBUTING.md document.
Thanks to our contributors so far!
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 material development specifically was supported by NASA's Open Source Tools, Frameworks, and Libraries Program (award 80NSSC22K0345).