xCDAT Documentation
====================

xCDAT (Xarray Climate Data Analysis Tools) is an extension of `xarray`_ for climate data analysis on structured grids. It serves as a modern successor to the Community Data Analysis Tools (`CDAT`_) library.

.. _xarray: https://github.com/pydata/xarray
.. _CDAT: https://github.com/CDAT/cdat

**Useful links**:
`Code Repository <https://github.com/xCDAT/xcdat>`__ |
`Issues <https://github.com/xCDAT/xcdat/issues>`__ |
`Discussions <https://github.com/xCDAT/xcdat/discussions>`__ |
`Releases <https://github.com/xCDAT/xcdat/releases>`__ |
`Mailing List <https://groups.google.com/g/xcdat>`__

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

    .. grid-item-card:: Getting started
        :img-top: _static/icons/play.png
        :link: getting-started-guide/index
        :link-type: doc

    .. grid-item-card::  Examples
        :img-top: _static/icons/plot.png
        :link: gallery
        :link-type: doc

    .. grid-item-card::  API reference
        :img-top: _static/icons/wrench.png
        :link: api
        :link-type: doc

    .. grid-item-card::  Developer guide
        :img-top: _static/icons/book.png
        :link: contributing
        :link-type: doc


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

   Getting Started <getting-started-guide/index>
   Gallery <gallery>
   Presentations and Demos <demos>
   API Reference <api>
   Changelog <history>

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: For Developers/Contributors

   Code of Conduct <code-of-conduct>
   Team <team>
   Contributing Guide <contributing>
   Project Maintenance <project-maintenance>

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

   GitHub Discussions <https://github.com/xCDAT/xcdat/discussions>