-
Notifications
You must be signed in to change notification settings - Fork 300
Added a glossary for Iris docs. #4902
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.
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
Merged
Merged
Changes from 6 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
cd896d5
Draft: First draft of iris glossary; pretty much everything is subjec…
ESadek-MO f6f580a
Pulled main from upstream into forked repo.
ESadek-MO a6e1c7e
Merge remote-tracking branch 'upstream/main' into iris-glossary
ESadek-MO 85d9531
Minor changes on glossary, added package definitions and consistent f…
ESadek-MO c9eec41
Merge branch 'main' of github.com:SciTools/iris into iris-glossary
ESadek-MO f58fd78
Updated glossary to utilise glossary directive, fiddled with formatti…
ESadek-MO d358f00
Merge branch 'main' of github.com:SciTools/iris into iris-glossary
ESadek-MO 9633051
Updated formatting, added table of contents, file-format and xarray d…
ESadek-MO 4ac0efa
Added coordinate factory text example.
ESadek-MO 6648740
Removed glossary, changed to alphabetical references
ESadek-MO 4c98e0b
Removed Alphabetical TOC, user now relies on Ctrl F.
ESadek-MO bc46b99
Merge branch 'main' of github.com:SciTools/iris into iris-glossary
ESadek-MO 27c3ab7
Updated some definitions as suggested by @pp-mo, and added a what's n…
ESadek-MO 1be80e8
Changed plural/non of Method and Factory headings. Have made a load o…
ESadek-MO 7987394
Fixed typo and ensured title heading consistency. Slight uncertainty …
ESadek-MO 02c26d1
Added link to whatsnew
ESadek-MO ea47766
Reviewed changes from offline discussion with @pp-mo
ESadek-MO File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| .. _glossary: | ||
|
|
||
| Glossary | ||
| ============= | ||
|
|
||
| .. glossary:: | ||
|
|
||
| Cartopy | ||
| A python package for producing maps, and other geospatial data. | ||
| Allows plotting on these maps, over a range of projections. | ||
|
|
||
| | **Related:** :term:`MatPlotLib` | ||
| | **More information:** `CartoPy Site <https://scitools.org.uk/cartopy/docs/latest/>`_ | ||
| | | ||
|
|
||
| Coordinates | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| A container for data points, comes in three main flavours. | ||
|
|
||
| - Dimensional Coordinates - | ||
| A coordinate that represents a singular data dimension. | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| These are organised in ascending order of dimension. Can only | ||
| contain numerical data. | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Auxiliary Coordinates - | ||
| A coordinate that can map to multiple data dimensions. Can | ||
| contain any type of data. | ||
| - Scalar Coordinates - | ||
| A coordinate that is not mapped to any data dimension, instead | ||
| representing the cube as a whole. | ||
|
|
||
| | **Related:** :term:`Cubes` | ||
| | **More information:** :doc:`iris_cubes` | ||
| | | ||
|
|
||
| Cubes | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Cubes are the main method of storing data in Iris. A cube consists of: | ||
trexfeathers marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - :term:`Coordinates` | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Array of :term:`Phenomenon` Data | ||
| - :term:`Standard Name` | ||
| - :term:`Long Name` | ||
| - :term:`Units` | ||
| - List of :term:`Cell Method` | ||
| - List of :term:`Coordinate Factory` | ||
trexfeathers marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | **Related:** :term:`NumPy` | ||
| | **More information:** :doc:`iris_cubes` | ||
| | | ||
|
|
||
| Cell Method | ||
| A cell method represent past operations on a cube's data, such as a | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| MEAN or SUM operation | ||
|
|
||
| | **Related:** :term:`Cubes` | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | **More information:** :doc:`iris_cubes` | ||
| | | ||
|
|
||
| Coordinate Factory | ||
| A coordinate factory derives coordinates from the values of existing | ||
| coordinates. | ||
trexfeathers marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | **Related:** :term:`Cubes` | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | **More information:** :doc:`iris_cubes` | ||
| | | ||
|
|
||
| Dask | ||
| A collection of NumPy-esque arrays, stored in hard disk. When needed, | ||
| the data is temporarily loaded into RAM, and operated on, in batches. | ||
|
|
||
| | **Related:** :term:`Lazy Data` **//** :term:`NumPy` | ||
| | **More information:** :doc:`real_and_lazy_data` | ||
| | | ||
|
|
||
| Lazy Data | ||
| Data stored in hard drive, and then temporarily loaded into RAM in | ||
| batches when needed. Allows of less memory usage and faster performance, | ||
| thanks to parallel processing. | ||
|
|
||
| | **Related:** :term:`Dask` // :term:`Real Data` | ||
| | **More information:** :doc:`real_and_lazy_data` | ||
| | | ||
|
|
||
| Long Name | ||
| A name describing a :term:`phenomenon`, not limited to the | ||
| the same restraints as :term:`standard name`. | ||
|
|
||
| | **Related:** :term:`Standard Name` **||** :term:`Cubes` | ||
| | **More information:** :doc:`iris_cubes` | ||
| | | ||
|
|
||
| MatPlotLib | ||
trexfeathers marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| A python package for plotting and projecting data in a wide variety | ||
| of formats. | ||
|
|
||
| | **Related:** :term:`CartoPy` || :term:`NumPy` | ||
| | **More information:** `MatPlotLib <https://scitools.org.uk/cartopy/docs/latest/>`_ | ||
| | | ||
|
|
||
| Meta Data | ||
trexfeathers marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| The data which is used to describe phenomenon data e.g. longitude. | ||
|
|
||
| | **Related:** :term:`Phenomenon` **//** :term:`Cubes` | ||
| | **More information:** :doc:`../further_topics/metadata` | ||
| | | ||
|
|
||
| NumPy | ||
| A mathematical Python library, predominantly based around | ||
| multi-dimensional arrays. | ||
|
|
||
| | **Related:** :term:`Dask` **//** :term:`Cubes` | ||
| | **More information:** `NumPy.org <https://numpy.org/>`_ | ||
| | | ||
|
|
||
| Phenomenon | ||
| The primary data which is measured, usually within a cube, e.g. | ||
| air temperature. | ||
pp-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| | **Related:** :term:`Meta Data` **//** :term:`Cubes` | ||
| | **More information:** :doc:`iris_cubes` | ||
| | | ||
|
|
||
| Real Data | ||
| Data that has been loaded into RAM, as opposed to sitting | ||
| on the hard drive. | ||
|
|
||
| | **Related:** :term:`Lazy Data` | ||
| | **More information:** :doc:`real_and_lazy_data` | ||
| | | ||
|
|
||
| Standard Name | ||
| A name describing a :term:`phenomenon`, keeping within | ||
| bounds of `CF Standardisation <http://cfconventions.org/standard-names.html>`_. | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | **Related:** :term:`Long Name` **//** :term:`Cubes` | ||
| | **More information:** :doc:`iris_cubes` | ||
| | | ||
|
|
||
| Units | ||
| The unit with which the phenomenon is measured. | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | **Related:** :term:`Cubes` | ||
pp-mo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | **More information:** :doc:`iris_cubes` | ||
| | | ||
|
|
||
| ---- | ||
|
|
||
|
|
||
| `To top <glossary_>`_ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.