Skip to content
Merged
Show file tree
Hide file tree
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 Aug 11, 2022
f6f580a
Pulled main from upstream into forked repo.
ESadek-MO Aug 11, 2022
a6e1c7e
Merge remote-tracking branch 'upstream/main' into iris-glossary
ESadek-MO Aug 12, 2022
85d9531
Minor changes on glossary, added package definitions and consistent f…
ESadek-MO Aug 12, 2022
c9eec41
Merge branch 'main' of github.com:SciTools/iris into iris-glossary
ESadek-MO Aug 23, 2022
f58fd78
Updated glossary to utilise glossary directive, fiddled with formatti…
ESadek-MO Aug 23, 2022
d358f00
Merge branch 'main' of github.com:SciTools/iris into iris-glossary
ESadek-MO Sep 2, 2022
9633051
Updated formatting, added table of contents, file-format and xarray d…
ESadek-MO Sep 2, 2022
4ac0efa
Added coordinate factory text example.
ESadek-MO Sep 2, 2022
6648740
Removed glossary, changed to alphabetical references
ESadek-MO Sep 5, 2022
4c98e0b
Removed Alphabetical TOC, user now relies on Ctrl F.
ESadek-MO Sep 6, 2022
bc46b99
Merge branch 'main' of github.com:SciTools/iris into iris-glossary
ESadek-MO Sep 27, 2022
27c3ab7
Updated some definitions as suggested by @pp-mo, and added a what's n…
ESadek-MO Sep 28, 2022
1be80e8
Changed plural/non of Method and Factory headings. Have made a load o…
ESadek-MO Sep 28, 2022
7987394
Fixed typo and ensured title heading consistency. Slight uncertainty …
ESadek-MO Sep 28, 2022
02c26d1
Added link to whatsnew
ESadek-MO Sep 28, 2022
ea47766
Reviewed changes from offline discussion with @pp-mo
ESadek-MO Sep 28, 2022
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
148 changes: 148 additions & 0 deletions docs/src/userguide/glossary.rst
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
A container for data points, comes in three main flavours.

- Dimensional Coordinates -
A coordinate that represents a singular data dimension.
These are organised in ascending order of dimension. Can only
contain numerical data.
- 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
Cubes are the main method of storing data in Iris. A cube consists of:

- :term:`Coordinates`
- Array of :term:`Phenomenon` Data
- :term:`Standard Name`
- :term:`Long Name`
- :term:`Units`
- List of :term:`Cell Method`
- List of :term:`Coordinate Factory`

| **Related:** :term:`NumPy`
| **More information:** :doc:`iris_cubes`
|

Cell Method
A cell method represent past operations on a cube's data, such as a
MEAN or SUM operation

| **Related:** :term:`Cubes`
| **More information:** :doc:`iris_cubes`
|

Coordinate Factory
A coordinate factory derives coordinates from the values of existing
coordinates.

| **Related:** :term:`Cubes`
| **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
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
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.

| **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>`_.

| **Related:** :term:`Long Name` **//** :term:`Cubes`
| **More information:** :doc:`iris_cubes`
|

Units
The unit with which the phenomenon is measured.

| **Related:** :term:`Cubes`
| **More information:** :doc:`iris_cubes`
|

----


`To top <glossary_>`_

1 change: 1 addition & 0 deletions docs/src/userguide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ they may serve as a useful reference for future exploration.
cube_maths
citation
code_maintenance
glossary


.. toctree::
Expand Down