pyart.io.read_nexrad_archive

pyart.io.read_nexrad_archive(filename, field_names=None, additional_metadata=None, file_field_names=False, exclude_fields=None, bzip=None)[source]

Read a NEXRAD Level 2 Archive file.

Parameters :

filename : str

Filename of NEXRAD Level 2 Archive file. The files hosted by at the NOAA National Climate Data Center [R19] as well as on the UCAR THREDDS Data Server [R20] have been tested. Other NEXRAD Level 2 Archive files may or may not work. Message type 1 file at not yet supported, only message type 31.

field_names : dict, optional

Dictionary mapping NEXRAD moments to radar field names. If a data type found in the file does not appear in this dictionary or has a value of None it will not be placed in the radar.fields dictionary. A value of None, the default, will use the mapping defined in the metadata configuration file.

additional_metadata : dict of dicts, optional

Dictionary of dictionaries to retrieve metadata from during this read. This metadata is not used during any successive file reads unless explicitly included. A value of None, the default, will not introduct any addition metadata and the file specific or default metadata as specified by the metadata configuration file will be used.

file_field_names : bool, optional

True to use the NEXRAD field names for the field names. If this case the field_names parameter is ignored. The field dictionary will likely only have a ‘data’ key, unless the fields are defined in additional_metadata.

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.

bzip : bool or None

True if the file is compressed as a bzip2 file, False otherwise. None will examine the filename for a bzip extension.

Returns :

radar : Radar

Radar object containing all moments and sweeps/cuts in the volume. Gates not collected are masked in the field data.

References

[R19](1, 2) http://www.ncdc.noaa.gov/
[R20](1, 2) http://thredds.ucar.edu/thredds/catalog.html

Previous topic

pyart.io.read_cfradial

Next topic

pyart.io.read_nexrad_cdm

This Page