shoot.meta

shoot.meta#

Metadata utilities for finding variables and coordinates using CF conventions

This module provides wrappers around xoa functions to retrieve variables and coordinates from xarray datasets using CF metadata conventions and custom specs.

Functions

get_depth(obj[, errors])

Get depth coordinate from dataset or data array

get_lat(obj[, errors])

Get latitude coordinate from dataset or data array

get_lon(obj[, errors])

Get longitude coordinate from dataset or data array

get_salt(ds[, errors])

Get salinity variable

get_ssh(ds[, variant, errors])

Get sea surface height variable

get_temp(ds[, errors])

Get temperature variable

get_time(obj[, errors])

Get time coordinate from dataset or data array

get_u(ds[, errors])

Get zonal (X) velocity component

get_v(ds[, errors])

Get meridional (Y) velocity component

get_xdim(da[, errors])

Get X dimension name from data array

get_ydim(da[, errors])

Get Y dimension name from data array

get_zdim(da[, errors])

Get Z dimension name from data array

register_meta_specs([cfg_file])

Register custom CF specs with name 'shoot'

set_meta_specs(name)

Set active CF specs by name