|
1 |
| -# Outline for 2024 widget tutorial |
| 1 | +# Outline of topics |
2 | 2 |
|
3 |
| -## Outline is based on the proposal; modifications are welcome |
| 3 | +1. Introductions |
4 | 4 |
|
5 |
| -**Last Updated:** June 18, 2024 |
| 5 | +2. `nbdev` motivation and demonstration (Notebook 2a) |
6 | 6 |
|
7 |
| -1. `nbdev` motivation and demonstration -- essentially follow part of 2023 tutorial. **[Drafted, awaiting review]** |
8 |
| - a. Motivation for using nbdev -- generating python modules from notebooks, mention the other features we are not exploring. |
9 |
| - b. "Gotchas" when using nbdev, e.g. generating code that doesn't execute without some of the notebook cells. |
10 |
| - c. Build dashboard from 2023. |
11 |
| - |
12 |
| -2. Intro to widgets **[Drafted, awaiting review]** |
13 |
| - a. Follow the rough flow of notebook 01 from 2023, introducing one of the widgets (e.g. slider) that we will use later. Also include list/widget showing all the widgets. |
14 |
| - b. Demo showing a pandas dataframe with ipydatagrid |
15 |
| - |
16 |
| -3. Build same dashboard with pydantic + ipyautoui **[Matt handling this]** |
17 |
| - a. Intro classes |
18 |
| - b. Intro type annotations |
19 |
| - c. Intro pydantic |
20 |
| - d. Express constraints of smoothing window/order in pydantic |
21 |
| - e. Generate control widget with ipyautoui |
22 |
| - f. Connect control widget to dashboard |
23 |
| - |
24 |
| -4. Deployment options -- we do NOT need to demonstrate all of these |
25 |
| - - Server-side processing |
26 |
| - a. Binder [Mostly done in README.] **[Nicole has a notebook on this?]** |
27 |
| - b. Nabari(?) **[Juan can look into this]** |
28 |
| - c. Voila **[Nicole has a notebook]** |
29 |
| - - Client-side processing |
30 |
| - a. voici (builds a jupyter lite bundle) on github pages(?) **[Juan]** |
31 |
| - b. nbdev can export some content to static pages using Quarto **[Nicole]** |
32 |
| - c. sphinx (depends on how far along? Depends on Jupyter lite) |
33 |
| - d.. Pycafe ([Examine this link](https://py.cafe/maartenbreddels/ipyvolume-3d-vector-field)) |
34 |
| - |
35 |
| - - Alternative Approach: Build dashboard with solara (10-30 minutes) **[Maarten]** |
| 7 | +3. (Fast) Review of Widgets and their implementations (Notebooks 2b-d) |
| 8 | + |
| 9 | +4. Pydantic for Parameter Validation (Notebook 3a) |
| 10 | + |
| 11 | +[snack break] |
| 12 | + |
| 13 | +5. ipyautoui - From Pydantic models to Widgets (Notebooks 3b-3d) |
| 14 | + |
| 15 | +6. Deployment options (Notebooks 4a-4c) |
| 16 | + - Server-side Processing Options |
| 17 | + - Client-side Processing Options |
| 18 | + - Solara |
0 commit comments