Skip to content

Commit dfb3de1

Browse files
committed
Housekeeping. Primariy clean up sidebar
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 Closes xarray-contrib#49 Closes xarray-contrib#81 Closes xarray-contrib#176 Closes xarray-contrib#179
1 parent 0080f9f commit dfb3de1

File tree

8 files changed

+41
-21
lines changed

8 files changed

+41
-21
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
1-
## Contributing
1+
# Contributing
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

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,7 @@ jupyter lab
3232
## Contributing
3333

3434
Contributions are welcome and greatly appreciated! See our [CONTRIBUTING.md](./CONTRIBUTING.md) document.
35+
36+
## Acknowledgements
37+
38+
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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ parse:
1818
# https://jupyterbook.org/content/content-blocks.html?highlight=myst%20substitution#define-substitutions-for-your-whole-book
1919
# https://jupyterbook.org/content/content-blocks.html#using-substitutions-in-links
2020
myst_substitutions:
21-
xarray_docs: https://xarray.dev
21+
xarray_homepage: https://xarray.dev
22+
xarray_docs: https://docs.xarray.dev
2223
xarray_repo: https://github.com/pydata/xarray
2324
xarray_forum: https://github.com/pydata/xarray/discussions
2425
myst_enable_extensions:

_toc.yml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,9 @@ parts:
7474
- file: workshops/online-tutorial-series/02_indexing
7575
- file: workshops/online-tutorial-series/03_computation
7676

77-
- caption: Domain Specific
78-
chapters:
79-
- url: https://anopheles-genomic-surveillance.github.io/workshop-5/module-1-xarray.html
80-
title: Genomics
81-
- url: https://predictablynoisy.com/posts/2019/2019-10-22-xarray-neuro/
82-
title: Electrophysiology
83-
8477
- caption: Reference
8578
chapters:
79+
- file: CONTRIBUTING
8680
- file: reference/resources
8781
- file: reference/glossary
8882
- file: reference/bibliography
89-
- file: reference/acknowledgements

images/logo.png

41.3 KB
Loading

intro.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,10 @@ 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).

reference/acknowledgements.md

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

reference/resources.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,15 @@ 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+
The [Xarray blog](https://xarray.dev/blog) has a number of user stories showcasing Xarray in many scientfic domaains.
10+
```
11+
12+
```{seealso}
13+
[Project Pythia Foundations](https://foundations.projectpythia.org/) is a great collection of material on Xarray and related packages.
14+
```
15+
16+
## Weather and Climate
917

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

2229
## Bayesian Statistical Modeling
2330

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

0 commit comments

Comments
 (0)