From a8c3025361cb08f504202a4d5ca999253b6ad0d0 Mon Sep 17 00:00:00 2001 From: Sandor Kertesz Date: Wed, 27 Mar 2024 15:32:02 +0000 Subject: [PATCH] Update docs --- docs/interpolate.rst | 2 +- docs/release_notes/version_0.3_updates.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/interpolate.rst b/docs/interpolate.rst index d76af35..3734fe3 100644 --- a/docs/interpolate.rst +++ b/docs/interpolate.rst @@ -5,7 +5,7 @@ interpolate Interpolate the ``values`` from the ``in_grid`` onto the ``out_grid``. - :param values: the input data. It can be an ndarray or an earthkit-data GRIB :xref:`fieldlist`. ndarrays are assumed to be defined on the ``in_grid``. + :param values: the input data. It can be an ndarray or an earthkit-data GRIB :xref:`fieldlist`. ndarrays are assumed to be defined on the ``in_grid``. The :xref:`fieldlist` support requires :xref:`earthkit-data` >= 0.6.0 and only works when the ``out_grid`` is a regular latitude-longitude grid. :type values: ndarray, :xref:`fieldlist` :param in_grid: the :ref:`gridspec ` describing the grid that ``values`` are defined on. When ``values`` is a :xref:`fieldlist` the input grid is automatically detected and ``in_grid`` cannot be specified. :type in_grid: dict diff --git a/docs/release_notes/version_0.3_updates.rst b/docs/release_notes/version_0.3_updates.rst index 8b49b1f..5e1517a 100644 --- a/docs/release_notes/version_0.3_updates.rst +++ b/docs/release_notes/version_0.3_updates.rst @@ -10,7 +10,7 @@ New features ++++++++++++++++ - restructured and regenerated matrix inventory - allow using the ``method`` keyword in :func:`interpolate` to specify the interpolation method -- allow using earthkit-data GRIB :xref:`fieldlist` in :func:`interpolate` as input data. This only works when the output grid is regular latitude-longitude grid. +- allow using earthkit-data GRIB :xref:`fieldlist` in :func:`interpolate` as input data. This only works when the output grid is regular latitude-longitude grid. This feature requires :xref:`earthkit-data` >= 0.6.0 - added notebook examples: - :ref:`/examples/healpix_fieldlist.ipynb`