.. title:: Home


=========================
CHERAB-PHiX documentation
=========================
Welcome to the CHERAB-PHiX's documentation.
This package is developed to extend cherab's fetures for PHiX - a small tokamak device developped at
Tokyo Institute of Technology including specific features like
Plasma emitter, device CAD, diagnostic configuration, etc.

**Useful links**:
`Source Repository`_ |
`Issue Tracker`_ |
: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-PHiX? Check out the getting started guide. It contains an
        installation of CHERAB-PHiX and links to additional tutorials.

        +++

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

            To the installation

    .. 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-PHiX 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 containes a collection of examples to experiment
        with CHERAB-PHiX 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-PHiX. 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

.. figure:: _static/images/phix.jpg
   :align: center

   The plasma discharged image captured by the high-speed camera