iris

iris copied to clipboard

🚀 Iris Glossary

Description

Created a glossary of terms for iris docs, currently located within user guide. Intended to just be a quick lookup, with links to other relevant terms and also the more in depth docs documents.

Most everything at this point is susceptible to change; please feel free to suggest new terms, removal of terms, editing or (hopefully not needed) correcting of definitions, and formatting changes.

Current Build: https://esadek-mo-irisdocs.readthedocs.io/en/latest/userguide/glossary.html

Liking the idea, but there's a lot to do ! I think we need a huddle on this after v3.3 is done.

Also possible content / references : #3883 #4498

Added Table Of Contents; done manually as couldn't seem to find an appropriate automatic version. Its inclusion is up for discussion; might be unnecessary or too lengthy, and might be negated by the use of Ctrl F.

Newer definitions (each file format, xarray and coordinate factory) could perhaps do with some tinkering. Appropriate "more information" links might also need more work, currently some third party sites are used. Perhaps @pp-mo might have some insight?

There is potential to add links to the glossary from the docs, included as the docs are organically updated themselves, but for the time being the existence of the glossary should suffice.

There is also potential of examples being added to definitions, although I fear this might disrupt the brevity. A separate page of examples, linked from the glossary, could be a solution to this, but would require more work and perhaps end up too disjointed.

Removed TOC, replaced with alphabetical links. Perhaps needs better formatting, and a fair amount of letters are currently unused, and as such messy.

Hopefully final edit (excluding reviews); done away with any sort of table of contents, alphabetical or non. It just appeared to be too messy, no nice way of doing it. Older version remain in prior commits, but unless a mass vote to revert I think this is final version for the time being.

Hopefully ready for approval. I did notice the "Unit" definition uses itself within the definition: (a unit is a unit of measurement...). I think that's okay, as I can't think of a definition without overcomplicating matters, but something to keep in mind perhaps.

Over to you, @pp-mo

Many Thanks @ESadek-MO and sorry for repeated change requests !

Possible Additions in future: Interpolation, (Within Cubes) - cell-measures ancillary variables

Other things we might consider in the glossary Mesh Coordinate System