This is a sample lesson for training on using generative AI tools to assist scientific research software development. It is a test of a new software carpentry plugin that provides agents and skills to create a lesson plan following the software carpentry pedagogical approach.
This lesson is built with MyST and Jupyter Book 2.0. The recommended way to manage the environment and build the book is via Pixi.
Install Pixi by following the instructions at https://pixi.sh/latest/#installation.
From the repository root, install all dependencies defined in pixi.toml:
pixi installThis creates an isolated environment with Python, MyST, and any other lesson dependencies.
pixi run buildThe rendered site will be written to _build/html/. Open _build/html/index.html in a browser to preview it locally.
pixi run previewThis starts a local development server and watches for file changes, rebuilding automatically.
If an episode requires additional Python packages (e.g. numpy, pandas), add them to the [dependencies] section of pixi.toml and re-run pixi install.
| Path | Description |
|---|---|
episodes/ |
Lesson episode source files (Markdown) |
index.md |
Book landing page |
myst.yml |
MyST / Jupyter Book configuration and table of contents |
pixi.toml |
Pixi environment and task definitions |
pixi.lock |
Locked dependency versions for reproducibility |
outline/ |
Lesson planning materials |
_build/ |
Build output — not committed to version control |
This lesson is released under the CC-BY-4.0 license.