pyart.aux_io

Description

Auxiliary input and output (pyart.aux_io)

Additional classes and functions for reading and writing data from a number of file formats.

These auxiliary input/output routines are not as well polished as those in pyart.io. They may require addition dependencies beyond those required for a standard Py-ART install, use non-standard function parameter and naming, are not supported by the pyart.io.read() function and are not fully tested if tested at all. Please use these at your own risk.

Bugs in these function should be reported but fixing them may not be a priority.

Reading radar data

read_d3r_gcpex_nc(filename[, field_names, ...])	Read a D3R GCPEX netCDF file.
read_gamic(filename[, field_names, ...])	Read a GAMIC hdf5 file.
read_kazr(filename[, field_names, ...])	Read K-band ARM Zenith Radar (KAZR) NetCDF ingest data.
read_noxp_iphex_nc(filename[, field_names, ...])	Read a NOXP IPHEX netCDF file.
read_odim_h5(filename[, field_names, ...])	Read a ODIM_H5 file.
read_odim_grid_h5(filename[, field_names, ...])	Read a ODIM_H5 grid file.
read_odim_vp_h5(filename[, field_names, ...])	Read a vertical profile ODIM_H5 file like those used by vol2bird
read_pattern(filename, **kwargs)	Read a netCDF file from a PATTERN project X-band radar.
read_radx(filename[, radx_dir])	Read a file by first converting it to Cf/Radial using RadxConvert.
read_rainbow_wrl(filename[, field_names, ...])	Read a RAINBOW file.
read_metranet(filename[, field_names, rmax, ...])	Read a METRANET file.
read_cartesian_metranet(filename[, ...])	Read a METRANET product file.
read_gif(filename[, additional_metadata, ...])	Read a MeteoSwiss operational radar data gif file.
read_bin(filename[, additional_metadata, ...])	Read a MeteoSwiss operational radar data binary file.
read_iq(filename, filenames_iq[, ...])	Read a rad4alp IQ file.
read_bin_mf(filename[, additional_metadata, ...])	Read a MeteoFrance operational radar data binary file.
read_png(filename[, additional_metadata, ...])	Read a MeteoFrance data png file.
read_dat_mf(filename[, additional_metadata, ...])	Read a MeteoFrance operational radar data binary file.
read_grib(filename[, additional_metadata, ...])	Read a MeteoFrance data GRIB file.
read_rainbow_psr(filename, filenames_psr[, ...])	Read a PSR file.
read_rainbow_psr_spectra(filename, filenames_psr)	Read a PSR file to get the complex spectra
read_spectra(filename[, field_names, ...])	Read a spectra netCDF file.
read_cf1(filename[, field_names, ...])	Read a CF-1 netCDF file.
read_cf1_cartesian(filename[, field_names, ...])	Read a CF-1 netCDF file.
read_cf1_cartesian_mf(filename[, ...])	Read a CF-1 netCDF file.
read_hpl(filename[, additional_metadata, ...])	Read a hpl ASCII file from the Halo Photonoics Steamline lidar.
read_swissbirdradar_spectra(filename[, ...])	Read a spectrum file from SwissBirdRadar.
read_skyecho(filename[, sweep_end_time, ...])	Read a SkyEcho netCDF file.
extract_sweeps_skyecho(filename[, basepath, ...])	Read a SkyEcho netCDF file and create new CF/Radial files with single sweeps

Writing radar data

write_odim_h5(filename, radar[, ...])	Write a Radar object to a EUMETNET OPERA compliant HDF5 file.
write_odim_grid_h5(filename, grid[, ...])	Write a Grid object to a EUMETNET OPERA compliant HDF5 file.
write_spectra(filename, radar[, format, ...])	Write a Radar Spectra object to a netCDF file.
write_sinarame_cfradial(path)	This function takes SINARAME_H5 files (where every file has only one field and one volume) from a folder and writes a CfRadial file for each volume including all fields.

Special use

get_sweep_time_coverage(filename)

Get the start time and end time for each sweep.

Functions

