diff --git a/README.md b/README.md index 90ec83f..ef2fa14 100644 --- a/README.md +++ b/README.md @@ -1 +1,37 @@ -This repo contains our slides and materials for various Flux tutorials. +# Flux Framework Tutorials + +This repository contains our slides and materials for Flux Framework tutorials. + +## Design + +### Autoscaling Jupyter Hub + +We deploy a Jupyter Hub that spawns individual containers, one per tutorial participant. Participants can login +to a web-based portal with a password and username of their choosing to start the chapter-oriented sections. + +### Content + +While we change the tutorial over time, the content generally consists of two kinds of learning. + +#### Presentation + +Our presentations vary by year, and we try to make them interesting and engaging, teaching about Flux and highlighting new features. +A few examples: + +![img/new-features.png](img/new-features.png) +![img/rabbits.png](img/rabbits.png) + +This presentation from RADIUSS 2023 can [be seen here](https://github.com/flux-framework/Tutorials/blob/master/2023-RADIUSS-AWS/Flux_RADIUSS_Tutorial_2023.pdf). Individual presentations can include (but are not limited to) content from our [learning guide](https://flux-framework.readthedocs.io/en/latest/guides/learning_guide.html) and introduction to [Flux Components](https://flux-framework.readthedocs.io/en/latest/guides/components.html). + +![img/components.png](img/components.png) + +#### Interactive Learning + +To best learn about using Flux, we offer several beginner chapters for job submission and interaction with Flux Framework. +The chapters are also interspersed with more design or "how does it work" type content for the interested reader. A few screenshots are shown below. + +![img/modules.png](img/modules.png) +![img/flux-services.png](img/flux-services.png) +![img/flux-tree.png](img/flux-tree.png) +![img/submit.png](img/submit.png) + diff --git a/img/components.png b/img/components.png new file mode 100644 index 0000000..8a925af Binary files /dev/null and b/img/components.png differ diff --git a/img/flux-services.png b/img/flux-services.png new file mode 100644 index 0000000..dc0c2e0 Binary files /dev/null and b/img/flux-services.png differ diff --git a/img/flux-tree.png b/img/flux-tree.png new file mode 100644 index 0000000..ab82d97 Binary files /dev/null and b/img/flux-tree.png differ diff --git a/img/modules.png b/img/modules.png new file mode 100644 index 0000000..9a886f0 Binary files /dev/null and b/img/modules.png differ diff --git a/img/new-features.png b/img/new-features.png new file mode 100644 index 0000000..0ffb5a8 Binary files /dev/null and b/img/new-features.png differ diff --git a/img/rabbits.png b/img/rabbits.png new file mode 100644 index 0000000..9ba4b96 Binary files /dev/null and b/img/rabbits.png differ diff --git a/img/submit.png b/img/submit.png new file mode 100644 index 0000000..5b3a5e2 Binary files /dev/null and b/img/submit.png differ