User Guide#

Tutorials#

Quick Start

Build a four-circle diffractometer step by step — without a factory function — and run your first forward calculation.

Quick Start

How-to Guides#

How-to Guides

Step-by-step guides: set wavelength, define a lattice, orient a crystal, solve the forward problem, switch modes, plan trajectories, and align a crystal end-to-end.

How-to Guides

Reference#

Prebuilt Geometries

Eulerian (4, 5, and 6 circle) · Kappa (4 and 6 circle) · Surface and special-purpose

Prebuilt Geometries
API Reference

Complete auto-generated reference for every public class, function, and constant.

API
Glossary

Alphabetised definitions of key terms.

Glossary
References

All literature citations — geometry papers, physical constants, and numerical methods.

References

Explanation#

Concepts

Coordinate conventions, axis sign convention, B/U/UB matrices, diffraction modes, and the ψ angle.

Concepts
Direct Lattice

Vector mathematics and lattice vector conventions in crystallography.

Direct Lattice in Crystallography
Case Study

The diffractometer problem that started this project.

Case Study: Describing a Diffractometer
Coordinate Convention & UB Matrix

How a basis vector assignment leads to the B, U, and UB matrices, with a worked example using the You (1999) convention.

Case Study: Coordinate Convention and UB Matrix