earthkit.data.xr_engine.profile¶

Attributes¶

`GEO_KEYS`
`IGNORE_ATTRS`
`MANDATORY_KEYS`
`PROFILE_CONF`

Classes¶

`AuxCoords`	dict() -> new empty dictionary
`KeyVariable`
`MonoVariable`
`Profile`
`ProfileConf`
`ProfileVariable`
`RemappingBuilder`

Module Contents¶

class earthkit.data.xr_engine.profile.AuxCoords(aux_coords)¶

Bases: dict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

earthkit.data.xr_engine.profile.GEO_KEYS = ['md5GridSection']¶

earthkit.data.xr_engine.profile.IGNORE_ATTRS = ['md5GridSection']¶

class earthkit.data.xr_engine.profile.KeyVariable(key, drop, rename_map)¶

Bases: ProfileVariable

check(profile)¶: Check the variable against the profile. This is called after the variable has been updated.

drop¶

property is_mono¶

key¶

rename(v)¶: Rename the variable using the rename map. If the variable is not in the rename map, return the original name.

rename_map¶

update(ds)¶

Parameters:: ds (fieldlist) – FieldList object with cached metadata

variables = []¶

earthkit.data.xr_engine.profile.MANDATORY_KEYS = ['md5GridSection']¶

class earthkit.data.xr_engine.profile.MonoVariable(name=None)¶

Bases: ProfileVariable

check(profile)¶: Check the variable against the profile. This is called after the variable has been updated.

property is_mono¶

key = None¶

name = 'data'¶

rename(v)¶: Rename the variable using the rename map. If the variable is not in the rename map, return the original name.

update(ds)¶

Parameters:: ds (fieldlist) – FieldList object with cached metadata

earthkit.data.xr_engine.profile.PROFILE_CONF¶

class earthkit.data.xr_engine.profile.Profile(name=None, **kwargs)¶

DEFAULT_PROFILE_NAME = 'earthkit'¶

USER_ONLY_OPTIONS = ['remapping', 'patch', 'fill_metadata', 'aux_coords']¶

add_earthkit_attrs¶

add_geo_coords¶

add_keys(keys)¶

add_valid_time_coord¶

allow_holes¶

array_namespace¶

attrs¶

aux_coords¶

copy()¶

decode_timedelta¶

decode_times¶

property dim_keys¶

dims¶

direct_backend¶

dtype¶

errors¶

flatten_values¶

classmethod from_conf(name, conf, *args, **kwargs)¶

index_keys = []¶

lazy_load¶

static make(name_or_def, *args, force=False, **kwargs)¶

name = None¶

prepend_keys(keys)¶

release_source¶

remapping¶

rename_dataset_dims(dataset)¶

rename_dims_map()¶

property sort_keys¶

strict¶

classmethod to_docs(name)¶: Used to generate documentation.

update(ds)¶

Parameters:

ds (fieldlist) – FieldList object with cached metadata
attributes (dict) – Index keys which has a single (valid) value

class earthkit.data.xr_engine.profile.ProfileConf¶

defaults()¶

get(name)¶

class earthkit.data.xr_engine.profile.ProfileVariable¶

abstractmethod check(profile)¶: Check the variable against the profile. This is called after the variable has been updated.

abstract property is_mono¶

key = None¶

abstractmethod update(ds)¶

Parameters:: ds (fieldlist) – FieldList object with cached metadata

class earthkit.data.xr_engine.profile.RemappingBuilder(remappings, patch=None)¶

add(remapping, patch=None)¶

build()¶

patch¶

remappings¶