Metadata-Version: 2.0
Name: digital-rf
Version: 2.6.0b3
Summary: Python tools to read/write Digital RF data in HDF5 format
Home-page: https://github.com/MITHaystack/digital_rf
Author: MIT Haystack Observatory
Author-email: openradar-developers@openradar.org
License: BSD-3-Clause
Keywords: hdf5 radio rf
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: C
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Scientific/Engineering
Provides-Extra: sound
Provides-Extra: plot
Provides-Extra: all
Provides-Extra: dataframe
Requires-Dist: h5py
Requires-Dist: numpy
Requires-Dist: packaging
Requires-Dist: python-dateutil
Requires-Dist: pytz
Requires-Dist: six
Requires-Dist: watchdog
Provides-Extra: all
Requires-Dist: matplotlib; extra == 'all'
Requires-Dist: pandas; extra == 'all'
Requires-Dist: sounddevice; extra == 'all'
Requires-Dist: scipy; extra == 'all'
Provides-Extra: dataframe
Requires-Dist: pandas; extra == 'dataframe'
Provides-Extra: plot
Requires-Dist: matplotlib; extra == 'plot'
Requires-Dist: scipy; extra == 'plot'
Provides-Extra: sound
Requires-Dist: sounddevice; extra == 'sound'

The Digital RF project encompasses a standardized HDF5 format for reading and writing of radio frequency data and the software for doing so. The format is designed to be self-documenting for data archive and to allow rapid random access for data processing.

This package includes:

* ``digital_rf`` Python package
* Tools for managing and processing Digital RF data
* ``gr_digital_rf`` Python package for interfacing with GNU Radio
* GNU Radio Companion blocks
* `thor` UHD radio recorder script
* Example scripts and applications

Digital RF C and MATLAB libraries can be found at the `official source code repository <https://github.com/MITHaystack/digital_rf>`_. To build from source, you must have the HDF5 library and headers installed.

For help and/or questions, contact the `user mailing list <openradar-users@openradar.org>`_.


Example Usage
=============

The following code will load and read data located in a directory '/data/test'.

Load the module and create a reader object::

    import digital_rf as drf
    do = drf.DigitalRFReader('/data/test')

List channels::

    do.get_channels()

Get data bounds for channel 'cha'::

    s, e = do.get_bounds('cha')

Read first 10 samples from channel 'cha'::

    data = do.read_vector(s, 10, 'cha')


