Data access function ====================== .. _toc_data_retrieve: Data retrieval ---------------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`ecfs` - Retrieve data from ECFS * - :func:`flexpart_prepare` - Retrieve and prepares data for a FLEXPART simulation * - :func:`flextra_prepare` - Retrieve and prepares data for a FLEXTRA simulation * - :func:`met3d_prepare` - Retrieve and prepare GRIB data for Met3D * - :func:`retrieve` - Retrieve data from MARS * - :func:`stvl` - Retrieve point data from the STVL database (ECMWF only) * - :func:`vapor_prepare` - Prepares and visualises GRIB data in Vapor * - :func:`wmsclient` - Web Map Service (WMS) client .. _toc_data_conversion: Data conversion ----------------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`geo_to_grib` - Convert :class:`Geopoints` data to GRIB * - :func:`geo_to_kml` - Convert :class:`Geopoints` data to KML * - :func:`grib_to_geo` - Convert GRIB data into :class:`Geopoints` .. _toc_data_filter: Filtering ----------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`bufr_picker` - Filter :class:`Bufr` data with complex structure * - :func:`cleanfile` - Remove unwanted header padding from GRIB and :class:`Bufr` files * - :func:`obsfilter` - Filter :class:`Bufr` data * - :func:`odb_filter` - Filter :class:`Odb` data * - :func:`read` - Filter and interpolates :class:`Fieldset` data * - :func:`select` - Filter :class:`Fieldset` data by ecCodes keys with metadata indexing .. _toc_data_grib_access: Grib data ----------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`base_date` - Return the base date(s) of a given :class:`Fieldset` * - :func:`datainfo` - Return information on missing values in a :class:`Fieldset` * - :func:`describe` - Print summary of the contents of a :class:`Fieldset` * - :func:`duplicate` - Duplicate a field N times * - :func:`fill_missing_values_ew` - Fills missing values along the horizontal line * - :func:`find` - Find locations of values in a :class:`Fieldset` * - :func:`float` - Convert int GRIB to float GRIB * - :func:`gfind` - Find values in field and returns the result as :class:`Geopoints` * - :func:`grib_get` - Read GRIB headers using ecCodes keys * - :func:`grib_get_double` - Read GRIB headers using ecCodes keys * - :func:`grib_get_double_array` - Read GRIB headers using ecCodes keys * - :func:`grib_get_long` - Read GRIB headers using ecCodes keys * - :func:`grib_get_long_array` - Read GRIB headers using ecCodes keys * - :func:`grib_get_string` - Read GRIB headers using ecCodes keys * - :func:`grib_indexes` - Return list of indexes into the fields of the Fieldset * - :func:`grib_set` - Writes GRIB headers using ecCodes keys * - :func:`grib_set_double` - Writes GRIB headers using ecCodes keys * - :func:`grib_set_long` - Writes GRIB headers using ecCodes keys * - :func:`grib_set_long_array` - Writes GRIB headers using ecCodes keys * - :func:`grib_set_string` - Writes GRIB headers using ecCodes keys * - :func:`gribsetbits` - Set GRIB packing bit width * - :func:`indexes` - Build a :class:`Fieldset` containing each gridpoint's indexed position in the given vector * - :func:`int` - Integer part * - :func:`integer` - Convert float GRIB to int GRIB * - :func:`lookup` - Build an output :class:`Fieldset` using the values in the first as indices into the second * - :func:`ls` - Dumps metadata for each message in a :class:`Fieldset` * - :func:`sort` - Sort a :class:`Fieldset` * - :func:`valid_date` - Return the valid date(s) of a given :class:`Fieldset` * - :func:`values` - Return the values from a data object .. _toc_data_geopoints_access: Geopoints data ---------------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`columns` - Return column names from a :class:`Geopoints` or :class:`Odb` * - :func:`create_geo` - Create a new set of :class:`Geopoints` * - :func:`create_geo_set` - Create a new :class:`Geopoints` set * - :func:`db_info` - Return the database description from a :class:`Geopoints` * - :func:`levels` - Return the levels from a :class:`Geopoints` * - :func:`metadata` - Return metadata from a :class:`Geopoints` * - :func:`polar_vector` - Combine two 1-parameter :class:`Geopoints` variables into polar vector style * - :func:`remove_duplicates` - Remove duplicates from a :class:`Geopoints` * - :func:`remove_missing_latlons` - Removing missing lat/lons form a :class:`Geopoints` * - :func:`remove_missing_values` - Remove missing values from a :class:`Geopoints` * - :func:`set_dates` - Set the date column in the :class:`Geopoints` variable. * - :func:`set_latitudes` - Set the latitudes in a :class:`Fieldset` or :class:`Geopoints` * - :func:`set_levels` - Set the level column in a :class:`Geopoints` * - :func:`set_longitudes` - Set the longitudes in a :class:`Fieldset` or :class:`Geopoints` * - :func:`set_metadata` - Set a :class:`Geopoints` metadata from a definition * - :func:`set_stnids` - Set the stnid column in a :class:`Geopoints` * - :func:`set_times` - Set the time column in a :class:`Geopoints` * - :func:`set_value2s` - Set the value2 column in a :class:`Geopoints` * - :func:`set_values` - Set the values in a :class:`Fieldset` or :class:`Geopoints` * - :func:`stnids` - Return thes tation ids from a :class:`Geopoints` * - :func:`subsample` - Filter the points of the first :class:`Geopoints` that exist in the second one * - :func:`times` - Return the times from a :class:`Geopoints` * - :func:`value2s` - Return the 2nd values column from a :class:`Geopoints` * - :func:`value_columns` - Return a list of value column names for a :class:`Geopoints` * - :func:`values` - Return the values from a data object * - :func:`xy_vector` - Combine two 1-parameter :class:`Geopoints` variables into u/v vector style .. _toc_data_netcdf_access: NetCDF data ------------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`dimension_names` - Return a list of the :class:`NetCdf`'s dimension names. * - :func:`dimensions` - Return a list of the :class:`NetCdf`'s dimensions. * - :func:`netcdf_auto_rescale_values_to_fit_packed_type` - Set the behaviour of :class:`NetCdf` value handling * - :func:`netcdf_auto_scale_values` - Set the behaviour of :class:`NetCdf` value handling * - :func:`netcdf_auto_translate_times` - Set the behaviour of :class:`NetCdf` value handling * - :func:`netcdf_preserve_missing_values` - Set the behaviour of :class:`NetCdf` value handling * - :func:`value` - Return a value from the current :class:`NetCdf` variable * - :func:`values` - Return the values from a data object * - :func:`variables` - Return the names of the variables in a :class:`NetCdf` .. _toc_data_flex: Flextra and Flexpart ---------------------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`flexpart_build_title` - Generate title for plotting FLEXPART gridded output fields * - :func:`flexpart_convert_trajectory` - Convert raw FLEXPART trajectory output to CSV * - :func:`flexpart_filter` - Extracts fields from FLEXPART output GRIB files * - :func:`flexpart_prepare` - Retrieve and prepares data for a FLEXPART simulation * - :func:`flexpart_release` - Define a FLEXPART release * - :func:`flexpart_run` - Perform a FLEXPART simulation * - :func:`flexpart_total_column` - Compute the sum/vertical integral of fields in a FLEXPART output GRIB file. * - :func:`flextra_group_get` - Return data for a FLEXTRA result group * - :func:`flextra_run` - Perform a FLEXTRA simulation * - :func:`flextra_tr_get` - Return data for an individual FLEXTRA trajectory * - :func:`flextra_visualiser` - Define visualisation for FLEXTRA results .. _toc_data_table: Table data ------------ .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`metadata_keys` - Return a list of available meta data keys for the given table * - :func:`metadata_value` - Return the value of then given meta data key for a table * - :func:`name` - Return the name of the given table column. * - :func:`read_table` - Read a table file with parameters for parsing it. * - :func:`values` - Return the values from a data object .. _toc_data_scm: Single Column Model --------------------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`scm_run` - Run the Single Column Model * - :func:`scm_visualiser` - Define visualisation for SCM output .. _toc_data_rttov: RTTOV ------- .. list-table:: :widths: 20 80 :header-rows: 0 * - :func:`rttov_run` - Run the RTTOV model * - :func:`rttov_visualiser` - Define visualisation for RTTOV model output