From c9c137fcf74323eb682da0334bac602a37d06a14 Mon Sep 17 00:00:00 2001 From: Phil Elson Date: Fri, 27 Oct 2017 16:09:54 +0100 Subject: [PATCH] Updated 2.0 release notes. --- docs/iris/src/whatsnew/2.0.rst | 270 ++++++++++++++++++ docs/iris/src/whatsnew/2.0a0.rst | 149 ---------- ...bugfix_2017-Oct-24_abspath_fileloading.txt | 1 - .../bugfix_2017-Oct-24_file_sorting.txt | 1 - ...ement_2017-Oct-24_area-weights-speedup.txt | 1 - ...change_2017-Aug-29_fill_value_save_arg.txt | 1 - ...nge_2017-Aug-29_netCDF_packing_changes.txt | 3 - ...iblechange_2017-Oct-17_rename-pp-rules.txt | 2 - ...echange_2017-Oct-18_bitwiseint-removed.txt | 1 - ...mpatiblechange_2017-Oct-18_pp-removals.txt | 1 - ...7-Oct-18_remove-analysis-interpolation.txt | 8 - ...atiblechange_2017-Oct-18_remove-exp-ff.txt | 8 - ...compatiblechange_2017-Oct-18_remove-ff.txt | 2 - ...change_2017-Oct-18_remove-ignore-kwarg.txt | 4 - ...blechange_2017-Oct-18_remove_util_deps.txt | 1 - ...atiblechange_2017-Oct-18_removed-cmatt.txt | 1 - ...atiblechange_2017-Oct-18_rules-removal.txt | 13 - ...echange_2017-Oct-19_remove-cube-kwargs.txt | 1 - ...change_2017-Oct-19_remove-cube-methods.txt | 1 - ...e_2017-Oct-19_remove-pp-packing-module.txt | 1 - ...change_2017-Oct-19_remove-proxy-module.txt | 1 - ...nge_2017-Oct-19_remove-sample-data-dir.txt | 1 - ...echange_2017-Oct-19_remove-unit-module.txt | 1 - ...echange_2017-Oct-23_cell-datetime-objs.txt | 9 - ...tiblechange_2017-Oct-24_clip-latitudes.txt | 2 - ...ange_2017-Oct-24_convert-unknown-units.txt | 5 - ...tiblechange_2017-Oct-24_netcdf-promote.txt | 5 - 27 files changed, 270 insertions(+), 224 deletions(-) create mode 100644 docs/iris/src/whatsnew/2.0.rst delete mode 100644 docs/iris/src/whatsnew/2.0a0.rst delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/bugfix_2017-Oct-24_abspath_fileloading.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/bugfix_2017-Oct-24_file_sorting.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/enhancement_2017-Oct-24_area-weights-speedup.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Aug-29_fill_value_save_arg.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Aug-29_netCDF_packing_changes.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-17_rename-pp-rules.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_bitwiseint-removed.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_pp-removals.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-analysis-interpolation.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-exp-ff.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ff.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ignore-kwarg.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove_util_deps.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_removed-cmatt.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_rules-removal.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-cube-kwargs.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-cube-methods.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-pp-packing-module.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-proxy-module.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-sample-data-dir.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-unit-module.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-23_cell-datetime-objs.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_clip-latitudes.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_convert-unknown-units.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_netcdf-promote.txt diff --git a/docs/iris/src/whatsnew/2.0.rst b/docs/iris/src/whatsnew/2.0.rst new file mode 100644 index 0000000000..9da178dfef --- /dev/null +++ b/docs/iris/src/whatsnew/2.0.rst @@ -0,0 +1,270 @@ +What's New in Iris 2.0.0 +************************ + +:Release: 2.0.0rc1 +:Date: 2017-10-30 + + +This document explains the new/changed features of Iris in version 2.0.0 +(:doc:`View all changes `). + + +Iris 2.0.0 Features +=================== +.. _showcase: + +.. admonition:: Dask Integration + + The use of `Biggus`_ to provide support for *virtual arrays* and + *lazy evaluation* within Iris has been replaced with `Dask`_. + + In addition the concept of *lazy data*, already used for the + :class:`~iris.cube.Cube` data component, has now been extended to the + data arrays of a :class:`~iris.coords.Coord` and an + :class:`~iris.aux_factory.AuxCoordFactory`. + + This is a major feature enhancement, allowing Iris to leverage dask's rich + functionality and community knowledge. + + In particular, Dask's *threaded*, *multiprocessing* or *distributed* + `schedulers`_ can be used in order to best utilise available compute and + memory resource. + + For fuller details, see :doc:`Real and Lazy Data + `. + +* Changes to the :class:`iris.cube.Cube`: + + * The *new* :meth:`~iris.cube.Cube.core_data` method returns the *real* or + *lazy* :class:`~iris.cube.Cube` :data:`data`. + + * The *new* in-place arithmetic operators :data:`__iadd__`, :data:`__idiv__`, + :data:`__imul__`, :data:`__isub__`, and :data:`__itruediv__` have been + added to support :class:`~iris.cube.Cube` operations :data:`+=`, + :data:`/=`, :data:`*=`, and :data:`-=`. Note that, for **divison** + *__future__.division* is always in effect. + +* Changes to the :class:`iris.coords.Coord`: + + * The *new* :attr:`~iris.coords.Coord.bounds_dtype` property (read-only) + provides the :data:`dtype` of the coordinate bounds, if they exist. + + * The *new* :meth:`~iris.coords.Coord.core_points` and + :meth:`~iris.coords.Coord.core_bounds` methods return the *real* or *lazy* + :class:`~iris.coords.Coord` :data:`points` and :data:`bounds` data, + respectively. + + * The *new* :meth:`~iris.coords.Coord.has_lazy_points` and + :meth:`~iris.coords.Coord.has_lazy_bounds` boolean methods return whether + the coordinate has *lazy* :data:`points` and *lazy* :data:`bounds` data, + respectively. + + * The *new* :meth:`~iris.coords.Coord.lazy_points` and + :meth:`~iris.coords.Coord.lazy_bounds` methods return *lazy* + representations of the coordinate :data:`points` and :data:`bounds` data, + respectively. + + +The :data:`iris.FUTURE` has arrived! +------------------------------------ + +Throughout version 1 of Iris a set of toggles in +:attr:`iris.FUTURE` were maintained. These toggles allowed certain "future" +behaviour to be enabled. Since the future has now arrived in Iris 2, +all existing toggles in :attr:`iris.FUTURE` now default to :data:`True`. + + * :attr:`iris.Future.cell_datetime_objects` + + * Use of this FUTURE toggle is now deprecated + * :class:`iris.coords.Cell` objects in time coordinates now contain datetime objects by default and not numbers. + For example:: + >>> cube = iris.load_cube(iris.sample_data_path('air_temp.pp')) + >>> print(cube.coord('time').cell(0).point) + 1998-12-01 00:00:00 + + This change particularly impacts constraining datasets on time. All time constraints + must now be constructed with datetime objects or :class:`~iris.time.PartialDateTime` objects. + See userguide section 2.2.1 for more details on producing time constraints. + + + * :attr:`iris.Future.netcdf_promote` + + * Use of this FUTURE toggle is now deprecated Removed deprecated behaviour + * that does not automatically promote NetCDF variables to cubes. This change + * means that NetCDF variables that define reference surfaces for + * dimensionless vertical coordinates will always be promoted and loaded as + * independent cubes. + + * :attr:`iris.Future.netcdf_no_unlimited` + + * Use of this FUTURE toggle is now deprecated + + * :attr:`iris.Future.clip_latitudes` + + * Use of this FUTURE toggle is now deprecated + * The :meth:`iris.coords.Coord.guess_bounds()` now limits the guessed bounds + to [-90, 90] for latitudes by default. The ability to turn this behaviour + off is now deprecated. + + +Bugs Fixed +========== + +* Indexing or slicing an :class:`~iris.coords.AuxCoord` coordinate will return a coordinate with + :data:`points` and :data:`bounds` data that are new copied arrays, rather than views onto those of + the original parent coordinate. + +* Indexing or slicing a cell measure will return a new cell measure with + :data:`data` that is a new copied array, rather than a view onto the original parent cell measure. + +* Performing an in-place arithmetic :func:`~iris.analysis.maths.add`, + :func:`~iris.analysis.maths.divide`, :func:`~iris.analysis.maths.multiply`, + or :func:`~iris.analysis.maths.subtract` operation on a + :class:`~iris.cube.Cube` with :data:`integer` or :data:`boolean` data with + a :data:`float` result will raise an :data:`ArithmeticError` exception. + +* Lazy data now refers to absolute paths rather than preserving the form that + was passed to iris.load functions. This means that it is possible to use + relative paths at load, change working directory, and still expect to be able + to load any un-loaded/lazy data. (#2325) + +* The order in which files are passed to iris.load functions is now the order in + which they are processed. (#2325) + + +Incompatible Changes +==================== + +* The :meth:`~iris.cube.Cube.lazy_data` method no longer accepts any arguments. + Setting lazy data should now be done with :attr:`cube.data + `. + +.. admonition:: Significant Changes in Calculated Results + + Due to the replacement of `Biggus`_ with `Dask`_, as described above, the results + of certain types of calculation may have significantly different values from + those obtained in earlier versions. + This is of a much greater order than the usual small changes in floating + point results : it applies especially to any data with masked points, or of + long integer types. + +* Due to concerns regarding maintainability and API consistency the + :attr:`iris.cube.Cube.share_data` flag introduced in v1.13 has been removed. + Intra-cube data sharing is a oft-requested feature that we will be targeting + in a future Iris release. + +* Using :meth:`~iris.cube.Cube.convert_units` on a cube with unknown units will + now result in a :data:`UnitConversionError` being raised. + + + +Deprecation removals +-------------------- + +All deprecated functionality that was announced for removal in Iris 2.0 has +been removed. In particular: + +* The deprecated keyword arguments ``coord`` and ``name`` have been removed from + the :class:`iris.cube.Cube` constructor. + +* The deprecated methods ``iris.cube.Cube.add_history``, + ``iris.cube.Cube.assert_valid`` and ``iris.cube.Cube.regridded`` have + been removed from :class:`iris.cube.Cube`. + +* The deprecated module ``iris.fileformats.pp_packing`` has been removed. + +* The deprecated module ``iris.proxy`` has been removed. + +* The deprecated configuration variable ``SAMPLE_DATA_DIR`` has been removed + from ``iris.config`` in favour of user installation of + the ``iris-sample-data`` package. + +* The deprecated module ``iris.unit`` has been removed in favour of + :mod:`cf_units`. + +* The ``BitwiseInt`` class has been removed from :mod:`iris.fileformats.pp`. + +* Removed deprecated functions ``reset_load_rules``, ``add_save_rules``, + ``reset_save_rules`` and ``as_pairs`` from :mod:`iris.fileformats.pp`. + +* The deprecated module ``iris.analysis.interpolate`` has been removed, along + with the following deprecated classes and functions: + * ``iris.analysis.interpolate.linear`` + * ``iris.analysis.interpolate.nearest_neighbour_data_value`` + * ``iris.analysis.interpolate.regrid`` + * ``iris.analysis.interpolate.regrid_to_max_resolution`` + * ``iris.analysis.interpolate.extract_nearest_neighbour`` + * ``iris.analysis.interpolate.nearest_neighbour_indices`` + * ``iris.analysis.interpolate.Linear1dExtrapolator`` + +* Removed deprecated module ``iris.experimental.fieldsfile``. + Note that there is no direct replacement for + ``:meth:iris.experimental.fieldsfile.load``, which specifically performed + fast loading from _either_ PP or FF files. + Instead, please enable `:meth:iris.fileformats.um.structured_um_loading` and + within that context call `:meth:iris.load`, or the format-specific + `:meth:iris.fileformats.pp.load_cubes` or + `:meth:iris.fileformats.um.load_cubes`. + +* Removed deprecated module ``iris.fileformats.ff``. + Please use facilities in :mod:`iris.fileformats.um` instead. + +* Removed deprecated and unused kwarg ``ignore`` from the following functions: + * :func:`iris.analysis.calculus.curl`, + * :func:`iris.analysis.maths.add`, and + * :func:`iris.analysis.maths.subtract`. + +* Deprecated functions ``iris.util.broadcast_weights``, + ``iris.util.ensure_array`` and ``iris.util.timers`` have been removed from + :mod:`iris.util`. + +* The following classes and functions have been removed from + :mod:`iris.fileformats.rules`: + + * ``iris.fileformat.rules.calculate_forecast_period`` + * ``iris.fileformat.rules.log`` + * ``iris.fileformat.rules.CMAttribute`` + * ``iris.fileformat.rules.CMCustomAttribute`` + * ``iris.fileformat.rules.CoordAndDims`` + * ``iris.fileformat.rules.DebugString`` + * ``iris.fileformat.rules.FunctionRule`` + * ``iris.fileformat.rules.ProcedureRule`` + * ``iris.fileformat.rules.Rule`` + * ``iris.fileformat.rules.RulesContainer`` + * ``iris.fileformat.rules.RuleResult`` + +* In addition the deprecated keyword argument ``legacy_custom_rules`` has been + removed from the :class:`iris.fileformats.rules.Loader` constructor. + +* ``iris.fileformats.pp_rules`` has been renamed to + :mod:`iris.fileformats.pp_load_rules` for consistency with the new + :mod:`iris.fileformats.pp_save_rules`. + +* When saving a cube or list of cubes in NetCDF format, a fill value or list of + fill values can be specified via a new `fill_value` argument. If a list is + supplied, each fill value will be applied to each cube in turn. If a + `fill_value` argument is not specified, the default fill value for the file + format and the cube's data type will be used. Fill values are no longer taken + from the cube's `data` attribute when it is a masked array. + +* A 'fill_value' key can no longer be specified as part of the `packing` + argument to `iris.save` when saving in netCDF format. Instead, a fill value or + list of fill values should be specified as a separate `fill_value` argument if + required. + +* If the `packing` argument to `iris.save` is a dictionary, an error is raised + if it contains any keys other than 'dtype', 'scale_factor' and 'add_offset'. + + +Documentation Changes +===================== + +* A new UserGuide chapter on :doc:`Real and Lazy Data + ` has been added, and referenced from key + points in the :doc:`User Guide ` . + + +.. _Biggus: https://biggus.readthedocs.io/en/latest/ +.. _Dask: http://dask.pydata.org/en/latest/ +.. _iris_grib: https://github.com/SciTools/iris-grib/ +.. _schedulers: http://dask.pydata.org/en/latest/scheduler-overview.html diff --git a/docs/iris/src/whatsnew/2.0a0.rst b/docs/iris/src/whatsnew/2.0a0.rst deleted file mode 100644 index 159877ca2b..0000000000 --- a/docs/iris/src/whatsnew/2.0a0.rst +++ /dev/null @@ -1,149 +0,0 @@ -What's New in Iris 2.0a0 -************************ - -:Release: 2.0a0 (**alpha pre-release**) -:Date: 2017-07-03 - - -This document explains the new/changed features of Iris in version 2.0a0 -(:doc:`View all changes `). - - -Iris 2.0a0 Features -=================== -.. _showcase: - -.. admonition:: Showcase Feature - Dask Integration - - The use of `Biggus`_ to provide support for *virtual arrays* and - *lazy evaluation* within Iris has been replaced with `Dask`_. - - In addition the concept of *lazy data*, already used for the - :class:`~iris.cube.Cube` data component, has now been extended to the data array - in a :class:`~iris.coords.Coord` and an :class:`~iris.aux_factory.AuxCoordFactory`. - - This is a major feature enhancement, because basing Iris data in Dask - allows Iris to easily leverage its rich functionality and capabilities. - In particular, Dask's *threaded*, *multiprocessing* or *distributed* - `schedulers`_ can be used in order to fully exploit the available compute - resource. - - For fuller details, see :doc:`Real and Lazy Data `. - -* Changes to the :class:`iris.cube.Cube`: - - * A :class:`~iris.cube.Cube` now accepts the *new* kwargs :data:`dtype` and - :data:`fill_value`. - - * The :meth:`~iris.cube.Cube.copy` method now accepts the *new* kwargs - :data:`dtype` and :data:`fill_value`. - - * The *new* :meth:`~iris.cube.Cube.core_data` method returns the *real* or - *lazy* :class:`~iris.cube.Cube` :data:`data`. - - * The *new* :attr:`~iris.cube.Cube.fill_value` property (read-write) controls - the :data:`fill_value` used for any masked :class:`~iris.cube.Cube` - :data:`data`. - - * The *new* :meth:`~iris.cube.Cube.replace` method performs in-place - replacement of :class:`~iris.cube.Cube` :data:`data`. - - * The *new* in-place arithmetic operators :data:`__iadd__`, :data:`__idiv__`, - :data:`__imul__`, :data:`__isub__`, and :data:`__itruediv__` have been - added to support :class:`~iris.cube.Cube` operations :data:`+=`, - :data:`/=`, :data:`*=`, and :data:`-=`. Note that, for **divison** - *__future__.division* is always in effect. - -* Changes to the :class:`iris.coords.Coord`: - - * The *new* :attr:`~iris.coords.Coord.bounds_dtype` property (read-only) - provides the :data:`dtype` of the coordinate bounds, if they exist. - - * The *new* :meth:`~iris.coords.Coord.core_points` and - :meth:`~iris.coords.Coord.core_bounds` methods return the *real* or *lazy* - :class:`~iris.coords.Coord` :data:`points` and :data:`bounds` data, - respectively. - - * The *new* :meth:`~iris.coords.Coord.has_lazy_points` and - :meth:`~iris.coords.Coord.has_lazy_bounds` boolean methods return whether - the coordinate has *lazy* :data:`points` and *lazy* :data:`bounds` data, - respectively. - - * The *new* :meth:`~iris.coords.Coord.lazy_points` and - :meth:`~iris.coords.Coord.lazy_bounds` methods return *lazy* - representations of the coordinate :data:`points` and :data:`bounds` data, - respectively. - - -Bugs Fixed -========== - -* Indexing or slicing an :class:`~iris.coords.AuxCoord` coordinate will return a coordinate with - :data:`points` and :data:`bounds` data that are new copied arrays, rather than views onto those of - the original parent coordinate. - -* Indexing or slicing a cell measure will return a new cell measure with - :data:`data` that is a new copied array, rather than a view onto the original parent cell measure. - -* Performing an in-place arithmetic :func:`~iris.analysis.maths.add`, - :func:`~iris.analysis.maths.divide`, :func:`~iris.analysis.maths.multiply`, - or :func:`~iris.analysis.maths.subtract` operation on a - :class:`~iris.cube.Cube` with :data:`integer` or :data:`boolean` data with - a :data:`float` result will raise an :data:`ArithmeticError` exception. - - -Incompatible Changes -==================== - -* The :meth:`~iris.cube.Cube.lazy_data` method no longer accepts any arguments. - -.. admonition:: Significant Changes in Calculated Results - - Due to the replacement of `Biggus`_ with `Dask`_, as described above, the results - of certain types of calculation may have significantly different values from - those obtained in earlier versions. - This is of a much greater order than the usual small changes in floating - point results : it applies especially to any data with masked points, or of - long integer types. - - Firstly, as Dask does not natively support masked arrays, Iris is now using - NaNs to represent masked datapoints in most operations. The effect is that - **any NaN data values may become masked points instead**. - It is still possible to write NaN values into real data arrays, but any - following operation may now convert them to masked points. - This can obviously cause significant problems for any operations where masked - datapoints and NaNs were previously used in distinct ways : in particular, - many Iris regridding operations are significantly altered. - - Also, for related reasons, all integer data loaded from files is now - represented internally as floating point. Although such data will always be - converted back to the original dtype when realised, this can have two - potentially significant effects : **firstly**, that lazy calculations on - integer data will perform floating-point rather than integer arithmetic - operations; and **secondly** that, in long integer (8 byte) typed data, - values of magnitude more than +/-2^52 (approximately 4.5e+15) may no longer - be represented exactly. - - It is hoped that, as Dask matures, it may later be possible to remove these - particular limitations. - - -Deprecations -============ - -* The :mod:`iris.fileformats.grib` module previously deprecated in - :doc:`Iris 1.10 ` has been reinstated. The use of the - `iris_grib`_ package has now been deprecated. - - -Documentation Changes -===================== - -* A new UserGuide chapter on :doc:`Real and Lazy Data ` - has been added, and referenced from key points in the :doc:`User Guide ` . - - -.. _Biggus: https://biggus.readthedocs.io/en/latest/ -.. _Dask: http://dask.pydata.org/en/latest/ -.. _iris_grib: https://github.com/SciTools/iris-grib/ -.. _schedulers: http://dask.pydata.org/en/latest/scheduler-overview.html diff --git a/docs/iris/src/whatsnew/contributions_2.0/bugfix_2017-Oct-24_abspath_fileloading.txt b/docs/iris/src/whatsnew/contributions_2.0/bugfix_2017-Oct-24_abspath_fileloading.txt deleted file mode 100644 index 39c24a14d9..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/bugfix_2017-Oct-24_abspath_fileloading.txt +++ /dev/null @@ -1 +0,0 @@ -* Lazy data now refers to absolute paths rather than preserving the form that was passed to iris.load functions. This means that it is possible to use relative paths at load, change working directory, and still expect to be able to load any lazy data. (#2325) diff --git a/docs/iris/src/whatsnew/contributions_2.0/bugfix_2017-Oct-24_file_sorting.txt b/docs/iris/src/whatsnew/contributions_2.0/bugfix_2017-Oct-24_file_sorting.txt deleted file mode 100644 index 851a654bbd..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/bugfix_2017-Oct-24_file_sorting.txt +++ /dev/null @@ -1 +0,0 @@ -* The order in which files are passed to iris.load functions is now the order in which they are processed. (#2325) diff --git a/docs/iris/src/whatsnew/contributions_2.0/enhancement_2017-Oct-24_area-weights-speedup.txt b/docs/iris/src/whatsnew/contributions_2.0/enhancement_2017-Oct-24_area-weights-speedup.txt deleted file mode 100644 index eafe299ce8..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/enhancement_2017-Oct-24_area-weights-speedup.txt +++ /dev/null @@ -1 +0,0 @@ - * Upto 3x speedup when using regrid_area_weighted_rectilinear_src_and_grid with non-masked data. (#2730) diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Aug-29_fill_value_save_arg.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Aug-29_fill_value_save_arg.txt deleted file mode 100644 index d53450d50a..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Aug-29_fill_value_save_arg.txt +++ /dev/null @@ -1 +0,0 @@ -* When saving a cube or list of cubes in NetCDF format, a fill value or list of fill values can be specified via a new `fill_value` argument. If a list is supplied, each fill value will be applied to each cube in turn. If a `fill_value` argument is not specified, the default fill value for the file format and the cube's data type will be used. Fill values are no longer taken from the cube's `data` attribute when it is a masked array. diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Aug-29_netCDF_packing_changes.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Aug-29_netCDF_packing_changes.txt deleted file mode 100644 index c8c9f18584..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Aug-29_netCDF_packing_changes.txt +++ /dev/null @@ -1,3 +0,0 @@ -* A 'fill_value' key can no longer be specified as part of the `packing` argument to `iris.save` when saving in netCDF format. Instead, a fill value or list of fill values should be specified as a separate `fill_value` argument if required. - -* If the `packing` argument to `iris.save` is a dictionary, an error is raised if it contains any keys other than 'dtype', 'scale_factor' and 'add_offset'. diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-17_rename-pp-rules.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-17_rename-pp-rules.txt deleted file mode 100644 index 3afba8f4ae..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-17_rename-pp-rules.txt +++ /dev/null @@ -1,2 +0,0 @@ -* ```iris.fileformats.pp_rules``` has been renamed to :mod:`iris.fileformats.pp_load_rules`. - This has been done for the sake of clarity following the introduction of `iris.fileformats.pp_save_rules`. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_bitwiseint-removed.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_bitwiseint-removed.txt deleted file mode 100644 index c9d9bf5707..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_bitwiseint-removed.txt +++ /dev/null @@ -1 +0,0 @@ -* The ```BitwiseInt``` class has been removed from :mod:`iris.fileformats.pp`. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_pp-removals.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_pp-removals.txt deleted file mode 100644 index be9da42eb1..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_pp-removals.txt +++ /dev/null @@ -1 +0,0 @@ -* Removed deprecated functions ```reset_load_rules```, ```add_save_rules```, ```reset_save_rules``` and ```as_pairs``` from :mod:`iris.fileformats.pp`. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-analysis-interpolation.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-analysis-interpolation.txt deleted file mode 100644 index a82430b061..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-analysis-interpolation.txt +++ /dev/null @@ -1,8 +0,0 @@ -* The deprecated module ```iris.analysis.interpolate``` has been removed, along with the following deprecated classes and functions: - * ```iris.analysis.interpolate.linear``` - * ```iris.analysis.interpolate.nearest_neighbour_data_value``` - * ```iris.analysis.interpolate.regrid``` - * ```iris.analysis.interpolate.regrid_to_max_resolution``` - * ```iris.analysis.interpolate.extract_nearest_neighbour``` - * ```iris.analysis.interpolate.nearest_neighbour_indices``` - * ```iris.analysis.interpolate.Linear1dExtrapolator``` diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-exp-ff.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-exp-ff.txt deleted file mode 100644 index 9e6da8ac27..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-exp-ff.txt +++ /dev/null @@ -1,8 +0,0 @@ -* Removed deprecated module ```iris.experimental.fieldsfile```. - Note that there is no direct replacment for - ```:meth:iris.experimental.fieldsfile.load```, which specifically performed - fast loading from _either_ PP or FF files. - Instead, please enable `:meth:iris.fileformats.um.structured_um_loading` and - within that context call `:meth:iris.load`, or the format-specific - `:meth:iris.fileformats.pp.load_cubes` or - `:meth:iris.fileformats.um.load_cubes`. diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ff.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ff.txt deleted file mode 100644 index d140686f61..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ff.txt +++ /dev/null @@ -1,2 +0,0 @@ -* Removed deprecated module ```iris.fileformats.ff```. - Please use facilities in `:mod:iris.fileformats.um` instead. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ignore-kwarg.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ignore-kwarg.txt deleted file mode 100644 index 63e0440c77..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove-ignore-kwarg.txt +++ /dev/null @@ -1,4 +0,0 @@ -* Removed deprecated and unused kwarg ```ignore``` from the following functions: - * :func:`iris.analysis.calculus.curl`, - * :func:`iris.analysis.maths.add`, and - * :func:`iris.analysis.maths.subtract`. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove_util_deps.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove_util_deps.txt deleted file mode 100644 index ffc3984fe1..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_remove_util_deps.txt +++ /dev/null @@ -1 +0,0 @@ -* Deprecated functions ```iris.util.broadcast_weights```, ```iris.util.ensure_array``` and ```iris.util.timers``` have been removed from :mod:`iris.util`. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_removed-cmatt.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_removed-cmatt.txt deleted file mode 100644 index 2fe85c3176..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_removed-cmatt.txt +++ /dev/null @@ -1 +0,0 @@ -* The class ```CMAttribute``` has been removed from :mod:`iris.fileformats.rules`. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_rules-removal.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_rules-removal.txt deleted file mode 100644 index 9db09a91e0..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-18_rules-removal.txt +++ /dev/null @@ -1,13 +0,0 @@ -* The following classes and functions have been removed from :mod:`iris.fileformats.rules`: - * ```iris.fileformat.rules.calculate_forecast_period``` - * ```iris.fileformat.rules.log``` - * ```iris.fileformat.rules.CMAttribute``` - * ```iris.fileformat.rules.CMCustomAttribute``` - * ```iris.fileformat.rules.CoordAndDims``` - * ```iris.fileformat.rules.DebugString``` - * ```iris.fileformat.rules.FunctionRule``` - * ```iris.fileformat.rules.ProcedureRule``` - * ```iris.fileformat.rules.Rule``` - * ```iris.fileformat.rules.RulesContainer``` - * ```iris.fileformat.rules.RuleResult``` -* Removed deprecated keyword argument ```legacy_custom_rules``` from :class:`iris.fileformats.rules.Loader`. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-cube-kwargs.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-cube-kwargs.txt deleted file mode 100644 index a16eddd65c..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-cube-kwargs.txt +++ /dev/null @@ -1 +0,0 @@ -* The deprecated keyword arguments ```coord``` and ```name``` have been removed from :class:`iris.cube.Cube`. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-cube-methods.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-cube-methods.txt deleted file mode 100644 index 5d2d3b2d31..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-cube-methods.txt +++ /dev/null @@ -1 +0,0 @@ -* The deprecated methods ```iris.cube.Cube.add_history```, ```iris.cube.Cube.assert_valid``` and ```iris.cube.Cube.regridded``` have been removed from :class:`iris.cube.Cube`. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-pp-packing-module.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-pp-packing-module.txt deleted file mode 100644 index b29ea03409..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-pp-packing-module.txt +++ /dev/null @@ -1 +0,0 @@ -* The deprecated module ```iris.fileformats.pp_packing``` has been removed. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-proxy-module.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-proxy-module.txt deleted file mode 100644 index a77d083839..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-proxy-module.txt +++ /dev/null @@ -1 +0,0 @@ -* The deprecated module ```iris.proxy``` has been removed. diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-sample-data-dir.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-sample-data-dir.txt deleted file mode 100644 index 8a534ffb6f..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-sample-data-dir.txt +++ /dev/null @@ -1 +0,0 @@ -* The deprecated configuration variable ```SAMPLE_DATA_DIR``` has been removed from ```iris.config``` in favour of user installation of the ```iris-sample-data``` package. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-unit-module.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-unit-module.txt deleted file mode 100644 index 7f019aa072..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-19_remove-unit-module.txt +++ /dev/null @@ -1 +0,0 @@ -* The deprecated module ```iris.unit``` has been removed. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-23_cell-datetime-objs.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-23_cell-datetime-objs.txt deleted file mode 100644 index eceb7b3d14..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-23_cell-datetime-objs.txt +++ /dev/null @@ -1,9 +0,0 @@ -:class:`iris.coords.Cell` objects in time coordinates now contain datetime objects by default and not numbers. -For example:: - >>> cube = iris.load_cube(iris.sample_data_path('air_temp.pp')) - >>> print(cube.coord('time').cell(0).point) - 1998-12-01 00:00:00 - -This change particularly impacts constraining datasets on time. All time constraints -must now be constructed with datetime objects or :class:`~iris.time.PartialDateTime` objects. -See userguide section 2.2.1 for more details on producing time constraints. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_clip-latitudes.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_clip-latitudes.txt deleted file mode 100644 index a5b7525dd8..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_clip-latitudes.txt +++ /dev/null @@ -1,2 +0,0 @@ -The :meth:`iris.coords.Coord.guess_bounds()` now limits the guessed bounds to [-90, 90] for latitudes by default. -The ability to turn this behaviour off is now deprecated. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_convert-unknown-units.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_convert-unknown-units.txt deleted file mode 100644 index 138f822331..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_convert-unknown-units.txt +++ /dev/null @@ -1,5 +0,0 @@ -* Using :meth:`~iris.cube.Cube.convert_units` on a cube with unknown units will - result in a :data:`UnitConversionError` being raised. - -* Using :meth:`~iris.coords.Coord.convert_units` on a coordinate with unknown - units will result in a :data:`UnitConversionError` being raised. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_netcdf-promote.txt b/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_netcdf-promote.txt deleted file mode 100644 index c277df8e2a..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.0/incompatiblechange_2017-Oct-24_netcdf-promote.txt +++ /dev/null @@ -1,5 +0,0 @@ -* Deprecated FUTURE flag :attr:`iris.Future.netcdf_promote`. - -* Removed deprecated behaviour that does not automatically promote NetCDF variables to cubes. - This change means that NetCDF variables that define reference surfaces for dimensionless vertical coordinates - will always be promoted and loaded as independent cubes. \ No newline at end of file