Skip to content

Commit 2822889

Browse files
authored
Document derived-bounds support, including whatsnew. (#6555)
1 parent ecb558a commit 2822889

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

docs/src/whatsnew/latest.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ This document explains the changes made to Iris for this release
4949
#. `@pp-mo`_ made it possible for the reference surfaces of derived coordinates, like orography, to be lazy.
5050
(:pull: 6517).
5151

52+
#. `@HGWright`_ and `@pp-mo`_ enabled correct loading and saving of the bounds of CF
53+
parametric coordinates (that is, Iris derived coordinates). This was previously
54+
incorrect. However the fix is opt-in, controlled by the ``derived_bounds`` flag in
55+
the :data:`iris.FUTURE` object, to avoid breaking existing code.
56+
(:issue:`3678`, :pull:`6481`, :pull:`6540`)
57+
5258

5359
🐛 Bugs Fixed
5460
=============

lib/iris/__init__.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,12 @@ def __init__(
217217
may need to defend against floating point precision issues where
218218
you didn't need to before.
219219
derived_bounds : bool, default=False
220-
When True, uses the new form for deriving bounds with the load.
220+
When ``True``, uses the correct CF rules for bounds of derived coordinates
221+
for both loading and saving NetCDF. This requires that these must be linked
222+
via a separate "formula_terms" attribute on the bounds variable.
223+
If ``False``, bounds are only linked with a "bounds" attribute, though this
224+
is strictly incorrect for CF >= v1.7.
225+
See `here in CF <https://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#cell-boundaries>`_.
221226
lam_pole_offset : bool, default=False
222227
When True, saving a cube on a "Limited Area Model" (LAM) domain
223228
to a PP file will set the pole longitude (PP field ``bplon``) to

0 commit comments

Comments
 (0)