Model variable names

aeolus provides functionality to store model-specific variable and coordinate names in one container, which can be passed to various functions.

The base class is called Model and is stored in the base submodule

from aeolus.model.base import Model

It can be used to create custom Model classes for different datasets.

Example

For example, for the LMD-G model, one can define the following.

lmdg = Model(
    # Coordinates
    t="Time",
    z="altitude",
    y="latitude",
    x="longitude",
    # Variables
    u="u",
    v="v",
    w="w",
    pres="p",
)

lmdg.x

'longitude'

Unified Model

The standard container for the UK Met Office Unified Model is called um and can be imported from aeolus.model:

from aeolus.model import um

It does not amount to having the whole STASH table at hand, instead it contains names of commonly used variables and coordinates, which are useful in a specific project as shortcuts.

um.u, um.v, um.w

('x_wind', 'y_wind', 'upward_air_velocity')

um.x, um.y, um.z

('longitude', 'latitude', 'level_height')

There is also a duplicate class that has STASH indices for the same variables:

from aeolus.model import um_stash

It does not amount to having the whole STASH table, but it contains names of some commonly used variables and coordinates.

um_stash.u, um_stash.v, um_stash.w

('m01s00i002', 'm01s00i003', 'm01s00i150')

um_stash.x, um_stash.y, um_stash.z

('longitude', 'latitude', 'level_height')