.. _read_icon:


read
===============================================

.. container::
    
    .. container:: leftside

        .. image:: /_static/READ.png
           :width: 48px

    .. container:: rightside

		Filters a :class:`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::
		    
		    :func:`read` is almost identical to :func:`retrieve` but it works with local GRIB data. 
		    


		.. note:: This function performs the same task as the **Grib Filter** icon in Metview’s :ref:`user interface <user_interface>`. It accepts its parameters as keyword arguments, described below.


.. py:function:: read(**kwargs)
  
    Filters a :class:`Fieldset` (GRIB data).


    :param source: Specifies the GRIB file path. Cannot be set when ``data`` is used.
    :type source: str

    :param logstats: 
    :type logstats: str

    :param data: Specifies the GRIB data as a :class:`Fieldset`. Cannot be set when ``source`` is used.
    :type data: :class:`Fieldset`

    :param cfspath: 
    :type cfspath: str, default: "off"

    :param order: 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 :class:`Fieldset` which is the result of a single MARS retrieval.
    :type order: {"as_is", "sorted"}, default: "as_is"

    :param class: 
    :type class: str, default: "any"

    :param stream: 
    :type stream: str, default: "any"

    :param type: 
    :type type: str, default: "any"

    :param model: 
    :type model: str, default: "any"

    :param levtype: 
    :type levtype: {"any", "pv", "pt", "sfc", "pl", "ml", "dp", "wv", "layer", "cat", "o2d", "o3d", "sol", "off", "all"}, default: "any"

    :param levelist: 
    :type levelist: str or list[str], default: "any"

    :param param: 
    :type param: str or list[str], default: "any"

    :param date: 
    :type date: str or list[str], default: "any"

    :param verify: 
    :type verify: str or list[str], default: "off"

    :param refdate: 
    :type refdate: str or list[str], default: "off"

    :param hdate: 
    :type hdate: str or list[str], default: "off"

    :param fcmonth: 
    :type fcmonth: str or list[str], default: "off"

    :param fcperiod: 
    :type fcperiod: str or list[str], default: "off"

    :param time: 
    :type time: str or list[str], default: "any"

    :param leadtime: 
    :type leadtime: str or list[str], default: "any"

    :param opttime: 
    :type opttime: str or list[str], default: "any"

    :param reference: 
    :type reference: str or list[str], default: "any"

    :param step: 
    :type step: str or list[str], default: "any"

    :param anoffset: 
    :type anoffset: str or list[str], default: "any"

    :param range: 
    :type range: str, default: "any"

    :param accuracy: 
    :type accuracy: str, default: "n"

    :param style: 
    :type style: {"dissemination", "off", "any"}, default: "any"

    :param interpolation: 
    :type interpolation: str, default: "any"

    :param area: 
    :type area: str or list[str], default: "any"

    :param frame: 
    :type frame: str, default: "off"

    :param bitmap: 
    :type bitmap: str, default: "off"

    :param resol: 
    :type resol: str, default: "auto"

    :param rotation: 
    :type rotation: str or list[str], default: "any"

    :param grid: 
    :type grid: str or list[str], default: "any"

    :param gaussian: 
    :type gaussian: {"reduced", "regular", "off"}, default: "off"

    :param specification: 
    :type specification: str, default: "off"

    :param packing: 
    :type packing: {"simple", "complex", "second order", "archived value", "off"}, default: "off"

    :param ensemble: 
    :type ensemble: str or list[str], default: "off"

    :param cluster: 
    :type cluster: str or list[str], default: "off"

    :param probability: 
    :type probability: str or list[str], default: "off"

    :param number: 
    :type number: str or list[str], default: "any"

    :param quantile: 
    :type quantile: str or list[str], default: "any"

    :param frequency: 
    :type frequency: str or list[str], default: "any"

    :param direction: 
    :type direction: str or list[str], default: "any"

    :param diagnostic: 
    :type diagnostic: str or list[str], default: "any"

    :param iteration: 
    :type iteration: str or list[str], default: "any"

    :param channel: 
    :type channel: str or list[str], default: "any"

    :param ident: 
    :type ident: str or list[str], default: "any"

    :param instrument: 
    :type instrument: str or list[str], default: "any"

    :param filter: 
    :type filter: str, default: "any"

    :param repres: 
    :type repres: {"bu", "sh", "ll", "gg", "sv", "og", "all", "any"}, default: "any"

    :param origin: 
    :type origin: str or list[str], default: "any"

    :param padding: 
    :type padding: str, default: "any"

    :param domain: 
    :type domain: str, default: "any"

    :param system: 
    :type system: str, default: "any"

    :param method: 
    :type method: str or list[str], default: "any"

    :param product: 
    :type product: {"inst", "tims", "tavg", "tacc", "all", "any"}, default: "any"

    :param section: 
    :type section: {"h", "v", "z", "m", "all", "any"}, default: "any"

    :param latitude: 
    :type latitude: str, default: "any"

    :param longitude: 
    :type longitude: str, default: "any"

    :param expver: 
    :type expver: str, default: "any"

    :param lsm: 
    :type lsm: {"on", "off"}, default: "off"

    :param truncation: 
    :type truncation: str, default: "off"

    :param intgrid: 
    :type intgrid: str or list[str], default: "off"

    :rtype: :class:`Fieldset`

.. mv-minigallery:: read