``xrayvision`` Documentation
----------------------------

Welcome to ``xrayvision``, a Python package providing sophisticated visibility-based imaging algorithms tailored for solar X-ray observations.
Harnessing the versatility and efficiency of Python, xrayvision seamlessly integrates advanced algorithms and visualization capabilities, offering a comprehensive toolkit for the analysis and interpretation of solar X-ray visibility data.
xrayvision equips you with the means to extract meaningful insights from complex X-ray observations with ease.
At its core, xrayvision is built upon a foundation of robust visibility-based imaging algorithms, carefully engineered to reconstruct high-fidelity images from intricate X-ray datasets. By leveraging state-of-the-art techniques, xrayvision illuminates the dynamic processes unfolding in the solar atmosphere, shedding light on the mysteries of our nearest star.

Key Features:

Advanced Visibility-Based Imaging Algorithms: xrayvision implements cutting-edge algorithms tailored specifically for solar X-ray observations, enabling precise reconstruction of solar features with unprecedented clarity and accuracy.
Efficient Data Processing: With streamlined data processing routines, xrayvision ensures swift analysis of large-scale X-ray datasets, facilitating rapid exploration and interpretation of solar phenomena.
Versatile Visualization Tools: From basic image rendering to advanced visualization techniques, xrayvision offers a rich array of tools to visualize solar X-ray data in both 2D and 3D, providing intuitive insights into solar dynamics.
Flexibility and Extensibility: Designed with flexibility in mind, xrayvision allows for easy customization and extension, empowering users to tailor the package to their specific research needs and fostering collaboration and innovation within the solar physics community.
Whether you're a seasoned solar physicist or an enthusiastic newcomer, xrayvision invites you to embark on a journey of discovery through the captivating realm of solar X-ray imaging with xrayvision as your guiding light.

The xrayvision 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 as this material will help you lean to use ``xrayvision``.

        .. 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 ``xrayvision`` 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
