Skip to content

Commit 56e8506

Browse files
authored
Housekeeping + clean up sidebar (#190)
1. Move acknowledgments to intro.md. 2. Move domain specific tutorial links to "Keep Exploring" 3. Add Pythia material to "Keep Exploring" 4. Add CONTRIBUTING.md 5. Redirect SciPy 2022 link to Fundamental Learning Path 6. Reorganize with Data Tidying and Learning Path subheadings Closes #49 Closes #81 Closes #176 Closes #179
1 parent cf9da0a commit 56e8506

17 files changed

+72
-31
lines changed

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: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,7 @@ jupyter lab
3333
## Contributing
3434

3535
Contributions are welcome and greatly appreciated! See our [CONTRIBUTING.md](./CONTRIBUTING.md) document.
36+
37+
## Acknowledgements
38+
39+
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: 4 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,6 @@ 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
7982

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

_toc.yml

Lines changed: 7 additions & 11 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:
@@ -39,7 +41,9 @@ parts:
3941
- file: intermediate/xarray_ecosystem
4042
- file: intermediate/hvplot
4143
- file: intermediate/cmip6-cloud
42-
- file: data_cleaning/ice_velocity.ipynb
44+
- file: data_cleaning/data_cleaning.md
45+
sections:
46+
- file: data_cleaning/ice_velocity
4347

4448
- caption: Advanced
4549
chapters:
@@ -81,16 +85,8 @@ parts:
8185
- file: workshops/online-tutorial-series/02_indexing
8286
- file: workshops/online-tutorial-series/03_computation
8387

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-
9188
- caption: Reference
9289
chapters:
90+
- file: CONTRIBUTING
9391
- file: reference/resources
9492
- file: reference/glossary
95-
- file: reference/bibliography
96-
- file: reference/acknowledgements

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+
```

images/alignment_schematic.png

-28.7 KB
Loading

images/broadcasting.png

-84.5 KB
Loading

images/broadcasting_schematic.png

-24.5 KB
Loading

images/logo.png

41.3 KB
Loading

images/scipylogo.png

-49.1 KB
Loading

images/xarray-data-structures.png

-1.61 KB
Loading

intro.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,16 @@ Ask questions on the Xarray Discussion Forum
3535
3636
````
3737

38+
## Citation
39+
3840
✏️ To cite this material, you can use the recommended [Xarray citation](https://docs.xarray.dev/en/stable/getting-started-guide/faq.html#how-should-i-cite-xarray): {cite:p}`hoyerhamman2017`, {cite:p}`xarray_v202230`.
41+
42+
## Acknowledgements
43+
44+
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 material development specifically was supported by NASA's Open Source Tools, Frameworks, and Libraries Program (award 80NSSC22K0345).
45+
46+
## Bibliography
47+
48+
```{bibliography}
49+
:style: plain
50+
```

overview/fundamental-path/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Fundamental Learning Path
1+
# Fundamentals Learning Path
22

33
This syllabus comes from Scipy 2022 tutorial workshop.
44
This path covers fundamental Xarray concepts with

overview/learning-paths.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Learning Paths
2+
3+
Learning Paths are guided tours through the material on the site.
4+
These paths were originally built for in-person tutorials at the SciPy conference.
5+
They are useful if you would like to work through the material in an organized manner.
6+
7+
Follow the links below to try out each path.
8+
9+
```{tableofcontents}
10+
11+
```

reference/acknowledgements.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

reference/bibliography.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

reference/resources.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,14 @@ demonstrate real-world applications of Xarray in a variety of use cases. These
55
need not be explored in any particular sequence, instead they are meant to
66
provide a sampling of what Xarray can be used for.
77

8-
## Weather/Climate Model Data
8+
```{seealso}
9+
1. The [Xarray blog](https://xarray.dev/blog) has a number of user stories showcasing Xarray in
10+
many scientific domains.
11+
2. [Project Pythia Foundations](https://foundations.projectpythia.org/) is a great collection of
12+
material on Xarray and related packages.
13+
```
14+
15+
## Weather and Climate
916

1017
1. [Global Mean Surface Temperature from CMIP6](https://gallery.pangeo.io/repos/pangeo-gallery/cmip6/):
1118
Start with `global_mean_surface_temp.ipynb` then feel free to explore the
@@ -14,14 +21,21 @@ provide a sampling of what Xarray can be used for.
1421
1. [National Water Model Streamflow Analysis](https://gallery.pangeo.io/repos/rsignell-usgs/esip-gallery/):
1522
Start with `02_National_Water_Model.ipynb` then feel free to explore the rest
1623
of the notebooks.
17-
18-
## Satellite Data
19-
20-
1. [Planetary Computer Examples](https://github.com/microsoft/PlanetaryComputerExamples)
24+
1. The [Project Pythia Cookbooks](https://cookbooks.projectpythia.org/) are a great collection of
25+
resources showcasing use of Xarray with real world datasets.
26+
1. [Examples using the Microsoft Planetary Computer](https://github.com/microsoft/PlanetaryComputerExamples)
2127

2228
## Bayesian Statistical Modeling
2329

2430
1. [Xarray and PyMC3](https://mybinder.org/v2/gh/pymc-devs/pymc3/main?filepath=%2Fdocs%2Fsource%2Fnotebooks):
2531
Start with `multilevel_modeling.ipynb` then feel free to explore the rest of
2632
the notebooks. Also checkout [Arviz](https://arviz-devs.github.io/arviz/)
2733
which uses Xarray as its data model.
34+
35+
## Genomics
36+
37+
1. [From "data analysis for genomic surveillance of African malaria vectors" ](https://anopheles-genomic-surveillance.github.io/workshop-5/module-1-xarray.html)
38+
39+
## Electrophysiology
40+
41+
1. ["Analyzing intracranial electrophysiology data with xarray"](https://chrisholdgraf.com/blog/2019/2019-10-22-xarray-neuro/)

0 commit comments

Comments
 (0)