Deep Dive Snakemake Capstone Map¶
Guide Fit¶
flowchart TD
family["Reproducible Research"] --> program["Deep Dive Snakemake"]
program --> pressure["A concrete learner or reviewer question"]
pressure --> guide["Deep Dive Snakemake Capstone Map"]
guide --> next["Modules, capstone, and reference surfaces"]
flowchart TD
question["Name the current module or question"] --> choose["Choose one capstone route"]
choose --> inspect["Inspect the matching guide, file, or command"]
inspect --> next_move["Stop when one honest proof route is visible"]
Read the first diagram as a timing map: the capstone is a corroboration surface, not the first lesson. Read the second diagram as the route rule: choose one capstone route by module or question, inspect the matching surface, then stop when one honest proof route is visible.
Enter the capstone at the right time¶
Enter only when the module idea is already legible in the local exercise.
Return to the module first if:
- you cannot yet explain the concept on a smaller workflow
- you do not know which command should prove the behavior
- the repository feels larger than the concept you are studying
Choose the route by question¶
| If the question is... | Start here | Escalate only if needed |
|---|---|---|
| what this repository promises | Capstone Guide | Capstone Walkthrough |
| which repository surface matches the current module | the table below | Capstone File Guide |
| which command should prove the current claim | Command Guide | Capstone Proof Guide |
| what is safe for downstream trust | Publish Review Guide | Capstone Review Worksheet |
| what differs across execution contexts | Profile Audit Guide | Capstone Review Worksheet |
Choose the route by module arc¶
| Module arc | What should already be clear locally | First capstone route |
|---|---|---|
| Modules 01-02 | truthful file contracts, deterministic discovery, and explicit checkpoints | Capstone Walkthrough |
| Modules 03-04 | policy surfaces, execution boundaries, and repository interfaces | Command Guide |
| Modules 05-08 | software boundaries, publish contracts, and operating contexts | Capstone Proof Guide |
| Modules 09-10 | incident evidence, migration boundaries, and stewardship judgment | Capstone Review Worksheet |
Module-to-capstone map¶
| Module | Main learner question | Capstone surface | First command |
|---|---|---|---|
| 01 File Contracts | what makes the workflow file-driven instead of script-shaped | Snakefile, workflow/rules/common.smk, publish/v1/ |
make walkthrough |
| 02 Dynamic DAGs | where discovery becomes explicit instead of magical | checkpoint rule files, discovered-set artifacts, publish/v1/discovered_samples.json |
make verify |
| 03 Production Operation | what counts as workflow semantics versus operating policy | profiles/, Makefile, tests/selftest.sh |
make tour |
| 04 Scaling Patterns | how repository structure stays legible as the workflow grows | workflow/rules/, FILE_API.md, TOUR.md |
make tour |
| 05 Rule Boundaries | where helper code, wrappers, and environments belong | workflow/envs/, workflow/scripts/, src/capstone/ |
make proof |
| 06 Publish Contracts | what downstream consumers may trust from the workflow | publish/v1/, FILE_API.md, publish bundle evidence |
make verify-report |
| 07 Workflow Architecture | how rules, helpers, and file APIs are split deliberately | Snakefile, workflow/rules/, src/capstone/ |
make proof |
| 08 Operating Contexts | how local, CI, and scheduler policy differ without semantic drift | profiles/local/, profiles/ci/, profiles/slurm/ |
make profile-audit |
| 09 Incident Response | how logs, benchmarks, and workflow-tour evidence support diagnosis | logs/, benchmarks/, incident bundle surfaces |
make proof |
| 10 Governance | whether another maintainer could review or migrate the workflow safely | Snakefile, FILE_API.md, profiles/, tests/, Makefile |
make confirm |
Good stopping point¶
Stop when you can name one capstone surface, one command, and one reason they are enough for the current module or question. If you still feel pulled toward the whole repository, step back to the smaller route.