.. title:: CHERAB-LHD documentation


=========================
CHERAB-LHD documentation
=========================
Welcome to the CHERAB-LHD's documentation.
This package offers LHD specific features - Plasma emitter,
device CAD, diagnostic configuration, etc.

Please note that this package is under development,
so this documentation is gradually updated, and welcome your contribution.

**Useful links**:
`Source Repository`_ |
`Issue`_ |
:ref:`contribution`

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

   User Guide <user/index>
   Examples <examples>
   API Reference <api>


.. grid:: 2

    .. grid-item-card::
        :img-top: _static/images/index-images/getting_started.png

        Getting Started
        ^^^^^^^^^^^^^^^

        New to CHERAB-LHD? Check out the getting started guide. It contains an
        quickstart guide to get you up and running CHERAB-LHD.

        +++

        .. button-ref:: user/quickstart
            :expand:
            :color: secondary
            :click-parent:

            To the quickstart

    .. grid-item-card::
        :img-top: _static/images/index-images/user_guide.png

        User Guide
        ^^^^^^^^^^

        The user guide provides in-depth information on the
        key concepts of CHERAB-LHD with useful tutorials.

        +++

        .. button-ref:: user/index
            :expand:
            :color: secondary
            :click-parent:

            To the user guide

    .. grid-item-card::
        :img-top: _static/images/index-images/example_gallery.png

        Example Gallery
        ^^^^^^^^^^^^^^^

        Here it contains a collection of examples to experiment
        with CHERAB-LHD source code.

        +++

        .. button-ref:: examples
            :expand:
            :color: secondary
            :click-parent:

            To the example gallery

    .. grid-item-card::
        :img-top: _static/images/index-images/api.png

        API Reference
        ^^^^^^^^^^^^^

        The reference guide contains a detailed description of the functions,
        modules, and objects included in CHERAB-LHD. The reference describes how the
        methods work and which parameters can be used. It assumes that you have an
        understanding of the key concepts.

        +++

        .. button-ref:: api
            :expand:
            :color: secondary
            :click-parent:

            To the reference guide