.. module:: xarray

Xarray documentation
====================

Xarray makes working with labelled multi-dimensional arrays in Python simple,
efficient, and fun!

**Useful links**:
`Home <https://xarray.dev>`__ |
`Code Repository <https://github.com/pydata/xarray>`__ |
`Issues <https://github.com/pydata/xarray/issues>`__ |
`Discussions <https://github.com/pydata/xarray/discussions>`__ |
`Releases <https://github.com/pydata/xarray/releases>`__ |
`Stack Overflow <https://stackoverflow.com/questions/tagged/python-xarray>`__ |
`Mailing List <https://groups.google.com/g/xarray>`__ |
`Blog <https://xarray.dev/blog>`__


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

    .. grid-item-card:: Getting started
        :img-top: _static/index_getting_started.svg
        :link: getting-started-guide/index
        :link-type: doc

        New to *xarray*? Check out the getting started guides. They contain an
        introduction to *Xarray's* main concepts and links to additional tutorials.

    .. grid-item-card::  User guide
        :img-top: _static/index_user_guide.svg
        :link: user-guide/index
        :link-type: doc

        The user guide provides in-depth information on the
        key concepts of Xarray with useful background information and explanation.

    .. grid-item-card::  API reference
        :img-top: _static/index_api.svg
        :link: api
        :link-type: doc

        The reference guide contains a detailed description of the Xarray API.
        The reference describes how the methods work and which parameters can
        be used. It assumes that you have an understanding of the key concepts.

    .. grid-item-card::  Developer guide
        :img-top: _static/index_contribute.svg
        :link: contributing
        :link-type: doc

        Saw a typo in the documentation? Want to improve existing functionalities?
        The contributing guidelines will guide you through the process of improving
        Xarray.

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: For users

   Getting Started <getting-started-guide/index>
   User Guide <user-guide/index>
   Gallery <gallery>
   Tutorials & Videos <tutorials-and-videos>
   API Reference <api>
   How do I ... <howdoi>
   Ecosystem <ecosystem>

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: For developers/contributors

   Contributing Guide <contributing>
   Xarray Internals <internals/index>
   Development Roadmap <roadmap>
   Team <https://xarray.dev/team>
   Developers Meeting <developers-meeting>
   What’s New <whats-new>
   GitHub repository <https://github.com/pydata/xarray>

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Community

   GitHub discussions <https://github.com/pydata/xarray/discussions>
   StackOverflow <https://stackoverflow.com/questions/tagged/python-xarray>
