Gap: abtem/magnetism/gpaw.py (GPAWMagneticField, GPAWVectorPotential) has zero documentation coverage, while the IAM magnetism counterparts are at least used in passing.
Why it matters: Spin-dependent/magnetic TEM contrast from ab initio input is an active research area, and users with GPAW calculations have no worked example to start from.
Suggested content: An example notebook (e.g. magnetic_gpaw_quickstart.ipynb) going from a small GPAW spin-polarized calculation (or a shipped/cached one, mirroring how the charge-density tutorial handles GPAW data) to a magnetic-contrast simulation, noting the requires_gpaw dependency.
From a docs coverage audit (July 2026) comparing the abTEM public API against documentation content.
🤖 Generated with Claude Code
Gap:
abtem/magnetism/gpaw.py(GPAWMagneticField,GPAWVectorPotential) has zero documentation coverage, while the IAM magnetism counterparts are at least used in passing.Why it matters: Spin-dependent/magnetic TEM contrast from ab initio input is an active research area, and users with GPAW calculations have no worked example to start from.
Suggested content: An example notebook (e.g.
magnetic_gpaw_quickstart.ipynb) going from a small GPAW spin-polarized calculation (or a shipped/cached one, mirroring how the charge-density tutorial handles GPAW data) to a magnetic-contrast simulation, noting therequires_gpawdependency.From a docs coverage audit (July 2026) comparing the abTEM public API against documentation content.
🤖 Generated with Claude Code