pywgrib2_xr.write_msg

pywgrib2_xr.write_msg(gribfile, tmplfile, num_or_meta, data=None, append=False, **kwargs)[source]

Writes message to a GRIB2 file.

Parameters

  • gribfile (str or MemoryBuffer) – Destination GRIB file.

  • tmplfile (str or MemoryBuffer) – Template GRIB file.

  • num_or_meta (int or MetaData) – Message number or Metadata for the message in the template.

  • append (bool) – Append message to gribfile. Default is False.

  • data (array_like or None) – Data to be written. When None, only metadata is updated.

  • **kwargs –

    Optional arguments setting metadata: item=value, which results in arguments set_item, value passed to wgrib2. Valid items are:

    • metadata : metadata string, see https://www.cpc.ncep.noaa.gov/products/wesley/wgrib2/set_metadata.html

    • date : reference time (datetime or ISO format str)

    • ftime : forecast time (wgrib2 format str)

    • var : variable name

    • lev : level

    • grib_type : compression = {‘jpeg’, ‘simple’, ‘complex[1|2|3]’, ‘aec’, ‘same’}

    • bin_prec : precision ECMWF style, in bits <= 24

Raises

pywgrib2_xr.WgribError – When wgrib call fails

Examples

Update forecast time, preserve data values:

write_msg(outfile, tmplfile, meta, ftime=ftime)

Write average RH in a layer using metadata of RH at some level:

write_msg(outfile, tmplfile, meta, data=rh_ave, lev='surface - 700 mb', bin_prec=8)