Skip to content

Commit a282117

Browse files
Add xCDAT tutorial datasets and update gallery notebooks (#705)
- **Updated Jupyter Notebooks** to replace ESGF OPeNDAP datasets with data from **xCDAT/xcdat-data**. - **Added `xcdat.tutorial` module** with the `xcdat.tutorial.open_dataset()` function, modeled after `xarray.tutorial.open_dataset()`. - Included `xcdat.tutorial.open_dataset()` in the API reference documentation. - **Added `pooch` as an optional dependency**, updating: - `conda-env/dev.yml` - `pyproject.toml` - Installation documentation
1 parent c52b5a7 commit a282117

17 files changed

+10537
-9847
lines changed

conda-env/ci.yml

+1
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ dependencies:
2424
# ==================
2525
- pytest
2626
- pytest-cov
27+
- pooch # Required for xarray tutorial data

conda-env/dev.yml

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ dependencies:
3232
- pandoc
3333
- ipython # Required for nbsphinx syntax highlighting
3434
- gsw-xarray # Required for vertical regridding example
35+
- pooch # Required for xarray tutorial data
3536
# Quality Assurance
3637
# ==================
3738
- types-python-dateutil

docs/api.rst

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Below is a list of top-level API functions that are available in ``xcdat``.
3434
create_grid
3535
create_uniform_grid
3636
create_zonal_grid
37+
tutorial.open_dataset
3738

3839
Accessors
3940
---------

docs/demos/1-25-23-cwss-seminar/introduction-to-xcdat.ipynb

+1,070-689
Large diffs are not rendered by default.

docs/examples/climatology-and-departures.ipynb

+1,556-2,216
Large diffs are not rendered by default.

docs/examples/general-utilities.ipynb

+2,152-1,406
Large diffs are not rendered by default.

docs/examples/introduction-to-xcdat.ipynb

+1,035-468
Large diffs are not rendered by default.

docs/examples/parallel-computing-with-dask.ipynb

+440-361
Large diffs are not rendered by default.

docs/examples/regridding-horizontal.ipynb

+192-144
Large diffs are not rendered by default.

docs/examples/regridding-vertical.ipynb

+999-1,073
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)