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 JSON files.

data_write.py

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}]

-h, --help

show this help message and exit

--enable-raw-acfs

Enable raw acf writing

--enable-bfiq

Enable beamformed iq writing

--enable-antenna-iq

Enable individual antenna iq writing

--enable-raw-rf

Save raw, unfiltered IQ samples. Requires HDF5.

--rawacf-format {hdf5,dmap}

Format to store rawacf files in.

data_write package

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

copyright

2017 SuperDARN Canada

class src.data_write.DataWrite(data_write_options: Options, rawacf_format: str)

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”.

output_data(write_bfiq: bool, write_antenna_iq: bool, write_raw_rf: bool, aveperiod_meta: AveperiodMetadataMessage, data_parsing: Aggregator, write_rawacf: bool = True)

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.

static two_hr_ceiling(dt)

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

src.data_write.dw_parser()

src.data_write.main()