=============
API reference
=============

**Release**: |version|

**Date**: |today|

This reference manual describes the public functions, modules, and objects in diffsims.
Some of the descriptions include brief examples. For learning how to use diffsims, see
the `demos <https://github.com/pyxem/diffsims-demos>`_.

.. caution::

    diffsims is in continuous development, meaning that some breaking changes and
    changes to this reference are likely with each release.

.. currentmodule:: diffsims

.. rubric:: Modules

.. autosummary::
    :toctree: generated
    :template: custom-module-template.rst
    :recursive:

    crystallography
    generators
    libraries
    pattern
    sims
    simulations
    structure_factor
    utils