========================
``stixpy`` Documentation
========================

``stixpy`` is package for analysing data from the  Spectrometer/Telescope for Imaging X-rays (STIX) instrument onboard the Solar Orbiter (SO) spacecraft.

It includes software for data search and download, data visualisation, data analysis (spectroscopy and imaging) and more.

The documentation is broken down into four keys areas.

.. grid:: 1 2 2 2
    :gutter: 3

    .. grid-item-card::
        :class-card: card

        **Tutorials** start here if you are new to STIX or ``stixpy`` as this material will help you lean to analyse STIX data in STIXpy.

        .. toctree::
            :maxdepth: 1

            tutorials/index


    .. grid-item-card::
        :class-card: card

        **How-to Guides** provide short, focused guides on common tasks go here if you need to find out how to do X.

        .. toctree::
            :maxdepth: 1

            how_to_guides/index

    .. grid-item-card::
        :class-card: card

        **Discussions** are longer explanations for example about the STIX instrument, software design choices or historical aspects of ``stixpy`` go here if you want or need to know more they 'why' than 'how'.

        .. toctree::
            :maxdepth: 1

            discussions/index

    .. grid-item-card::
        :class-card: card

        **Reference** technical descriptions of the software such as classes, functions, argument, keywords, change logs and similar.

        .. toctree::
            :maxdepth: 1

            reference/index

.. toctree::
    :maxdepth: 1