d8709bcc7b
- Includes ni-python-styleguide, and clang-format 14.
- Updates CODING.md to explain this
- Run `pre-commit install` on this repository to activate. You need to
manually install `pre-commit` and `ni-python-styleguide` to make this
work. A pip-based installation would look like this:
$ pip install pre-commit ni-python-styleguide
$ cd /path/to/uhd # Enter the repo
$ pre-commit install
|
||
|---|---|---|
| .ci | ||
| .github | ||
| firmware | ||
| fpga | ||
| host | ||
| images | ||
| mpm | ||
| tools | ||
| .clang-format | ||
| .clang-format-ignore | ||
| .clang-tidy | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .pre-commit-config.yaml | ||
| .readthedocs.yaml | ||
| CHANGELOG | ||
| CODING.md | ||
| CONTRIBUTING.md | ||
| LICENSE.md | ||
| README.md | ||
USRP Hardware Driver (UHD™) Software
Welcome to the UHD™ software distribution! UHD is the free & open-source software driver and API for the Universal Software Radio Peripheral (USRP™) SDR platform, created and sold by Ettus Research.
UHD supports all Ettus Research USRP™ hardware, including all motherboards and daughterboards, and the combinations thereof.
Documentation
For technical documentation related to USRP™ hardware or UHD system design, check out the UHD and USRP Manual. That is where you can find Installation Instructions, help on how to build UHD from source on different platforms, development guidelines and reference documentation as well as device usage guidance.
Additionally, be sure to check out the Ettus Research FAQ, and the Knowledge Base for useful application notes and tutorials.
OS Support
UHD is primarily developed on Linux, but we also test and support the following operating systems.
- Linux (Fedora and Ubuntu)
- Mac OS X (Intel)
- Windows 10
Other operating systems will most likely work, too, but are not officially supported.
Applications
UHD can be used to build stand-alone applications with USRP™ hardware, or with third-party applications. Some common toolkits / frameworks are:
- GNU Radio
- NI LabVIEW
- MathWorks Matlab and Simulink
- REDHAWK
- OpenBTS GSM
- Osmocom GSM
- Amarisoft LTE
- Software Radio Systems srsRAN
- Eurecom OpenAirInterface
Directories
host/
The source code for the user-space driver.
mpm/
The source code for the module peripheral manager (MPM). This is code that is run on embedded devices.
firmware/
The source code for all microprocessors in USRP hardware.
fpga/
The source code for the UHD FPGA images.
images/
This contains the package builder for FPGA and firmware images. We provide other tools to download image packages, the scripts in here are mainly relevant for UHD maintainers and -developers.
tools/
Additional tools, mainly for debugging purposes. See the readme-file in that directory for more details on the individual tools.