User guide

de-ebsd is layered, and each layer is usable on its own. The forward chain runs de_ebsd.core (frames, constants) -> de_ebsd.crystal (unit cells, structure factors) -> de_ebsd.diffraction (Bloch waves) -> de_ebsd.sim (master patterns). de_ebsd.index runs the inverse problem, matching measured patterns back to orientations, and de_ebsd.viz draws every object through a single display layer.

Every intermediate stage is a real object you can inspect – the structure factors, the reflection list, the dynamical matrix at one beam direction, the depth distribution – rather than a hidden step inside a monolithic simulate call. That is the point of the design, and the examples are written to show it.

• Installation
  • With uv
  • Optional groups
  • Verifying the install
  • Upgrading from torchebsd
• Units and conventions
  • Units
  • Cartesian crystal frame
  • Square-Lambert storage
  • Orientations and detector geometry
  • Space groups and origin choice
• Related projects
• Bibliography