Skip to content

Commit ca529f2

Browse files
committed
Merge remote-tracking branch 'upstream/main' into readme_update
* upstream/main: Update indexing material (xarray-contrib#192) Migrate to exercise syntax (xarray-contrib#196) Bump pangeo/base-image from 2023.06.20 to 2023.07.05 in /.devcontainer (xarray-contrib#193) Add Nebari-specific instructions for SciPy 2023 (xarray-contrib#195) Add contributors image (xarray-contrib#194) Computational pattern tutorial edits (xarray-contrib#186) Housekeeping + clean up sidebar (xarray-contrib#190)
2 parents f8166fe + 34d1a4a commit ca529f2

33 files changed

+2189
-847
lines changed

.devcontainer/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
FROM pangeo/base-image:2023.06.20
1+
FROM pangeo/base-image:2023.07.05

.github/workflows/main.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
with:
3131
path: _build
3232
# NOTE: change key to "jupyterbook-DATE" to force rebuilding cache
33-
key: jupyterbook-20230626
33+
key: jupyterbook-20230707
3434

3535
- name: Install Conda environment with Micromamba
3636
uses: mamba-org/setup-micromamba@v1

.github/workflows/preview.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
with:
2222
path: _build
2323
# NOTE: change key to "jupyterbook-DATE" to force rebuilding cache
24-
key: jupyterbook-20230626
24+
key: jupyterbook-20230707
2525

2626
- name: Install Conda environment with Micromamba
2727
uses: mamba-org/setup-micromamba@v1

CONTRIBUTING.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
1-
## Contributing
1+
# Contributing Guide
22

3-
This repository is a great opportunity to start contributing to Xarray.
3+
This tutorial repository is a great opportunity to start contributing to Xarray.
44

5-
- Report bugs, request features or submit feedback as a [GitHub Issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues). First check existing issues: https://github.com/xarray-contrib/xarray-tutorial/issues !
5+
- Report bugs, request features or submit feedback as a [GitHub Issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues). First check existing [issues](https://github.com/xarray-contrib/xarray-tutorial/issues) !
66

77
- Make fixes, add content or improvements using [GitHub Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests), the sections below go over this process in more detail:
88

9+
```{seealso}
10+
The Project Pythia Foundations material on [Github](https://foundations.projectpythia.org/foundations/getting-started-github.html) and Github workflows is a great place to start if you are new to this.
11+
```
12+
913
## Content Guidelines
1014

1115
Please note that examples submitted to this repository should follow these
1216
guidelines:
1317

1418
1. Run top-to-bottom without intervention from the user
15-
1. Not require external data sources that may disappear over time (external data sources that are highly unlikely to disappear are fine)
19+
1. Not require external data sources that may disappear over time (external data sources that are highly unlikely to disappear are fine). Small datasets for tutorial purposes can be added [here](https://github.com/pydata/xarray-data/) if necessary.
1620
1. Not be resource intensive, and should run within 2GB of memory
1721
1. Be clear and contain enough prose to explain the topic at hand
1822
1. Be concise and limited to one or two topics, such that a reader can get through the example within a few minutes of reading
@@ -31,7 +35,7 @@ cd xarray-tutorial
3135

3236
You'll need `conda` or `mamba`, which can be installed from https://github.com/conda-forge/miniforge
3337

34-
We also use [conda-lock](https://conda-incubator.github.io/conda-lock/) to ensure we have reproducible environments across different operating systems
38+
We also use [conda-lock](https://conda.github.io/conda-lock/) to ensure we have reproducible environments across different operating systems
3539

3640
We also use [pre-commit hooks](https://pre-commit.com) to run styling and other checks before committing code.
3741

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,11 @@ jupyter lab
3333
## Contributing
3434

3535
Contributions are welcome and greatly appreciated! See our [CONTRIBUTING.md](./CONTRIBUTING.md) document.
36+
37+
Thanks to our contributors so far!
38+
39+
[![Contributors](https://contrib.rocks/image?repo=xarray-contrib/xarray-tutorial)](https://github.com/xarray-contrib/xarray-tutorial/graphs/contributors)
40+
41+
## Acknowledgements
42+
43+
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](https://xarray.dev/#sponsors). Funding for SciPy 2022, SciPy 2023 tutorial materialdevelopment specifically was supported by NASA's Open Source Tools, Frameworks, and Libraries Program (award 80NSSC22K0345).

_config.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ parse:
1919
# https://jupyterbook.org/content/content-blocks.html?highlight=myst%20substitution#define-substitutions-for-your-whole-book
2020
# https://jupyterbook.org/content/content-blocks.html#using-substitutions-in-links
2121
myst_substitutions:
22-
xarray_docs: https://xarray.dev
22+
xarray_homepage: https://xarray.dev
23+
xarray_docs: https://docs.xarray.dev
2324
xarray_repo: https://github.com/pydata/xarray
2425
xarray_forum: https://github.com/pydata/xarray/discussions
2526
myst_enable_extensions:
@@ -68,6 +69,7 @@ sphinx:
6869
- sphinxext.rediraffe
6970
- sphinx_exercise
7071
config:
72+
language: en # accessibility
7173
# application/vnd.holoviews_load.v0+json, application/vnd.holoviews_exec.v0+json
7274
suppress_warnings: ['mystnb.unknown_mime_type', 'misc.highlighting_failure']
7375
notfound_context:
@@ -76,5 +78,7 @@ sphinx:
7678

7779
rediraffe_redirects:
7880
scipy-tutorial/00_overview.ipynb: overview/get-started.md
81+
workshops/scipy2022/README.md: overview/fundamental-path/README.md
82+
fundamentals/02.1_working_with_labeled_data.ipynb: fundamentals/02.1_indexing_Basic.ipynb
7983

8084
bibtex_reference_style: author_year # or label, super, \supercite

_toc.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ parts:
66
chapters:
77
- file: overview/get-started.md
88
- file: overview/xarray-in-45-min
9-
- file: overview/fundamental-path/README.md
9+
- file: overview/learning-paths.md
10+
sections:
11+
- file: overview/fundamental-path/README.md
1012

1113
- caption: Fundamentals
1214
chapters:
@@ -17,7 +19,7 @@ parts:
1719
- file: fundamentals/01.1_io
1820
- file: fundamentals/02_labeled_data.md
1921
sections:
20-
- file: fundamentals/02.1_working_with_labeled_data
22+
- file: fundamentals/02.1_indexing_Basic.ipynb
2123
- file: fundamentals/02.2_manipulating_dimensions
2224
- file: fundamentals/03_computation.md
2325
sections:
@@ -35,11 +37,17 @@ parts:
3537
- caption: Intermediate
3638
chapters:
3739
- file: intermediate/01-high-level-computation-patterns
40+
- file: intermediate/indexing/indexing
41+
sections:
42+
- file: intermediate/indexing/advanced-indexing.ipynb
43+
- file: intermediate/indexing/boolean-masking-indexing.ipynb
3844
- file: intermediate/xarray_and_dask
3945
- file: intermediate/xarray_ecosystem
4046
- file: intermediate/hvplot
4147
- file: intermediate/cmip6-cloud
42-
- file: data_cleaning/ice_velocity.ipynb
48+
- file: data_cleaning/data_cleaning.md
49+
sections:
50+
- file: data_cleaning/ice_velocity
4351

4452
- caption: Advanced
4553
chapters:
@@ -81,16 +89,8 @@ parts:
8189
- file: workshops/online-tutorial-series/02_indexing
8290
- file: workshops/online-tutorial-series/03_computation
8391

84-
- caption: Domain Specific
85-
chapters:
86-
- url: https://anopheles-genomic-surveillance.github.io/workshop-5/module-1-xarray.html
87-
title: Genomics
88-
- url: https://predictablynoisy.com/posts/2019/2019-10-22-xarray-neuro/
89-
title: Electrophysiology
90-
9192
- caption: Reference
9293
chapters:
94+
- file: CONTRIBUTING
9395
- file: reference/resources
9496
- file: reference/glossary
95-
- file: reference/bibliography
96-
- file: reference/acknowledgements

advanced/backends/backends.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Xarray bundles several backends internally for the following formats:
2222
External Backends that use the new backend API (xarray >= v0.18.0) that allows to add support for backend without any change to Xarray
2323

2424
- [cfgrib](https://github.com/ecmwf/cfgrib) - GRIB
25-
- [tiledb](https://pythonrepo.com/repo/TileDB-Inc-TileDB-xarray) - TileDB
25+
- [tiledb](https://github.com/TileDB-Inc/TileDB-CF-Py) - TileDB
2626
- [rioxarray](https://corteva.github.io/rioxarray/stable/) - GeoTIFF, JPEG-2000, ESRI-hdr, etc (via GDAL)
2727
- [xarray-sentinel](https://github.com/bopen/xarray-sentinel) - Sentinel-1 SAFE
2828
- ...

data_cleaning/data_cleaning.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Data Tidying
2+
3+
```{tableofcontents}
4+
5+
```

0 commit comments

Comments
 (0)