************************
sunpy core Documentation
************************

``sunpy`` is a community-developed, free and open-source solar data analysis environment for Python.
It includes an interface for searching and downloading data from multiple data providers, data containers for image and time series data, commonly used solar coordinate frames and associated transformations, as well as other functionality needed for solar data analysis.

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

    .. grid-item-card:: Tutorial
        :link: sunpy-tutorial-index
        :link-type: ref
        :text-align: center

        :material-outlined:`accessibility_new;8em;sd-text-secondary`

        **New users start here!**
        Walkthrough on how to install sunpy and use the key features of the package.

    .. grid-item-card:: How-to Guides
        :link: sunpy-how-to-index
        :link-type: ref
        :text-align: center

        :material-outlined:`menu_book;8em;sd-text-secondary`

        Snippets of code for accomplishing specific tasks with sunpy.
        Most useful for answering "How do I..." questions.

    .. grid-item-card:: Example gallery
        :link: generated/gallery
        :text-align: center

        :material-outlined:`palette;8em;sd-text-secondary`

        Examples including plots on accomplishing common tasks using sunpy.

    .. grid-item-card:: Topic Guides
        :link: sunpy-topic-guide-index
        :link-type: ref
        :text-align: center

        :material-outlined:`school;8em;sd-text-secondary`

        In-depth explanations of concepts and key topics.
        Most useful for answering "why" questions.

    .. grid-item-card:: Reference
        :link: reference
        :link-type: ref
        :text-align: center

        :material-outlined:`code;8em;sd-text-secondary`

        Technical description of the inputs, outputs, and behavior of each component of sunpy.

    .. grid-item-card:: Get Help
        :text-align: center

        :material-outlined:`live_help;8em;sd-text-secondary`

        .. button-link:: https://app.element.io/#/room/#sunpy:openastronomy.org
            :shadow:
            :expand:
            :color: warning

            **Join the chat**

        .. button-link:: https://github.com/sunpy/sunpy/issues
            :shadow:
            :expand:
            :color: warning

            **Report an issue**

        .. button-link:: https://community.openastronomy.org/c/sunpy/5
            :shadow:
            :expand:
            :color: warning

            **Post on Discourse**

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

    tutorial/index
    tutorial/installation
    generated/gallery/index
    how_to/index
    topic_guide/index
    reference/index
    whatsnew/index
    citation
    reference/known_issues
    reference/stability
    dev_guide/index
