File tree Expand file tree Collapse file tree 1 file changed +8
-3
lines changed Expand file tree Collapse file tree 1 file changed +8
-3
lines changed Original file line number Diff line number Diff line change 11# Executable Tutorials
22
3+ ## Use Cases
4+
35Many organizations maintain collections of tutorials addressing realistic
46problems in a science domain, with runnable code examples written and
5- kept current by experts in the tools.
7+ kept current by experts in the tools. They are useful as:
68
79- A trove of working snippets to copy and paste
810- A maintained resource for self-guided learning
911- A ready-to-use curriculum for interactive workshops
1012- A suite of science domain-specific "integration tests"
1113
12- This repository demonstrates one way to configure a collection. It emphasizes the
13- following features:
14+ ## Key Features
15+
16+ This repository demonstrates one way to configure a collection of tutorials,
17+ covering some core features:
1418
1519- Source is in [ MyST Markdown] [ ] which is easy for humans to edit and review.
1620- The executed examples---code and results---are published as a static site.
@@ -19,6 +23,7 @@ following features:
1923 - In a user's local environment
2024 - On a Binder ([ example] [ binder example ] )
2125 - (Experimental) In the user's browser via Jupyter Lite ([ example] [ jupyterlite example ] )
26+ - The examples can be tested using ` pytest ` , both locally and on CI.
2227
2328The repository also includes a [ Guide to Contributing] [ ] tutorials. This
2429provides for a good overview of what this is like to use.
You can’t perform that action at this time.
0 commit comments