Data Write

The data_write package contains the utilities to parse messages containing antennas_iq data, bfiq data, rawacf data, etc., and write that data to HDF5 or DMAP files.

For antennas_iq and bfiq files, only HDF5 files are supported. For rawacf files, you can choose to write to either to disk in either the HDF5 or DMAP file formats, configuring this in the radar’s Config File.

Usage

Write processed SuperDARN data to file

usage: data_write.py [-h] [--enable-raw-acfs] [--enable-bfiq]
                     [--enable-antenna-iq] [--enable-raw-rf]
                     [--rawacf-format {hdf5,dmap}]

Named Arguments

--enable-raw-acfs

Enable raw acf writing

Default: False

--enable-bfiq

Enable beamformed iq writing

Default: False

--enable-antenna-iq

Enable individual antenna iq writing

Default: False

--enable-raw-rf

Save raw, unfiltered IQ samples. Requires HDF5.

Default: False

--rawacf-format

Possible choices: hdf5, dmap

Format to store rawacf files in.

data_write package

This package contains utilities to parse packets containing antennas_iq data, bfiq data, rawacf data, etc. and write that data to HDF5 or DMAP files.

class src.data_write.DataWrite[source]

Bases: object

This class contains the functions used to write out processed data to files.

Parameters:

  • data_write_options (Options) – The options parsed from config file

  • rawacf_format (str) – The format for rawacf files. Either “hdf5” or “dmap”.

static two_hr_ceiling(dt)[source]

Finds the next 2hr boundary starting from midnight

Parameters:

dt (DateTime) – A datetime to find the next 2hr boundary.

Returns:

2hr aligned datetime

Return type:

DateTime

__init__(data_write_options, rawacf_format)[source]
Parameters:

  • data_write_options (Options)

  • rawacf_format (str)

output_data(
write_bfiq,
write_antenna_iq,
write_raw_rf,
aveperiod_meta,
data_parsing,
write_rawacf=True,
)[source]

Parse through samples and write to file.

A file will be created using the file extension for each requested data product.

Parameters:

  • write_bfiq (bool) – Should beamformed IQ be written to file?

  • write_antenna_iq (bool) – Should pre-beamformed IQ be written to file?

  • write_raw_rf (bool) – Should raw rf samples be written to file?

  • aveperiod_meta (AveperiodMetadataMessage) – Metadata from radar control about averaging period

  • data_parsing (Aggregator) – All parsed and concatenated data from averaging period

  • write_rawacf (bool, optional) – Should rawacfs be written to file? Defaults to True.

src.data_write.main()[source]