convert_data(values)	Converts an string of values into the corresponding format
extract_sweeps_skyecho(filename[, basepath, ...])	Read a SkyEcho netCDF file and create new CF/Radial files with single sweeps
get_library([verbose, momentpm, momentms])	return the link to C-shared library
get_sweep_time_coverage(filename)	Get the start time and end time for each sweep.
read_bin(filename[, additional_metadata, ...])	Read a MeteoSwiss operational radar data binary file.
read_bin_mf(filename[, additional_metadata, ...])	Read a MeteoFrance operational radar data binary file.
read_cartesian_metranet(filename[, ...])	Read a METRANET product file.
read_cf1(filename[, field_names, ...])	Read a CF-1 netCDF file.
read_cf1_cartesian(filename[, field_names, ...])	Read a CF-1 netCDF file.
read_cf1_cartesian_mf(filename[, ...])	Read a CF-1 netCDF file.
read_d3r_gcpex_nc(filename[, field_names, ...])	Read a D3R GCPEX netCDF file.
read_dat_mf(filename[, additional_metadata, ...])	Read a MeteoFrance operational radar data binary file.
read_edge_netcdf(filename, **kwargs)	Read a EDGE NetCDF file.
read_file_c(file[, moment, keep_all_rays, ...])	Reads a METRANET data file
read_file_py(file[, moment, physic_value, ...])	Reads a METRANET data file
read_gamic(filename[, field_names, ...])	Read a GAMIC hdf5 file.
read_gif(filename[, additional_metadata, ...])	Read a MeteoSwiss operational radar data gif file.
read_grib(filename[, additional_metadata, ...])	Read a MeteoFrance data GRIB file.
read_hpl(filename[, additional_metadata, ...])	Read a hpl ASCII file from the Halo Photonoics Steamline lidar.
read_iq(filename, filenames_iq[, ...])	Read a rad4alp IQ file.
read_kazr(filename[, field_names, ...])	Read K-band ARM Zenith Radar (KAZR) NetCDF ingest data.
read_knmi_grid_h5(filename[, field_names, ...])	Read a KNMI_H5 grid file.
read_mch_vad(file_path)
read_metranet(filename[, field_names, rmax, ...])	Read a METRANET file.
read_noxp_iphex_nc(filename[, field_names, ...])	Read a NOXP IPHEX netCDF file.
read_odim_grid_h5(filename[, field_names, ...])	Read a ODIM_H5 grid file.
read_odim_h5(filename[, field_names, ...])	Read a ODIM_H5 file.
read_odim_vp_h5(filename[, field_names, ...])	Read a vertical profile ODIM_H5 file like those used by vol2bird
read_pattern(filename, **kwargs)	Read a netCDF file from a PATTERN project X-band radar.
read_png(filename[, additional_metadata, ...])	Read a MeteoFrance data png file.
read_product_c(file[, physic_value, ...])	Reads a METRANET polar data file
read_product_py(radar_file[, physic_value, ...])	Reads a METRANET cartesian data file
read_psr_cpi_header(filename)	Reads the CPI data headers contained in a PSR file
read_psr_header(filename)	Read a PSR file header.
read_psr_spectra(filename)	Reads the complex spectral data contained in a PSR file
read_radx(filename[, radx_dir])	Read a file by first converting it to Cf/Radial using RadxConvert.
read_rainbow_psr(filename, filenames_psr[, ...])	Read a PSR file.
read_rainbow_psr_spectra(filename, filenames_psr)	Read a PSR file to get the complex spectra
read_rainbow_wrl(filename[, field_names, ...])	Read a RAINBOW file.
read_sinarame_h5(filename[, field_names, ...])	Read a SINARAME_H5 file. :Parameters: * filename (str) -- Name of the SINARAME_H5 file to read. * field_names (dict, optional) -- Dictionary mapping SINARAME_H5 field names 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 Py-ART 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 Py-ART configuration file will be used. * file_field_names (bool, optional) -- True to use the MDV data type 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. 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.
read_skyecho(filename[, sweep_end_time, ...])	Read a SkyEcho netCDF file.
read_spectra(filename[, field_names, ...])	Read a spectra netCDF file.
read_swissbirdradar_spectra(filename[, ...])	Read a spectrum file from SwissBirdRadar.
write_odim_grid_h5(filename, grid[, ...])	Write a Grid object to a EUMETNET OPERA compliant HDF5 file.
write_odim_h5(filename, radar[, ...])	Write a Radar object to a EUMETNET OPERA compliant HDF5 file.
write_sinarame_cfradial(path)	This function takes SINARAME_H5 files (where every file has only one field and one volume) from a folder and writes a CfRadial file for each volume including all fields.
write_spectra(filename, radar[, format, ...])	Write a Radar Spectra object to a netCDF file.