Skip to content

Commit 081c313

Browse files
committed
Add release note
1 parent 8e16424 commit 081c313

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/releases/development.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,19 @@ Next release (in development)
3535
(:pr:`142`).
3636
* Add :attr:`.Convention.depth_coordinates` and :meth:`.Convention.get_depth_coordinate_for_data_array()`. Deprecate functions :meth:`.Convention.get_depth_name()`, :meth:`.Convention.get_all_depth_names()`, and :meth:`Convention.get_time_name()`. Remove deprecated functions ``Convention.get_depths()`` and ``Convention.get_times()`` (:pr:`143`).
3737
* Swap to using `pyproject.toml` for all project metadata (:pr:`145`).
38+
* Add new methods
39+
:meth:`.Convention.selector_for_indexes()`,
40+
:meth:`.Convention.select_indexes()`, and
41+
:meth:`.Convention.select_points()`.
42+
These allow for more efficient extraction of multiple points at the same time.
43+
The return type of :meth:`.Convention.selector_for_index()` has been changed
44+
from a `dict` to an :class:`xarray.Dataset`,
45+
but this new value is also designed to be passed directly to :meth:`Dataset.isel() <xarray.Dataset.isel>`.
46+
:meth:`.Convention.select_index()` and :meth:`.Convention.select_indexes()`
47+
have a new `drop_geometry` flag which defaults to True.
48+
Previously these methods would act as if `drop_geometry` was False,
49+
but this led to convention-dependent results as to which geometry variables were returned.
50+
The fragmented geometry variables from different conventions often did not contain enough data to be useful.
51+
By dropping geometry the results are more consistent across all conventions
52+
and do not contain potentially fragmented geometry information.
53+
(:issue:`106`, :pr:`146`).

0 commit comments

Comments
 (0)