.. PyExtal documentation master file, created by
   sphinx-quickstart on Tue May 20 12:50:22 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PyExtal documentation
=====================

PyExtal is a Python package for simulating and refining convergent
electron beam diffraction and large angle rocking beam eletron diffraction patterns.

.. note:: This is a work in progress. The documentation is not complete yet.

.. toctree::
   introduction
   usage
   architecture
   examples
   api
   :maxdepth: 2
   :caption: Contents: