Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ugrid whatsnew #4236

Merged
merged 7 commits into from
Aug 4, 2021
Merged

Ugrid whatsnew #4236

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
76a3766
add whatsnew for UGRID support
stephenworsley Jul 6, 2021
2fca254
add description of UGRID work
stephenworsley Jul 9, 2021
78e630f
fix links
stephenworsley Jul 29, 2021
8e63734
add highlight
stephenworsley Jul 29, 2021
b3ff978
address review comments
stephenworsley Aug 3, 2021
2af3116
address review comments
stephenworsley Aug 4, 2021
e39de82
address review comments
stephenworsley Aug 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ This document explains the changes made to Iris for this release

The highlights for this minor release of Iris include:

* We've added support for `UGRID`_ meshes which can now be loaded and attached
to a cube.
* We've dropped support for `Python 3.6`_

And finally, get in touch with us on `GitHub`_ if you have any issues or
Expand All @@ -37,6 +39,26 @@ This document explains the changes made to Iris for this release
✨ Features
===========

#. `@bjlittle`_, `@pp-mo`_ and `@trexfeathers`_ added support for unstructured
meshes, as described by `UGRID`_. This involved adding a data model (:pull:`3968`,
:pull:`4014`, :pull:`4027`, :pull:`4036`, :pull:`4053`) and API (:pull:`4063`,
:pull:`4064`), and supporting representation (:pull:`4033`, :pull:`4054`) and
loading (:pull:`4058`) of data on meshes.
Most of this new API can be found in :mod:`iris.experimental.ugrid`. The key
objects introduced are :class:`iris.experimental.ugrid.Mesh`,
:class:`iris.experimental.ugrid.MeshCoord` and
:obj:`iris.experimental.ugrid.PARSE_UGRID_ON_LOAD`.
A :class:`iris.experimental.ugrid.Mesh` contains a full description of a UGRID
type mesh. :class:`~iris.experimental.ugrid.MeshCoord`\ s are coordinates that
reference and represent a :class:`~iris.experimental.ugrid.Mesh` for use
on a :class:`~iris.cube.Cube`. :class:`~iris.cube.Cube`\ s are also given the
property :attr:`~iris.cube.Cube.mesh` which returns a
:class:`~iris.experimental.ugrid.Mesh` if one is attached to the
:class:`~iris.cube.Cube` via a :class:`~iris.experimental.ugrid.MeshCoord`.
Finally, the context manager :obj:`~iris.experimental.ugrid.PARSE_UGRID_ON_LOAD`
provides a way to load UGRID files so that :class:`~iris.cube.Cube`\ s can be
returned with a :class:`~iris.experimental.ugrid.Mesh` attached.

#. `@pelson`_ and `@trexfeathers`_ enhanced :meth:`iris.plot.plot` and
:meth:`iris.quickplot.plot` to automatically place the cube on the x axis if
the primary coordinate being plotted against is a vertical coordinate. E.g.
Expand Down Expand Up @@ -242,3 +264,4 @@ This document explains the changes made to Iris for this release
.. _xxhash: http://cyan4973.github.io/xxHash/
.. _conda-lock: https://github.com/conda-incubator/conda-lock
.. _asv: https://asv.readthedocs.io/en/stable/
.. _UGRID: http://ugrid-conventions.github.io/ugrid-conventions/