xarrera
=============

Schema validation for `Xarray`_ objects.

Xarrera is an open source project that provides an API for performing data-format validation on
Xarray objects.
Its API is inspired by `Pandera`_, a popular validation library for `pandas`_ DataFrames.

Xarrera is a fork of `xarray-schema`_. Because xarray-schema became inactive and remained unfinished,
this fork was created to continue development, fix outstanding issues, and make the package available on PyPI.

.. _xarray: https://xarray.dev
.. _pandera: https://pandera.readthedocs.io/
.. _pandas: https://pandas.pydata.org/
.. _xarray-schema: https://github.com/xarray-contrib/xarray-schema

.. warning::

   This package is experimental, and new versions might introduce backwards incompatible
   changes.

.. toctree::
   :maxdepth: 1
   :caption: Getting Started:

   installation
   quickstart

.. toctree::
   :maxdepth: 1
   :caption: Help & Reference:

   api