Skip to content

Document custom potential parametrizations and projection integrals #13

Description

@TomaSusi

Gap: abtem/integrals.py (FieldIntegrator and its GaussianProjectionIntegrals, ScatteringFactorProjectionIntegrals, QuadratureProjectionIntegrals subclasses) and the abtem/parametrizations machinery have zero documentation beyond the API reference.

Why it matters: Advanced users who need a non-default parametrization (or want to understand accuracy trade-offs between projection schemes) currently have to read source code.

Existing draft: docs/user_guide/appendix/potential_integrals.ipynb is a 3-cell stub, already sketched for exactly this purpose.

Suggested content: Finish that appendix: available parametrizations and how to select them, how projection integrals are computed (quadrature vs analytic Gaussian), and a worked example of a custom parametrization.


From a docs coverage audit (July 2026) comparing the abTEM public API against documentation content.

🤖 Generated with Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions