.. _index:

============================
*Ad hoc* diffractometer
============================

**Version:** |release|

``ad_hoc_diffractometer`` is a Python package that lets you describe any
multi-circle diffractometer geometry and perform X-ray/neutron
crystallography calculations.

See the :doc:`Quick Start guide <quick_start>` for a step-by-step
walkthrough building an Eulerian four-circle geometry — choosing a
coordinate basis, stage stacking, diffraction mode definition(s), and
running a forward calculation. Common geometries are provided as
examples.

.. toctree::
   :hidden:

   install
   user_guide
   api
   changes

.. icons: https://fonts.google.com/icons

.. grid:: 2

   .. grid-item-card:: :material-regular:`install_desktop;3em` Get started
      :link: install
      :link-type: doc

      Install the package and verify the installation.

   .. grid-item-card:: :material-outlined:`menu_book;3em` User Guide
      :link: user_guide
      :link-type: doc

      Concepts, how-to guides, and demonstration geometries.

   .. grid-item-card:: :material-regular:`api;3em` API Reference
      :link: api
      :link-type: doc

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

   .. grid-item-card:: :material-outlined:`library_books;3em` References
      :link: references
      :link-type: doc

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

About
-----

.. list-table::
   :stub-columns: 1

   * - Home
     - https://BCDA-APS.github.io/ad_hoc_diffractometer/
   * - Source
     - https://github.com/BCDA-APS/ad_hoc_diffractometer
   * - Version
     - |release|
   * - Published
     - |today|
   * - License
     - `LicenseRef-ANL-Open-Source-License <https://github.com/BCDA-APS/ad_hoc_diffractometer/blob/main/LICENSE>`_
   * - Index
     - :ref:`genindex`