Skip to content

Commit 79bc09e

Browse files
authored
Added whatsnew notes on netcdf delayed saving and Distributed support. (#5322)
* Added whatsnew notes on netcdf delayed saving and Distributed support. * Fix formatting. * --amend Review change. * Fix formatting.
1 parent aea58cc commit 79bc09e

File tree

1 file changed

+45
-22
lines changed

1 file changed

+45
-22
lines changed

docs/src/whatsnew/3.6.rst

Lines changed: 45 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,51 @@ This document explains the changes made to Iris for this release
88

99

1010
.. dropdown:: v3.6 Release Highlights
11-
:color: primary
12-
:icon: info
13-
:animate: fade-in
14-
:open:
15-
16-
We're so excited about our recent support for **delayed saving of lazy data
17-
to netCDF** (:pull:`5191`) that we're celebrating this important step change
18-
in behavour with its very own dedicated release 🥳
19-
20-
We're super keen for the community to leverage the benefit of this new
21-
feature within Iris that we've brought this release forward several months.
22-
As a result, this minor release of Iris is intentionally light in content.
23-
However, there are some other goodies available for you to enjoy, such as:
24-
25-
* Performing lazy arithmetic with an Iris :class:`~iris.cube.Cube` and a
26-
:class:`dask.array.Array`, and
27-
* Various improvements to our documentation resulting from adoption of
28-
`sphinx-design`_ and `sphinx-apidoc`_.
29-
30-
As always, get in touch with us on :issue:`GitHub<new/choose>`, particularly
31-
if you have any feedback with regards to delayed saving, or have any issues
32-
or feature requests for improving Iris. Enjoy!
11+
:color: primary
12+
:icon: info
13+
:animate: fade-in
14+
:open:
15+
16+
We're so excited about our recent support for **delayed saving of lazy data
17+
to netCDF** (:pull:`5191`) that we're celebrating this important step change
18+
in behavour with its very own dedicated release 🥳
19+
20+
By using ``iris.save(..., compute=False)`` you can now save to multiple netcdf files
21+
in parallel. See the new ``compute`` keyword in :func:`iris.fileformats.netcdf.save`.
22+
This can share and re-use any common (lazy) result computations, and it makes much
23+
better use of resources during any file-system waiting (i.e. it can use such periods to
24+
progress the *other* saves).
25+
26+
Usage example::
27+
28+
# Create output files with delayed data saving.
29+
delayeds = [
30+
iris.save(cubes, filepath, compute=False)
31+
for cubes, filepath in zip(output_cubesets, output_filepaths)
32+
]
33+
# Complete saves in parallel.
34+
dask.compute(*delayeds)
35+
36+
This advance also includes **another substantial benefit**, because netcdf saves can
37+
now use a
38+
`Dask.distributed scheduler <https://docs.dask.org/en/stable/scheduling.html>`_.
39+
With `Distributed <https://distributed.dask.org/en/stable/>`_ you can parallelise the
40+
saves across a whole cluster. Whereas previously, the netcdf saving *only* worked with
41+
a "threaded" scheduler, limiting it to a single CPU.
42+
43+
We're so super keen for the community to leverage the benefit of this new
44+
feature within Iris that we've brought this release forward several months.
45+
As a result, this minor release of Iris is intentionally light in content.
46+
However, there are some other goodies available for you to enjoy, such as:
47+
48+
* Performing lazy arithmetic with an Iris :class:`~iris.cube.Cube` and a
49+
:class:`dask.array.Array`, and
50+
* Various improvements to our documentation resulting from adoption of
51+
`sphinx-design`_ and `sphinx-apidoc`_.
52+
53+
As always, get in touch with us on :issue:`GitHub<new/choose>`, particularly
54+
if you have any feedback with regards to delayed saving, or have any issues
55+
or feature requests for improving Iris. Enjoy!
3356

3457

3558
📢 Announcements

0 commit comments

Comments
 (0)