..
    This file is licensed under the
    Creative Commons Attribution 4.0 International Public License (CC-BY-4.0)
    Copyright 2023 - 2024, Helmholtz-Zentrum Hereon
    SPDX-License-Identifier: CC-BY-4.0


.. image:: ./images/logo/pydidas_snakes_w_bg.png
    :align: right
    :alt: rings_logo
    :width: 150px


pydidas
=======


pyDIDAS (**py**\ thon **DI**\ ffraction **D**\ ata **A**\ nalysis **S**\ uite)
is a toolset developed at Helmholtz-Zentrum Hereon to improve the ease of use
and efficiency of diffraction data analysis. A key requirement is to create
a graphical user interface of the software and processing which scales with
available resources to allow running pyDIDAS on a wide range of machines from
a small laptop up to a central cluster at the facility level.

 .. grid:: 2
    :gutter: 2

    .. grid-item-card:: Quickstart
        :link: quickstart
        :link-type: ref
        :width: 100%

        Using pydidas for the first time? For questions about how to run pydidas
        and how to get started with the software, please refer to the pydidas quickstart
        guide.

    .. grid-item-card:: Installation
        :link: https://github.com/hereon-GEMS/pydidas/tree/master?tab=readme-ov-file#readme
        :width: 100%

        For information on how to install pydidas, please refer to the README file.

    .. grid-item-card:: Graphical user interface
        :link: graphical_user_interface
        :link-type: ref
        :width: 100%

        For an introduction on how to use pydidas, please refer to the manual for
        the graphical user interface.

    .. grid-item-card:: Full manuals
        :link: manuals
        :link-type: ref
        :width: 100%

        For detailed information on how to use pydidas, please refer to the
        complete list of manuals. This documentation also includes command-line usage.

    .. grid-item-card:: Code Documentation
        :link: code_documentation
        :link-type: ref
        :width: 100%

        For detailed information on the code structure and API, please refer
        to the code documentation.

    .. grid-item-card:: Developer Guide
        :link: developer_guide
        :link-type: ref
        :width: 100%

        For information on how to contribute to pydidas, please refer to the
        developer guide.



.. include:: ./introduction.rst

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

    manuals/manuals_main
    code/code_documentation
    dev_guide/developer_guide


Index
-----

* :ref:`genindex`