Skip to content

Latest commit

 

History

History
61 lines (48 loc) · 2.15 KB

README.md

File metadata and controls

61 lines (48 loc) · 2.15 KB
Raw

LSL Toolkit for GNURadio/USRP Data

Build and Test codecov

DESCRIPTION

This package provides a reader for USRP data generated through GNURadio.

REQUIREMENTS

  • python >= 2.7
  • numpy >= 1.2
  • h5py

INSTALLING

The USRP package is installed as a regular Python package using distutils.
Unzip and untar the source distribution. Setup the python interpreter you wish to use for running the package applications and switch to the root of the source distribution tree.

Install USRP by running:

pip install [--root=<prefix>|--user] .

If the '--root' option is not provided, then the installation tree root directory is the same as for the python interpreter used to run setup.py. For instance, if the python interpreter is in '/usr/local/bin/python', then will be set to '/usr/local'. Otherwise, the explicit value is taken from the command line option. The package will install files in the following locations:

  • /bin
  • /lib/python2.6/site-packages
  • /share/doc
  • /share/install If an alternate value is provided, you should set the PATH environment to include directory '/bin' and the PYTHONPATH environment to include directory '/bin' and the PYTHONPATH environment to include directory '/lib/python2.6/site-packages'.

If the '--user' option is provided, then then installation tree root directory will be in the current user's home directory.

UNIT TESTS

Unit tests for the package may be found in the 'USRP/tests' sub-directory in the package source distribution tree. To run the complete suite of package unit tests:

cd tests
python -m unittest discover

DOCUMENTATION

See the module's internal documentation.

RELEASE NOTES

See the CHANGELOG for a detailed list of changes and notes.