Skip to content

Commit 10f059e

Browse files
authored
Finalize scipy2024 schedule (#278)
* banner and toc link * fix banner css and index links * streamline
1 parent b328b01 commit 10f059e

File tree

9 files changed

+93
-124
lines changed

9 files changed

+93
-124
lines changed

_config.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ only_build_toc_files: true
88
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
99
html:
1010
# NOTE: this announcement shows up on all pages
11-
#announcement: 'ℹ️ SciPy Tutorial Attendees. <a href="https://tutorial.xarray.dev/workshops/scipy2023/README.html">Click here </a>.'
11+
announcement: '<a href="https://forms.gle/KEq7WviCdz9xTaJX6">The Xarray 2024 User Survey is live. Please take ~5 minutes to fill it out and help us improve Xarray.</a>'
12+
#announcement: 'ℹ️ SciPy 2024 Tutorial Attendees. <a href="https://tutorial.xarray.dev/workshops/scipy2024/README.html">Click here </a>.'
1213
home_page_in_navbar: false
1314
use_edit_page_button: true
1415
use_issues_button: true

_static/announcement.css

-4
This file was deleted.

_static/style.css

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.bd-header-announcement {
2+
background-color: var(--pst-color-info-bg);
3+
}

_toc.yml

+5-4
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,16 @@ parts:
7878

7979
- caption: Workshops
8080
chapters:
81+
- file: workshops/scipy2024/index.ipynb
8182
- file: workshops/scipy2023/README
82-
- file: workshops/oceanhackweek2020/README
83-
sections:
84-
- url: https://tutorial.xarray.dev/overview/xarray-in-45-min
85-
title: Xarray in 45 minutes
8683
- file: workshops/thinking-like-xarray/README
8784
sections:
8885
- url: https://tutorial.xarray.dev/intermediate/01-high-level-computation-patterns
8986
title: High-level computation patterns
87+
- file: workshops/oceanhackweek2020/README
88+
sections:
89+
- url: https://tutorial.xarray.dev/overview/xarray-in-45-min
90+
title: Xarray in 45 minutes
9091
- file: workshops/online-tutorial-series/README
9192
sections:
9293
- file: workshops/online-tutorial-series/01_xarray_fundamentals

overview/get-started.md

+30-22
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,44 @@
44

55
# Get Started
66

7-
Most of the tutorial content here is written as Jupyter Notebooks that mix
7+
## Organization
8+
9+
Tutorials are approximately divided into sections with increasing levels of complexity: `Fundamentals`, `Intermediate`, `Advanced`. You'll also find content specific to various `Workshops` hosted over the years, often with accompanying video recordings of instructors going over content and answering questions that come up.
10+
11+
Most of the tutorial content is written as Jupyter Notebooks that mix
812
code, text, visualization, and exercises. You can either browse rendered versions of these notebooks on this website, or _execute_ the code examples interactively.
913

10-
You have two options for executing notebooks:
14+
Many notebooks use special formatting ([Myst Markdown](https://mystmd.org/guide/quickstart-jupyter-lab-myst)) that renders best in a JupyterLab web interface. If you are new to JupyterLab, spend some time reviewing the [documentation and videos](https://jupyterlab.readthedocs.io/en/stable/getting_started/overview.html).
15+
16+
## Run code interactively
17+
18+
### On the Cloud
1119

12-
**1. On the Cloud:** Clicking [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/xarray-contrib/xarray-tutorial/HEAD?labpath=overview/fundamental-path/index.ipynb) will load a pre-configured Jupyter Lab interface with _all_ tutorial notebooks for you to run. _You have minimal computing resources and any changes you make will not be saved._ Any page with executable content also has a {octicon}`rocket;2em` icon in the upper right that will launch an interactive session for that particular page.
20+
The easiest way to start modifying and experimenting with tutorial content is to launch a pre-configured server on the Cloud. This is easy thanks to several free resources which offer ephemeral computing instances (be aware you may loose your connection or work at any time)
21+
22+
#### Mybinder.org
23+
24+
Clicking [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/xarray-contrib/xarray-tutorial/HEAD) will load a pre-configured Jupyter Lab interface with _all_ tutorial notebooks for you to run. _You have minimal computing resources and any changes you make will not be saved._ Any page with executable content also has a {octicon}`rocket;2em` icon in the upper right that will launch an interactive session for that particular page.
1325

1426
```{warning}
1527
Be patient, it can take a few minutes for a server to become available on the Cloud (Mybinder.org)!
1628
```
1729

18-
**1. On your computer:** Running tutorials on your computer requires some setup:
30+
#### GitHub Codespaces
31+
32+
This tutorial is available to run within [GitHub Codespaces](https://github.com/features/codespaces) - a preconfigured development environment running in Microsoft Azure.
33+
34+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/xarray-contrib/xarray-tutorial)
35+
36+
☝️ Click the button above to go to options window to launch a GitHub codespace.
37+
38+
You can choose from a selection of virtual machine types: 2 cores - 8 GB RAM should be sufficient for all code examples in this repository.
39+
Additionally, you are able to chose from various configurations for specific workshops (such as Scipy2024).
40+
GitHub currently gives every user [120 vCPU hours per month for free](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts), beyond that you must pay. **So be sure to explicitly stop your codespace when you are done by going to this page (https://github.com/codespaces).** You can also chose to fully delete your codespace when you're done exploring tutorial content.
41+
42+
### On your computer
43+
44+
Running tutorials on your computer requires some setup:
1945

2046
We recommend using [`conda-lock`](https://conda.github.io/conda-lock/) to ensure a fully reproducible Python environment
2147

@@ -29,21 +55,3 @@ conda-lock install conda/conda-lock.yml --name xarray-tutorial
2955
conda activate xarray-tutorial
3056
jupyter lab
3157
```
32-
33-
## Organization
34-
35-
Tutorials are approximately divided into sections with increasing levels of complexity: `Fundamentals`, `Intermediate`, `Advanced`. You'll also find content specific to various `Workshops` hosted over the years, often with accompanying video recordings of instructors going over content and answering questions that come up.
36-
37-
## Jupyter Lab
38-
39-
JupyterLab is a next-generation web-based user interface for Project Jupyter. If you are new to this interface, spend some time reviewing the [documentation and videos](https://jupyterlab.readthedocs.io/en/stable/getting_started/overview.html).
40-
41-
## Jupyter Notebooks
42-
43-
If you haven't used the Jupyter Notebooks before, the quick intro is
44-
45-
1. There are two modes: command and edit
46-
1. From command mode, press Enter to edit a cell (like this markdown cell)
47-
1. From edit mode, press Esc to change to command mode
48-
1. Press shift+enter to execute a cell and move to the next cell.
49-
1. The toolbar has commands for executing, converting, and creating cells.

workshops/online-tutorial-series/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Xarray Online Tutorial
1+
# Xarray Online Tutorial 2020
22

33
Presented October 6 2020 by:
44

workshops/scipy2024/README.md

-76
This file was deleted.

workshops/scipy2024/index.ipynb

+51-15
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,26 @@
55
"id": "0",
66
"metadata": {},
77
"source": [
8-
"<img src=\"../../images/scipy2024.png\" align=\"right\" width=\"20%\">\n",
8+
"# SciPy 2024\n",
99
"\n",
10+
"## Welcome to the Xarray SciPy 2024 Tutorial! \n",
1011
"\n",
11-
"# Welcome to the Xarray SciPy 2024 Tutorial! \n",
12+
"<img src=\"https://images.squarespace-cdn.com/content/v1/6596dfc539fa52603ef8b8d4/277ecf67-8dd4-401f-a74c-df3574adf1d1/SCIPY-2024-no-textArtboard%2B1%403x.png?format=1500w\" align=\"right\" width=\"20%\">\n",
1213
"\n",
1314
"**Xarray**: *Friendly, Interactive, and Scalable Scientific Data Analysis*\n",
1415
"\n",
1516
"July 8, 13:30–17:30 (US/Pacific), Room 317\n",
1617
"\n",
17-
"This *4-hour* workshop will explore content from [the Xarray tutorial](https://tutorial.xarray.dev), which contains a comprehensive collection of hands-on tutorial Jupyter Notebooks. We won't cover it all today, but instead will review a curated set of examples that will prepare you for increasingly complex real-world data analysis tasks!\n",
18+
"This *4-hour* workshop will explore content from [the Xarray tutorial](https://tutorial.xarray.dev), which contains a comprehensive collection of hands-on tutorial Jupyter Notebooks. We will review a curated set of examples that will prepare you for increasingly complex real-world data analysis tasks!\n",
1819
"\n",
19-
"## *Draft* Schedule \n",
20+
":::{admonition} Learning Goals\n",
21+
"- Orient yourself to Xarray resources to continue on your Xarray journey!\n",
22+
"- Effectively use Xarray’s multidimensional indexing and computational patterns\n",
23+
"- Understand how Xarray can wrap other array types in the scientific Python ecosystem\n",
24+
"- Learn how to leverage Xarray’s powerful backend and extension capabilities to customize workflows and open a variety of scientific datasets\n",
25+
":::\n",
26+
"\n",
27+
"## Schedule \n",
2028
"\n",
2129
"*Times in US/Pacific Timezone (Tacoma, WA)\n",
2230
"\n",
@@ -27,24 +35,52 @@
2735
"| Introduction and Setup | 1:30 (10 min) | --- | \n",
2836
"| Xarray Data Model, Backends, Extensions | 1:40 (40 min) | [Quick Introduction to Indexing](../../fundamentals/02.1_indexing_Basic.ipynb) <br> [Boolean Indexing & Masking](../../intermediate/indexing/boolean-masking-indexing.ipynb) | \n",
2937
"| *10 minute Break* \n",
30-
"| Computational Patterns | 2:30 (50 min) | [Computation Patterns](../../intermediate/01-high-level-computation-patterns.ipynb) | \n",
38+
"| Computational Patterns | 2:30 (50 min) | [Advanced Indexing](../../intermediate/indexing/advanced-indexing.ipynb) <br> [Computation Patterns](../../intermediate/01-high-level-computation-patterns.ipynb) <br> | \n",
3139
"| *10 minute Break* | \n",
32-
"| Wrapping other arrays | 3:30 (50 min) | [Xarray and Dask](../../intermediate/xarray_and_dask.ipynb) | \n",
40+
"| Wrapping other arrays | 3:30 (50 min) | [The Xarray Ecosystem](../../intermediate/xarray_ecosystem.ipynb) <br> [Accessors](../../advanced/accessors/01_accessor_examples.ipynb) <br> [Backends](../../advanced/backends/1.Backend_without_Lazy_Loading.ipynb) <br> | \n",
3341
"| *10 minute Break* | \n",
34-
"| Synthesis, Explore your data! | 4:30 (30 min) <br> <br> <br> 5:00 (30 min) | Apply what you've learned, let's work together with your own data |\n",
35-
"| | **End 5:30** | |\n",
42+
"| Synthesis, Explore your data! | 4:30 (50 min) <br> | [Data Tidying](../../intermediate/data_cleaning/05.1_intro.md) <br> |\n",
43+
"| | End 5:30 | |\n",
44+
"\n",
45+
"\n",
46+
"### Tutorial Setup\n",
47+
"\n",
48+
"We recommend using a preconfigured GitHub Codespace for this tutorial. This section describes how to access and manage a GitHub Codespace.\n",
49+
"\n",
50+
":::{note}\n",
51+
"If you prefer to work on your own computer, refer to instructions in the [Getting Started Section](../../overview/get-started.md)\n",
52+
":::\n",
53+
"\n",
54+
"This tutorial is available to run within [Github Codespaces](https://github.com/features/codespaces) - \"a development environment that's hosted in the cloud\" - with the conda environment specification in the [`conda-lock.yml`](../../conda/conda-lock.yml) file.\n",
55+
"\n",
56+
"[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/xarray-contrib/xarray-tutorial/tree/main?devcontainer_path=.devcontainer%2Fscipy2024%2Fdevcontainer.json)\n",
57+
"\n",
58+
"☝️ Click the button above to go to options window to launch a Github Codespace.\n",
59+
"\n",
60+
"GitHub currently gives every user [120 vCPU-hours per month for free](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts), beyond that you must pay. **So be sure to explicitly stop your Codespace when you are done by going to this page (https://github.com/codespaces).**\n",
61+
"\n",
62+
"Once your Codespace is launched, the following happens:\n",
63+
"\n",
64+
"- [Visual Studio Code](https://code.visualstudio.com/) Interface will open up within your browser.\n",
65+
"- A built in terminal will open and it will execute `jupyter lab` automatically.\n",
66+
"- Once you see a url to click within the terminal, simply `cmd + click` the given url.\n",
67+
"- This will open up another tab in your browser, leading to a [Jupyter Lab](https://jupyterlab.readthedocs.io/en/latest/) Interface.\n",
68+
"\n",
3669
"\n",
3770
"\n",
3871
"## Thanks for attending!\n",
3972
"\n",
40-
"Please continue to explore the subfolders in the JupyterLab File Browser for additional tutorial notebooks to run, or read the rendered notebooks at [https://tutorial.xarray.dev](https://tutorial.xarray.dev)"
73+
"Please continue to explore the subfolders in the JupyterLab File Browser for additional tutorial notebooks to run, or read the rendered notebooks at [https://tutorial.xarray.dev](https://tutorial.xarray.dev)\n",
74+
"\n",
75+
"### SciPy 2024 Organized by:\n",
76+
"\n",
77+
"- Scott Henderson (Univ. Washington)\n",
78+
"- Jessica Scheick (Univ. New Hampshire)\n",
79+
"- Negin Sobhani (National Center for Atmospheric Research)\n",
80+
"- Tom Nicholas [C]worthy\n",
81+
"- Max Jones (CarbonPlan)\n",
82+
"- Wietze Suijker (Space Intelligence)"
4183
]
42-
},
43-
{
44-
"cell_type": "markdown",
45-
"id": "1",
46-
"metadata": {},
47-
"source": []
4884
}
4985
],
5086
"metadata": {

workshops/thinking-like-xarray/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Thinking like Xarray
1+
# Thinking like Xarray 2022
22

33
Presented March 2022 for the [NCAR Python Seminar Series](https://ncar.github.io/esds/posts/2022/Thinking-with-Xarray/) by Deepak Cheerian
44

0 commit comments

Comments
 (0)