:html_theme.sidebar_secondary.remove: true

.. module:: xarray

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

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

**Version**: |version| - :ref:`whats-new`

**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>`__ |
`Tutorial <https://tutorial.xarray.dev>`__ |
`Stack Overflow <https://stackoverflow.com/questions/tagged/python-xarray>`__ |
`Blog <https://xarray.dev/blog>`__ |

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

    .. grid-item-card:: Get started!
        :img-top: _static/index_getting_started.svg
        :class-card: intro-card
        :link: getting-started-guide/index
        :link-type: doc

        *New to Xarray?*
        Start here with our installation instructions and a brief overview of Xarray.

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

        *Ready to deepen your understanding of Xarray?*
        Visit the user guide for detailed explanations of the data model, common computational patterns, and more.

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

        *Need to learn more about a specific Xarray function?*
        Go here to review the documentation of all public functions and classes in Xarray.

    .. grid-item-card::  Contribute
        :img-top: _static/index_contribute.svg
        :class-card: intro-card
        :link: contribute/contributing
        :link-type: doc

        *Saw a typo in the documentation? Want to improve existing functionalities?*
        Please review our guide on improving Xarray.

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

   Get Started <getting-started-guide/index>
   User Guide <user-guide/index>
   Tutorial <https://tutorial.xarray.dev>
   Gallery <gallery>
   API Reference <api>
   Get Help <get-help/help-diagram>
   Contribute <contribute/index>
   Release Notes <whats-new>
