pyart.aux_io.extract_sweeps_skyecho#

pyart.aux_io.extract_sweeps_skyecho(filename, basepath=None, sweep_dir=None, dir_timeformat='%Y/%m/%d/', file_prefix=None, file_sufix=None, file_timeformat='%Y-%m-%dT%H-%M-%S', sweep_start_time=None, sweep_end_time=None, field_names=None, additional_metadata=None, file_field_names=False, exclude_fields=None, include_fields=None, verbose=False, **kwargs)[source]#

Read a SkyEcho netCDF file and create new CF/Radial files with single sweeps

Parameters:

  • filename (str) – Name of netCDF file to read data from.

  • basepath (str or None) – Base path where to store the extracted sweep files. If None it is stored in the current directory

  • sweep_dir (str or None) – Directory where to store the extracted sweep files. If None it is stored on the base path

  • dir_timeformat (str) – Time format for the directory

  • file_prefix (str or None) – prefix to add to the name of the file containing a single sweep

  • file_sufix (str or None) – sufix to add to the name of the file containing a single sweep

  • file_timeformat (str) – Time format of the file name

  • sweep_start_time, sweep_end_time (datetime object) – The start and the end period where we want to extract sweeps from.

  • field_names (dict, optional) – Dictionary mapping field names in the file names to radar field names. Unlike other read functions, fields not in this dictionary or having a value of None are still included in the radar.fields dictionary, to exclude them use the exclude_fields parameter. Fields which are mapped by this dictionary will be renamed from key to value.

  • additional_metadata (dict of dicts, optional) – This parameter is not used, it is included for uniformity.

  • file_field_names (bool, optional) – True to force the use of the field names from the file in which case the field_names parameter is ignored. False will use to field_names parameter to rename fields.

  • exclude_fields (list or None, optional) – List of fields to exclude from the radar object. This is applied after the file_field_names and field_names parameters. Set to None to include all fields specified by include_fields.

  • include_fields (list or None, optional) – List of fields to include from the radar object. This is applied after the file_field_names and field_names parameters. Set to None to include all fields not specified by exclude_fields.

  • verbose (bool) – Be verbose about processes

Returns:

radar (Radar) – Radar object.

Notes

This function has not been tested on “stream” Cfradial files.