.. _API Reference:

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

This reference manual describes the public functions, modules, and objects in pyxem.

There are brief examples included for many functions as well as links to more detailed
explanations of the functionality.


.. currentmodule:: pyxem


.. rubric:: Modules

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

    detectors
    data
    components
    dummy_data
    generators
    libraries
    signals
    utils