retrieve

../../_images/RETRIEVE.png

Retrieves GRIB (Fieldset), Bufr and Odb data from the ECMWF MARS (Meteorological Archival and Retrieval System) archive. Note that in addition to data retrieval, retrieve() 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.

It is beyond the scope of this documentation to provide explanation to the MARS Retrieval parameters and in general about MARS. Instead, it is strongly recommended to consult the MARS user documentation, especially the MARS keywords documentation to find out details about how to define MARS retrievals.

Note

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

retrieve(**kwargs)

Performs a MARS retrieval.

Parameters

  • dataset (str) –

  • class_ (str, default: "od") –

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

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

  • expver (str or list[str], default: "1") –

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

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

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

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

  • obstype (str or list[str], default: "s") –

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

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

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

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

  • verify (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: "12") –

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

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

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

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

  • anoffset (str or list[str]) –

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

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

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

  • domain ({"g", "g", "m", "n", "s", "b", "e", "a", "b", "c", "d", "w", "f", "t", "u", "x", "all", "v", "h", "i", "j", "k", "l", "o", "p", "q", "r", "y", "z"}, default: "g") –

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

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

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

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

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

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

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

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

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

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

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

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

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

  • source (str, default: "") –

  • target (str, default: "") –

  • logstats (str) –

  • transfer (str) –

  • fieldset (str) –

  • cfspath (str, default: "") –

  • format (str, default: "p") –

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • duplicates ({"keep", "remove"}, default: "keep") –

  • launch (str, default: "") –

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

  • use (str, default: "normal") –

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

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

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

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

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

  • database (str or list[str]) –

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

  • _version (str, default: "2.0") –

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

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

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

  • ppengine ({"emos", "mir", "off"}, default: "off") –

Return type

Fieldset, Bufr or Odb