📚 Documentation

Iris v3.2 will be the first release that includes UGRID support (iris.experimental.ugrid). This is a large topic, with several new concepts, so needs introducing to the user.

What's New

The What's New page already includes several mentions of the continuing UGRID development. Once all features are complete this should be revised as necessary, particularly the Release Highlights section.

Further Topics

Need a few pages to explain the new concepts. In Further Topics since it's inappropriate for the User Guide until out of experimental.

Format

• Kept brief
  • Want to minimise the changes needed as we continue to evolve the codebase
  • Aim for 5 pages (challenge!)
  • Accept that some stuff won't make the cut!
• Try using more worked examples in place of prose

Include

• Explanation of the experimental status
• What it doesn't do yet
• A UGRID/Iris-UGRID data model explanation including diagram (and printed cubes?)
• Relationship with iris-esmf-regrid and GeoVista, which provide some of the required functionality
• Operations (using worked examples):
  • Load/save
  • Plotting - i.e. use GeoVista
  • Regional extraction
    (and lack of indexing)
  • Regridding - i.e. use iris-esmf-regrid
  • Equality?
  • Recombination
• What's coming next

The Plan

Writing: @trexfeathers
Reviewing: @pp-mo
Fresh perspective: @wjbenfold fancy this?