Welcome to xrdt's documentation!
================================

This package provides a toolkit which allows to keep *X-ray diffraction* (XRD) measurements organised in a uniform way and access them via a :ref:`api`.
The *x*/*y* data can be enriched with valuable metadata and all data are stored as plain files in a specified directory, which allows to use version control systems like `git <https://git-scm.com>`_ to track your measurements.

A :ref:`cli` (CLI) can be used to add measurements and handle certain tasks.
Moreover, a plugin mechanisms allows to expand the capabilities of this toolkit.

Currently refinement interface plugins are integrated and such a plugin for the software `Profex <https://www.profex-xrd.org>`_ is included in the package.



.. toctree::
   :caption: xrdt Documentation
   :maxdepth: 2
   :hidden:

   installation
   configuration
   contributing
   cli
   modules
   plugins

.. toctree::
   :maxdepth: 1
   :hidden:

   changelog

.. toctree::
   :caption: User Guide
   :maxdepth: 2
   :numbered:
   :hidden:

   guide_01_structure
   guide_02_devices
   guide_03_presets
   guide_04_templates
   guide_05_measurements
   guide_06_database


Links
-----

* `Codeberg repository <https://codeberg.org/Cs137/xrdt>`_


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

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