Skip to content

README.md

Latest commit

 

History

History
62 lines (44 loc) · 2.04 KB

README.md

File metadata and controls

62 lines (44 loc) · 2.04 KB

Executable Tutorials

Use Cases

Many organizations maintain collections of tutorials addressing realistic problems in a science domain, with runnable code examples written and kept current by experts in the tools. They are useful as:

  • A trove of working snippets to copy and paste
  • A maintained resource for self-guided learning
  • A ready-to-use curriculum for interactive workshops
  • A suite of science domain-specific "integration tests"

Key Features

This repository demonstrates one way to configure a collection of tutorials, covering some core features:

  • Source is in MyST Markdown which is easy for humans to edit and review.
  • The executed examples---code and results---are published as a static site. (example)
  • The examples can be opened as Jupyter notebooks to run and edit:
    • In a user's local environment
    • On a Binder (example)
    • (Experimental) In the user's browser via Jupyter Lite (example)
  • The examples can be tested using pytest, both locally and on CI.

Try It Out

  • Read the published examples.

  • Open it on Binder to run the examples in the cloud.

  • Download and run the examples locally.

    git clone https://github.com/scientific-python/executable-tutorials

    For users of pixi:

    pixi run start

    Alternatively, install the requirements with pip and start JupyterLab.

    pip install -r requirements.txt
jupyter lab

Make Your Own

See the Guide for Maintainers to create your own collection of tutorials.