Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/guide/sources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1240,7 +1240,9 @@ zarr
.. py:function:: from_source("zarr", path)
:noindex:

The ``zarr`` source accesses data from a `Zarr <https://zarr.readthedocs.io/en/stable/>`_ store. Internally the data is loaded via the :py:meth:`xarray.open_zarr` method. So only Zarr data supported by Xarray can be accessed.
*New in version 0.15.0*

The ``zarr`` source accesses data from a `Zarr <https://zarr.readthedocs.io/en/stable/>`_ store. Internally the data is loaded via the :py:meth:`xarray.open_zarr` method, so only Zarr data supported by Xarray can be accessed. Requires ``zarr >= 3`` version.

:param str path: path or URL to the Zarr store

Expand Down
28 changes: 4 additions & 24 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Installing from PyPI
Minimal installation
+++++++++++++++++++++++++

Install **earthkit-data** with python3 (>= 3.8) and ``pip`` as follows:
Install **earthkit-data** with python3 (>= 3.9) and ``pip`` as follows:

.. code-block:: bash

Expand All @@ -20,7 +20,7 @@ The package installed like this is **minimal** supporting only GRIB and NetCDF d
Installing all the optional packages
++++++++++++++++++++++++++++++++++++++++

You can install **earthkit-data** with all the optional packages (with the exception of "geotiff" dependencies, see below) in one go by using:
You can install **earthkit-data** with all the optional packages (with the exception of the "geotiff" and "zarr" dependencies, see below) in one go by using:

.. code-block:: bash

Expand Down Expand Up @@ -51,6 +51,7 @@ Alternatively, you can install the following components:
- covjsonkit: provides access to CoverageJSON data served by the :ref:`data-sources-polytope` source
- s3: provides access to non-public :ref:`s3 <data-sources-s3>` buckets (new in version *0.11.0*)
- geotiff: adds GeoTIFF support (new in version *0.11.0*). Please note that this is not included in the ``[all]`` option and has to be invoked separately.
- zarr: provides access to the :ref:`data-sources-zarr` source (new in version *0.15.0*). Please note that this is not included in the ``[all]`` option and has to be invoked separately.

E.g. to add :ref:`data-sources-mars` support you can use:

Expand All @@ -76,31 +77,10 @@ Install **earthkit-data** via ``conda`` with:

This will bring in some necessary binary dependencies for you.


Installing the binary dependencies
--------------------------------------

ecCodes
+++++++++++

**earthkit-data** depends on the ECMWF :xref:`eccodes` library
that must be installed on the system and accessible as a shared library.

When earthkit-data is installed from ``conda`` ecCodes will **also be installed** for you. Otherwise, you need to install it using one of the following methods:

- The easiest way to install it is to use ``conda``:

.. code-block:: bash

conda install eccodes -c conda-forge

- On a MacOS it is also available from ``HomeBrew``:

.. code-block:: bash

brew install eccodes

- As an alternative you may install the official source distribution by following the instructions `here <https://software.ecmwf.int/wiki/display/ECC/ecCodes+installation>`_.

FDB
+++++

Expand Down