Skip to content

Notebook Index

The notebook index is an inventory of computational artifacts that support teaching pages, formula cards, benchmarks, and figures. It is not a dumping ground for exploratory code. A notebook should make one calculation reproducible and should say what would falsify or limit the result.

The current committed family is:

notebooks/wave-mechanics-canonical-systems/

It supports the Wave Mechanics and Model Systems volume. The volume-specific index is Numerical Notebooks Index, and the validation suite is Benchmark Problems.

Current subfamilies include:

  • one-dimensional bound systems,
  • free wave-packet motion,
  • scattering and tunneling,
  • harmonic oscillator eigenstates,
  • two-level dynamics,
  • hydrogenic radial functions,
  • spherical harmonics,
  • Landau levels.

The committed AMO family is:

notebooks/amo/

Its retained artifacts include:

These notebooks are validation-first. Optional plotting can be added only after numerical checks remain visible.

Every indexed notebook should state:

  • purpose,
  • canonical page and formula pages used,
  • mathematical model and Hamiltonian,
  • assumptions and approximations,
  • input parameters and unit convention,
  • numerical method,
  • environment and package versions,
  • expected outputs,
  • validation checks and tolerances,
  • reproducibility status,
  • last run date and, when available, commit identifier.

If a notebook has no validation cell, it may still be useful as an exploratory draft, but it should not be promoted to the reference index.

Future notebook families should use semantic directories:

notebooks/
wave-mechanics-canonical-systems/
symmetry/
approximation/
density-open-systems/
quantum-information/
many-body/
amo/
quantum-matter/
mathematical-qm/

Each family should have a short README or opening notebook cell explaining shared units, dependencies, expected runtime, and validation philosophy.

Use this structure for future per-notebook entries:

Purpose
Canonical pages
Formula pages used
Inputs and parameters
Numerical method
Outputs
Benchmark target
Environment
Reproducibility status
Last run
Known limitations

The entry should be short enough to scan but specific enough for a reviewer to reproduce the calculation.

A computational exercise becomes a notebook only after it has:

  1. a canonical page or formula target,
  2. a benchmark target,
  3. an environment recipe,
  4. a validation cell,
  5. a status label,
  6. a review note if the result is used by a figure or table.

This path prevents a notebook from becoming an unreviewed source of truth.