-
Notifications
You must be signed in to change notification settings - Fork 285
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added the what's new for iris 2.1 (#3044)
Added the what's new for iris 2.1
- Loading branch information
Showing
17 changed files
with
79 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
What's New in Iris 2.1 | ||
********************** | ||
|
||
:Release: 2.1 | ||
:Date: 2018-06-06 | ||
|
||
This document explains the new/changed features of Iris in version 2.1 | ||
(:doc:`older "What's New" release notes can be found here<index>`.) | ||
|
||
|
||
Iris 2.1 Dependency updates | ||
=========================== | ||
|
||
* The `cf_units <https://github.com/SciTools/cf_units>`_ dependency | ||
was updated to cf_units ``v2.0``. | ||
cf_units v2 is almost entirely backwards compatible with v1. | ||
However the ability to preserve some aliased calendars has been removed. | ||
For this reason, it is possible that NetCDF load of a variable with a | ||
"standard" calendar will result in a saved NetCDF of a "gregorian" | ||
calendar. | ||
* Iris updated its time-handling functionality from the | ||
`netcdf4-python <http://unidata.github.io/netcdf4-python/>`_ | ||
``netcdftime`` implementation to the standalone module | ||
`cftime <https://github.com/Unidata/cftime>`_. | ||
cftime is entirely compatible with netcdftime, but some issues may | ||
occur where users are constructing their own datetime objects. | ||
In this situation, simply replacing ``netcdftime.datetime`` with | ||
``cftime.datetime`` should be sufficient. | ||
* Iris now requires version 2 of Matplotlib, and ``>=1.14`` of NumPy. | ||
Full requirements can be seen in the `requirements <https://github.com/SciTools/iris/>`_ | ||
directory of the Iris' the source. | ||
|
||
Iris 2.1 Features | ||
================= | ||
|
||
* Added ``repr_html`` functionality to the :class:`~iris.cube.Cube` to provide | ||
a rich html representation of cubes in Jupyter notebooks. | ||
|
||
.. image:: images/notebook_repr.png | ||
|
||
* Updated :func:`iris.cube.Cube.name` to return a STASH code if the cube has | ||
one and no other valid names are present. This is now consistent with the | ||
summary information from :func:`iris.cube.Cube.summary`. | ||
* The partial collapse of multi-dimensional auxiliary coordinates is now | ||
supported. Collapsed bounds span the range of the collapsed dimension(s). | ||
* Added new function :func:`iris.cube.CubeList.realise_data` to compute | ||
multiple lazy values in a single operation, avoiding repeated re-loading of | ||
data or re-calculation of expressions. | ||
* The methods :meth:`iris.cube.Cube.convert_units` and | ||
:meth:`iris.coords.Coord.convert_units` no longer forcibly realise the cube | ||
data or coordinate points/bounds. The converted values are now lazy arrays | ||
if the originals were. | ||
* Added :meth:`iris.analysis.trajectory.interpolate` that allows you to | ||
interpolate to find values along a trajectory. | ||
* It is now possible to add an attribute of ``missing_value`` to a cube. | ||
https://github.com/SciTools/iris/issues/1588 | ||
* Iris can now represent data on the Albers Equal Area Projection, | ||
and the NetCDF loader and saver were updated to handle this. | ||
https://github.com/SciTools/iris/issues/2943 | ||
|
||
Bugs Fixed | ||
========== | ||
|
||
* All var names being written to NetCDF are now CF compliant. | ||
Non alpha-numeric characters are replaced with '_', and var names now always | ||
have a leading letter. https://github.com/SciTools/iris/pull/2930 | ||
* A cube resulting from a regrid operation using the `iris.analysis.AreaWeighted` | ||
regridding scheme will now have the smallest floating point data type | ||
to which the source cube's data type can be safely converted using NumPy's | ||
type promotion rules. | ||
|
||
Incompatible Changes | ||
==================== | ||
* The deprecated :mod:`iris.experimental.um` was removed. | ||
Please use consider using `mule <https://github.com/SciTools/mule>`_ | ||
as an alternative. |
1 change: 0 additions & 1 deletion
1
...atsnew/contributions_2.0/incompatiblechange_2018-Jan-12_area_weighted_regridder_dtype.txt
This file was deleted.
Oops, something went wrong.
2 changes: 0 additions & 2 deletions
2
docs/iris/src/whatsnew/contributions_2.1/bugfix_2018-May-03_var_name_constraint.txt
This file was deleted.
Oops, something went wrong.
1 change: 0 additions & 1 deletion
1
.../src/whatsnew/contributions_2.1/incompatiblechange_2018-May-01_remove_experimental_um.txt
This file was deleted.
Oops, something went wrong.
4 changes: 0 additions & 4 deletions
4
docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-Feb-04_lazy_convert_units.txt
This file was deleted.
Oops, something went wrong.
1 change: 0 additions & 1 deletion
1
docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-Jan-04_missing_value_attr.txt
This file was deleted.
Oops, something went wrong.
1 change: 0 additions & 1 deletion
1
docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-Jan-18_trajectory-interpolate.txt
This file was deleted.
Oops, something went wrong.
3 changes: 0 additions & 3 deletions
3
docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-Mar-08_co_realise_cubes.txt
This file was deleted.
Oops, something went wrong.
2 changes: 0 additions & 2 deletions
2
docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-May-03_multidim_collapse.txt
This file was deleted.
Oops, something went wrong.
3 changes: 0 additions & 3 deletions
3
docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-May-03_stash_names.txt
This file was deleted.
Oops, something went wrong.
2 changes: 0 additions & 2 deletions
2
docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-May-08_repr-html.txt
This file was deleted.
Oops, something went wrong.
4 changes: 0 additions & 4 deletions
4
docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-May-22_cf_units_2.txt
This file was deleted.
Oops, something went wrong.
2 changes: 0 additions & 2 deletions
2
docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-May-23_cftime.txt
This file was deleted.
Oops, something went wrong.
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,6 +9,7 @@ Iris versions. | |
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
2.1.rst | ||
2.0.rst | ||
1.13.rst | ||
1.12.rst | ||
|