utils.coords.handshake_dim

Import path: earth2studio.utils.coords.handshake_dim

View source on GitHub

Documentation

Simple check to see if coordinate system has a dimension in a particular index

Parameters:

• input_coords (CoordSystem) –

  Input coordinate system to validate

• required_dim (str) –

  Required dimension (name of coordinate)

• required_index (int, default: None ) –

  Required index of dimension if needed, by default None

Raises:

• KeyError –

  If required dimension is not found in the input coordinate system

• ValueError –

  If the required index is outside the dimensionality of the input coordinate system

• ValueError –

  If dimension is not in the required index

Examples using earth2studio.utils.coords.handshake_dim

Extending Prognostic ModelsImplementing a custom prognostic model