From 66e04406e82811235a71465ee047e9b2fb8f6a09 Mon Sep 17 00:00:00 2001 From: Sandor Kertesz Date: Tue, 17 Jun 2025 11:39:11 +0100 Subject: [PATCH] Update docs --- docs/guide/sources.rst | 4 +++- docs/install.rst | 28 ++++------------------------ 2 files changed, 7 insertions(+), 25 deletions(-) diff --git a/docs/guide/sources.rst b/docs/guide/sources.rst index d9d4f10b2..9819a9b04 100644 --- a/docs/guide/sources.rst +++ b/docs/guide/sources.rst @@ -1240,7 +1240,9 @@ zarr .. py:function:: from_source("zarr", path) :noindex: - The ``zarr`` source accesses data from a `Zarr `_ 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 `_ 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 diff --git a/docs/install.rst b/docs/install.rst index 260825fe3..e9be3ef16 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -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 @@ -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 @@ -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 ` 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: @@ -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 `_. - FDB +++++