.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. include:: ../../README.rst

Documentation
======================================


======================================
beam
======================================

.. automodule:: xrd_simulator.beam
    :members:
    :show-inheritance:

======================================
detector
======================================

.. automodule:: xrd_simulator.detector
    :members:
    :show-inheritance:

======================================
mesh
======================================

.. automodule:: xrd_simulator.mesh
    :members:
    :show-inheritance:

======================================
Phase
======================================

.. automodule:: xrd_simulator.phase
    :members:
    :show-inheritance:

======================================
polycrystal
======================================

.. automodule:: xrd_simulator.polycrystal
    :members:
    :show-inheritance:

======================================
scattering_unit
======================================

.. automodule:: xrd_simulator.scattering_unit
    :members:
    :show-inheritance:

======================================
laue
======================================

.. automodule:: xrd_simulator.laue
    :members:
    :show-inheritance:

======================================
utils
======================================

.. automodule:: xrd_simulator.utils
    :members:
    :show-inheritance:

======================================
templates
======================================

.. automodule:: xrd_simulator.templates
    :members:
    :show-inheritance:

Indices and tables
==================

* :ref:`modindex`
* :ref:`search`