|
1 | 1 | .. include:: ../common_links.inc
|
2 | 2 |
|
3 |
| -|iris_version| |build_date| [unreleased] |
4 |
| -**************************************** |
| 3 | +v3.12 (10 Mar 2025 [release candidate]) |
| 4 | +*************************************** |
5 | 5 |
|
6 | 6 | This document explains the changes made to Iris for this release
|
7 | 7 | (:doc:`View all changes <index>`.)
|
8 | 8 |
|
9 | 9 |
|
10 |
| -.. dropdown:: |iris_version| Release Highlights |
| 10 | +.. dropdown:: v3.12 Release Highlights |
11 | 11 | :color: primary
|
12 | 12 | :icon: info
|
13 | 13 | :animate: fade-in
|
14 | 14 | :open:
|
15 | 15 |
|
16 | 16 | The highlights for this major/minor release of Iris include:
|
17 | 17 |
|
18 |
| - * N/A |
| 18 | + * Iris now supports Python version 3.13, and has dropped support for Python 3.10, |
| 19 | + as per the Scientific Python |
| 20 | + `SPEC 0 <https://scientific-python.org/specs/spec-0000/>`_ schedule. |
| 21 | + |
| 22 | + * Data is now optional in a cube, which can simplify the regridding process and lay |
| 23 | + the ground work for future features. See :issue:`4447`. |
| 24 | + |
| 25 | + * Added :data:`iris.loading.LOAD_PROBLEMS` to capture objects which could not be |
| 26 | + loaded correctly, to assist in fixing loading problems via the Iris API. Several |
| 27 | + loading operations no longer raise their own warnings; instead their loading |
| 28 | + problems are captured in the common object, and a single generic warning is raised. |
| 29 | + See :class:`iris.loading.LoadProblems`. |
| 30 | + |
| 31 | + * Extended the features of :class:`iris.LoadPolicy` and :data:`iris.LOAD_POLICY`, |
| 32 | + which are now renamed to :class:`iris.CombineOptions` and |
| 33 | + :data:`iris.COMBINE_POLICY` respectively, and gave access to the mechanism in the |
| 34 | + new :func:`iris.util.combine_cubes` utility. |
| 35 | + |
| 36 | + * Added two new utility functions, :func:`iris.util.combine_cubes` and |
| 37 | + :meth:`iris.util.equalise_cubes`, to assist with merge/concatenate, as well as |
| 38 | + other features to improve loading control. |
| 39 | + |
| 40 | + Checkout the performance enhancements section for an array of improvements to the |
| 41 | + performance of Iris. Special thanks to the ESMValTool devs for these contributions. |
19 | 42 |
|
20 | 43 | And finally, get in touch with us on :issue:`GitHub<new/choose>` if you have
|
21 | 44 | any issues or feature requests for improving Iris. Enjoy!
|
@@ -91,11 +114,11 @@ This document explains the changes made to Iris for this release
|
91 | 114 | older NetCDF formats e.g. ``NETCDF4_CLASSIC`` support a maximum precision of
|
92 | 115 | 32-bit. (:issue:`6178`, :pull:`6343`)
|
93 | 116 |
|
94 |
| -# `@ukmo-ccbunney` added support for loading NetCDF variable-length string types |
| 117 | +#. `@ukmo-ccbunney`_ added support for loading NetCDF variable-length string types |
95 | 118 | and size hinting for better lazy loading (:issue:`6149`, :pull:`6340`)
|
96 | 119 |
|
97 | 120 | #. `@bouweandela`_ fixed handling of masked Dask arrays in
|
98 |
| - :func:`~iris.util.array_equal`. |
| 121 | + :func:`~iris.util.array_equal`. |
99 | 122 |
|
100 | 123 |
|
101 | 124 | 💣 Incompatible Changes
|
@@ -179,19 +202,18 @@ This document explains the changes made to Iris for this release
|
179 | 202 | :doc:`/developers_guide/release_do_nothing` to be more thorough and apply
|
180 | 203 | lessons learned from recent releases. (:pull:`6062`)
|
181 | 204 |
|
182 |
| -#. `@schlunma`_ made lazy [smart |
183 |
| - weights](https://github.com/SciTools/iris/pull/5084) used for cube |
184 |
| - aggregations have the same chunks as their parent cube if broadcasting is |
185 |
| - necessary. (:issue:`6285`, :pull:`6288`) |
| 205 | +#. `@schlunma`_ made lazy `smart weights <https://github.com/SciTools/iris/pull/5084>`_ |
| 206 | + used for cube aggregations have the same chunks as their parent cube if broadcasting |
| 207 | + is necessary. (:issue:`6285`, :pull:`6288`) |
186 | 208 |
|
187 | 209 | #. `@trexfeathers`_ improved the handling of benchmark environments, especially
|
188 | 210 | when working across Python versions. (:pull:`6329`)
|
189 | 211 |
|
190 |
| -#. `@trexfeathers`_ temporarily pinned Sphinx to `<8.2`. |
| 212 | +#. `@trexfeathers`_ temporarily pinned Sphinx to < 8.2. |
191 | 213 | (:pull:`6344`, :issue:`6345`)
|
192 | 214 |
|
193 | 215 | #. `@bouweandela`_ fixed a bug in the benchmarking code that caused all benchmarks
|
194 |
| - to be run with lazy data. (:pull:`6339`) |
| 216 | + to be run with lazy data. (:pull:`6339`) |
195 | 217 |
|
196 | 218 |
|
197 | 219 | .. comment
|
|
0 commit comments