read

../../_images/READ.png

Filters a Fieldset (GRIB data) by selecting a set of messages according to the filter conditions. It also has post-processing options such as grid and area, for regridding and sub-area extraction respectively; these use the same interpolation routines as the standard ECMWF MARS client.

Note

read() is almost identical to retrieve() but it works with local GRIB data.

Note

This function performs the same task as the Grib Filter icon in Metview’s user interface. It accepts its parameters as keyword arguments, described below.

read(**kwargs)

Filters a Fieldset (GRIB data).

Parameters

  • source (str) – Specifies the GRIB file path. Cannot be set when data is used.

  • logstats (str) –

  • data (Fieldset) – Specifies the GRIB data as a Fieldset. Cannot be set when source is used.

  • cfspath (str, default: "off") –

  • order ({"as_is", "sorted"}, default: "as_is") – Specifies whether you want to sort the files you have filtered (“sorted”) or to obtain them in the order they are on the original file (“as_is”). The sorting is the same as that carried out by MARS on retrieving data (date, time, forecast step, level, parameter), hence this has no effect if you are filtering a Fieldset which is the result of a single MARS retrieval.

  • class (str, default: "any") –

  • stream (str, default: "any") –

  • type (str, default: "any") –

  • model (str, default: "any") –

  • levtype ({"any", "pv", "pt", "sfc", "pl", "ml", "dp", "wv", "layer", "cat", "o2d", "o3d", "sol", "off", "all"}, default: "any") –

  • levelist (str or list[str], default: "any") –

  • param (str or list[str], default: "any") –

  • date (str or list[str], default: "any") –

  • verify (str or list[str], default: "off") –

  • refdate (str or list[str], default: "off") –

  • hdate (str or list[str], default: "off") –

  • fcmonth (str or list[str], default: "off") –

  • fcperiod (str or list[str], default: "off") –

  • time (str or list[str], default: "any") –

  • leadtime (str or list[str], default: "any") –

  • opttime (str or list[str], default: "any") –

  • reference (str or list[str], default: "any") –

  • step (str or list[str], default: "any") –

  • anoffset (str or list[str], default: "any") –

  • range (str, default: "any") –

  • accuracy (str, default: "n") –

  • style ({"dissemination", "off", "any"}, default: "any") –

  • interpolation (str, default: "any") –

  • area (str or list[str], default: "any") –

  • frame (str, default: "off") –

  • bitmap (str, default: "off") –

  • resol (str, default: "auto") –

  • rotation (str or list[str], default: "any") –

  • grid (str or list[str], default: "any") –

  • gaussian ({"reduced", "regular", "off"}, default: "off") –

  • specification (str, default: "off") –

  • packing ({"simple", "complex", "second order", "archived value", "off"}, default: "off") –

  • ensemble (str or list[str], default: "off") –

  • cluster (str or list[str], default: "off") –

  • probability (str or list[str], default: "off") –

  • number (str or list[str], default: "any") –

  • quantile (str or list[str], default: "any") –

  • frequency (str or list[str], default: "any") –

  • direction (str or list[str], default: "any") –

  • diagnostic (str or list[str], default: "any") –

  • iteration (str or list[str], default: "any") –

  • channel (str or list[str], default: "any") –

  • ident (str or list[str], default: "any") –

  • instrument (str or list[str], default: "any") –

  • filter (str, default: "any") –

  • repres ({"bu", "sh", "ll", "gg", "sv", "og", "all", "any"}, default: "any") –

  • origin (str or list[str], default: "any") –

  • padding (str, default: "any") –

  • domain (str, default: "any") –

  • system (str, default: "any") –

  • method (str or list[str], default: "any") –

  • product ({"inst", "tims", "tavg", "tacc", "all", "any"}, default: "any") –

  • section ({"h", "v", "z", "m", "all", "any"}, default: "any") –

  • latitude (str, default: "any") –

  • longitude (str, default: "any") –

  • expver (str, default: "any") –

  • lsm ({"on", "off"}, default: "off") –

  • truncation (str, default: "off") –

  • intgrid (str or list[str], default: "off") –

Return type

Fieldset