Installation
============

Required dependencies
---------------------

- `Xarray <http://xarray.pydata.org/>`__


.. _optional_dependencies:

Optional dependencies
---------------------

recursive-diff supports Xarray objects backed by `Dask <https://dask.org/>`__, as well
as Dask delayed objects. It is recommended to use Dask to compare files with
:func:`~recursive_diff.recursive_open` or the :doc:`cli`.

Dependencies needed to open files:

- **MessagePack:** `msgpack <https://github.com/msgpack/msgpack-python/>`__
- **YAML:** `PyYAML <https://pyyaml.org/>`__
- **netCDF v3:** `netCDF4 <https://unidata.github.io/netcdf4-python/>`__
  or `scipy <https://www.scipy.org/>`__
- **netCDF v4:** `netCDF4 <https://unidata.github.io/netcdf4-python/>`__
  or `h5netcdf <https://h5netcdf.org/>`__
- **Zarr v2/v3:** `Zarr <https://zarr.readthedocs.io/>`__

Installing with conda
---------------------

.. code-block:: bash

    conda install -c conda-forge recursive_diff


Installing with pip
-------------------

For a minimal installation:

.. code-block:: bash

    pip install recursive-diff

You may also install all optional dependencies to enable
support for all file formats and Dask:

.. code-block:: bash

    pip install recursive-diff[all]


.. _mindeps_policy:

Minimum dependency versions
---------------------------

This project adopts a rolling policy based on `SPEC 0
<https://scientific-python.org/specs/spec-0000/>`_ regarding the minimum
supported version of its dependencies.

You can see the actual minimum tested versions in `pyproject.toml
<https://github.com/crusaderky/recursive_diff/blob/main/pyproject.toml>`_.