@@ -33,23 +33,8 @@ v0.11.0 (unreleased)
3333Breaking changes
3434~~~~~~~~~~~~~~~~
3535
36- - For non-standard calendars commonly used in climate science, xarray will now
37- always use :py:class: `cftime.datetime ` objects, rather than by default try to
38- coerce them to ``np.datetime64[ns] `` objects. A
39- :py:class: `~xarray.CFTimeIndex ` will be used for indexing along time
40- coordinates in these cases. A new method,
41- :py:meth: `~xarray.CFTimeIndex.to_datetimeindex `, has been added
42- to aid in converting from a :py:class: `~xarray.CFTimeIndex ` to a
43- :py:class: `pandas.DatetimeIndex ` for the remaining use-cases where
44- using a :py:class: `~xarray.CFTimeIndex ` is still a limitation (e.g. for
45- resample or plotting). Setting the ``enable_cftimeindex `` option is now a
46- no-op and emits a ``FutureWarning ``.
47- - ``Dataset.T `` has been removed as a shortcut for :py:meth: `Dataset.transpose `.
48- Call :py:meth: `Dataset.transpose ` directly instead.
49- - Iterating over a ``Dataset `` now includes only data variables, not coordinates.
50- Similarily, calling ``len `` and ``bool `` on a ``Dataset `` now
51- includes only data variables
52- - Finished deprecation cycles:
36+ - Finished deprecations (changed behavior with this release):
37+
5338 - ``Dataset.T `` has been removed as a shortcut for :py:meth: `Dataset.transpose `.
5439 Call :py:meth: `Dataset.transpose ` directly instead.
5540 - Iterating over a ``Dataset `` now includes only data variables, not coordinates.
@@ -62,34 +47,49 @@ Breaking changes
6247 raise an error in most cases. You need to use the new resample syntax
6348 instead, e.g., ``data.resample(time='1D').mean() `` or
6449 ``data.resample({'time': '1D'}).mean() ``.
65- - Xarray's storage backends now automatically open and close files when
66- necessary, rather than requiring opening a file with ``autoclose=True ``. A
67- global least-recently-used cache is used to store open files; the default
68- limit of 128 open files should suffice in most cases, but can be adjusted if
69- necessary with
70- ``xarray.set_options(file_cache_maxsize=...) ``. The ``autoclose `` argument
71- to ``open_dataset `` and related functions has been deprecated and is now a
72- no-op.
73-
74- This change, along with an internal refactor of xarray's storage backends,
75- should significantly improve performance when reading and writing
76- netCDF files with Dask, especially when working with many files or using
77- Dask Distributed. By `Stephan Hoyer <https://github.com/shoyer >`_
78- - Tutorial data is now loaded lazily. Previous behavior of
79- :py:meth: `xarray.tutorial.load_dataset ` would call `Dataset.load() ` prior
80- to returning. This was changed in order to facilitate using this data with
81- dask.
82- By `Joe Hamman <https://github.com/jhamman >`_.
8350
84- Documentation
85- ~~~~~~~~~~~~~
86- - Reduction of :py:meth: `DataArray.groupby ` and :py:meth: `DataArray.resample `
87- without dimension argument will change in the next release.
88- Now we warn a FutureWarning.
89- By `Keisuke Fujii <https://github.com/fujiisoup >`_.
90- - The ``inplace `` kwarg of a number of `DataArray ` and `Dataset ` methods is being
91- deprecated and will be removed in the next release.
92- By `Deepak Cherian <https://github.com/dcherian >`_.
51+
52+ - New deprecations (behavior will be changed in xarray 0.12):
53+
54+ - Reduction of :py:meth: `DataArray.groupby ` and :py:meth: `DataArray.resample `
55+ without dimension argument will change in the next release.
56+ Now we warn a FutureWarning.
57+ By `Keisuke Fujii <https://github.com/fujiisoup >`_.
58+ - The ``inplace `` kwarg of a number of `DataArray ` and `Dataset ` methods is being
59+ deprecated and will be removed in the next release.
60+ By `Deepak Cherian <https://github.com/dcherian >`_.
61+
62+
63+ - Refactored storage backends:
64+
65+ - Xarray's storage backends now automatically open and close files when
66+ necessary, rather than requiring opening a file with ``autoclose=True ``. A
67+ global least-recently-used cache is used to store open files; the default
68+ limit of 128 open files should suffice in most cases, but can be adjusted if
69+ necessary with
70+ ``xarray.set_options(file_cache_maxsize=...) ``. The ``autoclose `` argument
71+ to ``open_dataset `` and related functions has been deprecated and is now a
72+ no-op.
73+
74+ This change, along with an internal refactor of xarray's storage backends,
75+ should significantly improve performance when reading and writing
76+ netCDF files with Dask, especially when working with many files or using
77+ Dask Distributed. By `Stephan Hoyer <https://github.com/shoyer >`_
78+
79+
80+ - Support for non-standard calendars used in climate science:
81+
82+ - Xarray will now always use :py:class: `cftime.datetime ` objects, rather
83+ than by default trying to coerce them into ``np.datetime64[ns] `` objects.
84+ A :py:class: `~xarray.CFTimeIndex ` will be used for indexing along time
85+ coordinates in these cases.
86+ - A new method :py:meth: `~xarray.CFTimeIndex.to_datetimeindex ` has been added
87+ to aid in converting from a :py:class: `~xarray.CFTimeIndex ` to a
88+ :py:class: `pandas.DatetimeIndex ` for the remaining use-cases where
89+ using a :py:class: `~xarray.CFTimeIndex ` is still a limitation (e.g. for
90+ resample or plotting).
91+ - Setting the ``enable_cftimeindex `` option is now a no-op and emits a
92+ ``FutureWarning ``.
9393
9494Enhancements
9595~~~~~~~~~~~~
@@ -126,6 +126,13 @@ Enhancements
126126 consistent with other xarray functions that accept either dictionaries or
127127 keyword arguments. By `Stephan Hoyer <https://github.com/shoyer >`_.
128128
129+ - The preferred way to access tutorial data is now to load it lazily with
130+ :py:meth: `xarray.tutorial.open_dataset `.
131+ :py:meth: `xarray.tutorial.load_dataset ` calls `Dataset.load() ` prior
132+ to returning (and is now deprecated). This was changed in order to facilitate
133+ using tutorial datasets with dask.
134+ By `Joe Hamman <https://github.com/jhamman >`_.
135+
129136Bug fixes
130137~~~~~~~~~
131138
0 commit comments