epygram.formats.fafields — Utilities around FA fields

FA fields utilities

epygram.formats.fafields.find_wind_pair(fieldname)[source]

For a wind fieldname, find and return the pair.

class epygram.formats.fafields.FaGribDef(actual_init=True, concepts=['faFieldName', 'faModelName', 'faLevelName'])[source]

Bases: epygram.extra.griberies.GribDef

Handle FA-related GRIB definition files. To add user files: a) use env vars GRIBAPI|ECCODES_DEFINITION_PATH or b) move it under {config.userlocaldir}/{FaGribDef.dirname}

FA2GRIB(*args, **kwargs)

Convert FA field name to GRIB fid, including vertical level identification.

Parameters

  • grib_edition – among (‘grib1’, ‘grib2’), the version of GRIB fid

  • include_comments – if a comment is present if grib def, bring it in fid

  • fatal – if True and fieldname is not retrieved, raise a ValueError; else, return a default 255 fid

  • filter_non_GRIB_keys – filter out the non-GRIB keys that may be present in grib def of field

GRIB2FA(*args, **kwargs)

Look for a unique matching field in tables. ! WARNING ! the unicity might not be ensured depending on the version of grib definitions files.

Parameters

grib_edition – among (‘grib1’, ‘grib2’), the version of GRIB fid

lookup_FA(*args, **kwargs)

Look for all the fields which FA name contain partial_fieldname.

Parameters

  • grib_edition – among (‘grib1’, ‘grib2’), the version of GRIB fid

  • include_comments – if a comment is present if grib def, bring it in fid

  • filter_non_GRIB_keys – filter out the non-GRIB keys that may be present in grib def of field

lookup_GRIB(*args, **kwargs)

Look for all the fields which GRIB fid contain partial_fid.

Parameters

  • grib_edition – among (‘grib1’, ‘grib2’), the version of GRIB fid

  • include_comments – if a comment is present if grib def, bring it in fid

  • filter_non_GRIB_keys – filter out the non-GRIB keys that may be present in grib def of field

class epygram.formats.fafields.SfxFldDesc_Mod(actual_init=True)[source]

Bases: object

Handle fields catalog from sfxflddesc.F90 source file.

dim(*args, **kwargs)

Return number of dimensions of field.

is_metadata(*args, **kwargs)

True if field is not a H2D field but metadata (Misc).

nature(*args, **kwargs)

Return type of data in field.

read(filename)[source]

Parse a sfxflddesc_mod.F90 file.

update(field_dict)[source]

Update with a dict of field {fieldname:{}, …}.