Software Setup
In most instances, there are two pieces of software that you will be needing: UHD and GNU Radio. Most package managers have a version of libUHD that is compiled by Ettus for their radio products. At Per Vices, we maintain our own fork of libUHD. This allows for easy interfacing with software devices, and provides some compatibility with USRP devices. For more on these differences, check out our application note on use and operations. While you are unlikely to notice these differences when using the software, you will have to take some care to make sure that the correct (Per Vices) version of UHD is what gets installed.
Table 1: Supported Operating Systems
Operating System | Note on Performance |
---|---|
Arch Linux | We use this for internal development and recommend it for high performance (high sample rates, etc.) |
Ubuntu 20.04 LTS | Packages are provided but performance may be negatively affected at higher sample rates, etc. |
Ubuntu 22.04 LTS | Packages are provided but performance may be negatively affected at higher sample rates, etc. |
Ubuntu 24.04 LTS | Packages are provided but performance may be negatively affected at higher sample rates, etc. |
Centos 8/Redhat 8.5/Oracle 8/Rocky Linux 8 | Packages are provided but performance may be negatively affected at higher sample rates, etc. |
Note
All performance measurements listed on our support site are carried out on an Arch Linux system.
Note
While other operating system’s may work (Windows, other Linux distributions), we highly recommend using one in the above table.
In most instances, there are two pieces of software that you will be needing: libUHD and GNU Radio. Most package managers have a version of libUHD that is compiled by Ettus for their radio products. At Per Vices, we maintain our own fork of UHD that looks and operates similarly with one main exception: it supports the Crimson TNG and Cyan radios that we manufacture. While you likely won’t notice the differences when using the software, you will have to take some care to make sure the correct (Per vices) version is what gets installed.
At run-time, GNU Radio compares the version of the UHD library used during compilation with the presently installed version. If there is a difference, it generates an error message. This is most often caused when using a distribution provided version of GNU Radio that has been compiled with the Ettus UHD version. Ensuring that you have correctly installed the Per Vices UHD version and GNURadio.
If you already have GNU Radio installed on your host computer, you need to first uninstall it (also uninstall the Ettus libUHD library, if applicable) and install the Per Vices libUHD and GNU Radio.
We use Arch Linux internally for development and testing. Installing UHD and GNU Radio on other distributions may be slightly more challenging.
Note
While the required procedure isn’t complicated, it definitely assumes familiarity with the Linux environment and build flow. If you run into difficulty, please contact us.
1. Installing from a Package Manager
This is the preferred method to install our version of libUHD and GNU Radio. Future updates could also be installed with the package manager.
Please follow this section if you are performing a fresh install.
If the host machine have installed Per Vices libUHD and GNU Radio with legacy methods (see section 5), i.e. installing from binary files from our website, you may migrate to the latest method i.e. installing from a Package Manager. The binary files for the legacy method will no longer update beyond version 4.4.0.23. Please see section 2 for how to migrate to use a package manager.
Again, follow this section if you are performing a fresh install only.
1.1. Arch Linux
To install Per Vices UHD and GNU Radio on Arch Linux, follow these instructions:
# Add the release repository into pacman.conf
$ echo -e "\n[home_pervices_release_Arch]\nServer = https://download.opensuse.org/repositories/home:/pervices:/release/Arch/\$arch" | sudo tee -a /etc/pacman.conf
# Download and import the key from our release repository
$ key=$(curl -fsSL https://download.opensuse.org/repositories/home:pervices:release/Arch/$(uname -m)/home_pervices_release_Arch.key)
$ fingerprint=$(gpg --quiet --with-colons --import-options show-only --import --fingerprint <<< "${key}" | awk -F: '$1 == "fpr" { print $10 }')
$ sudo pacman-key --init
$ sudo pacman-key --add - <<< "${key}"
$ sudo pacman-key --lsign-key "${fingerprint}"
# Refresh package database and install UHD and GNURadio
$ sudo pacman -Sy home_pervices_release_Arch/libuhdpv home_pervices_release_Arch/gnuradiopv
Note
If you see this error:
==> ERROR: There is no secret key available to sign with.
==> Use 'pacman-key --init' to generate a default secret key.
Please run sudo pacman-key --init
.
The error could happen in pre-built Arch Linux images, such as a docker image, as the signing key would not be included in an image.
Note
If you see errors similar to below:
error: failed retrieving file
# OR
error: libuhdpv: signature from "home:pervices OBS Project <home:pervices@build.opensuse.org>" is invalid
please try downloading the package directly with pacman.
The link can be found here.
Please copy the link for the *.pkg.tar.zst files, and paste it after pacman -U
to install, for example
$ sudo pacman -U https://download.opensuse.org/repositories/home:/pervices:/develop/Arch/x86_64/libuhdpv-nightly-202404260755+g3f81c7b3c-1-x86_64.pkg.tar.zst
1.2. Ubuntu 24.04
To install Per Vices UHD and GNU Radio on Ubuntu 24.04, follow these instructions:
# Add our release repository
$ sudo add-apt-repository -y ppa:pervices/release
# Install UHD and GNURadio
$ sudo apt install -y libuhdpv libuhdpv-dev uhdpv-host gnuradiopv
Note
If you see this error:
bash: add-apt-repository: command not found
Please run sudo apt install software-properties-common
to install add-apt-repository
.
This could happen if you are using a minimal install of Ubuntu
1.3. Ubuntu 20.04/22.04
To install Per Vices UHD and GNU Radio on Ubuntu 20.04 or 22.04, follow these instructions:
# Add our release repository
$ sudo add-apt-repository -y ppa:pervices/release && sudo add-apt-repository -y ppa:pervices/tools
# Install UHD and GNURadio
$ sudo apt install -y libuhdpv libuhdpv-dev uhdpv-host gnuradiopv
Note
If you see this error:
bash: add-apt-repository: command not found
Please run sudo apt install software-properties-common
to install add-apt-repository
This could happen if you are using a minimal install of Ubuntu
1.4. Oracle Linux 8 / Rocky Linux 8
To install Per Vices UHD and GNU Radio on Oracle Linux 8, follow these instructions:
# Enable our release repository
$ sudo dnf copr enable -y pervices/release && sudo dnf copr enable -y pervices/tools && sudo yum update --refresh
# Install UHD and GNURadio
$ sudo yum install -y libuhdpv gnuradiopv
Note
If you see No such command: copr
On Oracle Linux 8, make sure the Oracle EPEL repository is enabled. If not, run the following command to install the Oracle EPEL repository:
yum install oracle-epel-release-el8.x86_64
sudo dnf config-manager --set-enabled PowerTools
On RedHat Linux 8, enable EPEL and DNF plugins by installing the EPEL package.
sudo subscription-manager repos --enable codeready-builder-for-rhel-8-x86_64-rpms
sudo dnf config-manager --set-enabled ol8_codeready_builder
yum -y install dnf-plugins-core epel-release-el8
On Rocky Linux 8, enable EPEL by installing the EPEL package.
yum install epel-release
2. Migrating from a Legacy Install of UHD and GNURadio
If the computer have installed our version of UHD and GNURadio with the legacy installation methods (as provided in section 5 below), you can switch to the newer package manager installation method by following below.
Warning
Please note that the migration process could potentially break the package dependency of your system. Backup your system and important data before proceeding.
2.1. Arch Linux
Follow these instructions to perform an uninstall and reinstall UHD and GNURadio from our release repository.
# Uninstall UHD and GNURadio
sudo pacman -R libuhdpv gnuradio-git
# Download and import the key from our release repository
$ wget -qO - https://download.opensuse.org/repositories/home:/pervices:/release/Arch/x86_64/home_pervices_release_Arch.key | sudo pacman-key --add -
# Locally sign the imported key
$ sudo pacman-key --lsign-key home:pervices@build.opensuse.org
# Add the release repository into pacman.conf
$ echo -e "\n[home_pervices_release_Arch]\nServer = https://download.opensuse.org/repositories/home:/pervices:/release/Arch/\$arch" | sudo tee -a /etc/pacman.conf
# Refresh package database and install UHD and GNURadio
$ sudo pacman -Sy libuhdpv gnuradiopv
2.2. Ubuntu 20.04/22.04
Follow these instructions to perform an uninstall and reinstall UHD and GNURadio from our release repository.
# Uninstall UHD and GNURadio
$ sudo apt remove uhdpv gnuradiopv gnuradiopv-dev libgnuradiopv-analog* libgnuradiopv-audio* libgnuradiopv-blocks* libgnuradiopv-channels* libgnuradiopv-digital* libgnuradiopv-dtv* libgnuradiopv-fec* libgnuradiopv-fft* libgnuradiopv-filter* libgnuradiopv-iio* libgnuradiopv-network* libgnuradiopv-pdu* libgnuradiopv-pmt* libgnuradiopv-qtgui* libgnuradiopv-runtime* libgnuradiopv-soapy* libgnuradiopv-trellis* libgnuradiopv-uhd* libgnuradiopv-video-sdl* libgnuradiopv-vocoder* libgnuradiopv-wavelet* libgnuradiopv-zeromq*
# Add the release repository
$ sudo add-apt-repository -y ppa:pervices/release && sudo add-apt-repository -y ppa:pervices/tools
# Install UHD and GNURadio
$ sudo apt install -y libuhdpv libuhdpv-dev uhdpv-host gnuradiopv
2.3. Oracle Linux 8 / Rocky Linux 8
Follow these instructions to perform an uninstall and reinstall UHD and GNURadio from our release repository.
# Uninstall UHD and GNURadio
$ sudo dnf remove uhd gnuradio
# Uninstall these two packages as they have conflicts with dependencies
# They will be replaced with a different version
$ sudo dnf remove python3-mako python3-qt5-base
# Enable our release repository
$ sudo dnf copr enable -y pervices/release && sudo dnf copr enable -y pervices/tools && sudo yum update --refresh
# Install UHD and GNURadio
$ sudo yum install -y libuhdpv gnuradiopv
3. Installing Nightly Builds
Nightly builds are the latest development packages published from our repository. The packages might not be stable for production uses.
If you would like to install the latest nightly builds, please follow the instructions below. For migrating from legacy installations, please follow the uninstall instructions in 2., then follow the instructions below to import the develop repository and install the nightly packages.
If the release builds were installed, they would be automatically removed by the package manager (except Oracle Linux 8 and Rocky Linux 8).
3.1 Arch Linux
To install the nightly version of Per Vices UHD on Arch Linux, follow these instructions: There is no nightly version of GNU Radio for Arch Linux, please use the release version from 1.1 above.
# Add the develop repository into pacman.conf
$ echo -e "\n[home_pervices_develop_Arch]\nServer = https://download.opensuse.org/repositories/home:/pervices:/develop/Arch/\$arch" | sudo tee -a /etc/pacman.conf
# Download and import the key from our release repository
$ key=$(curl -fsSL https://download.opensuse.org/repositories/home:pervices:develop/Arch/$(uname -m)/home_pervices_develop_Arch.key)
$ fingerprint=$(gpg --quiet --with-colons --import-options show-only --import --fingerprint <<< "${key}" | awk -F: '$1 == "fpr" { print $10 }')
$ sudo pacman-key --init
$ sudo pacman-key --add - <<< "${key}"
$ sudo pacman-key --lsign-key "${fingerprint}"
# Refresh package database and install UHD
$ sudo pacman -Sy home_pervices_develop_Arch/libuhdpv-nightly
Note
If you want to go back to release builds, remove libuhdpv-nightly
and install libuhdpv
. You can also remove the develop repository from /etc/pacman.conf
$ sudo pacman -R libuhdpv-nightly
$ nano /etc/pacman.conf
$ sudo pacman -Sy libuhdpv
3.2 Ubuntu 24.04
To install the nightly version of Per Vices UHD and GNU Radio on Ubuntu 24.04, follow these instructions:
# Add the develop repository
sudo add-apt-repository -y ppa:pervices/develop
# Install the nightly version of UHD and GNURadio
sudo apt install -y libuhdpv-nightly libuhdpv-dev-nightly uhdpv-host-nightly gnuradiopv-nightly
Note
If you want to go back to release builds, uninstall the develop packages and remove the develop repository. And follow the instructions in section 1.2
$ sudo apt remove libuhdpv-nightly libuhdpv-dev-nightly uhdpv-host-nightly gnuradiopv-nightly
$ sudo add-apt-repository --remove ppa:pervices/develop
3.3 Ubuntu 20.04/22.04
To install the nightly version of Per Vices UHD and GNU Radio on Ubuntu 20.04/22.04, follow these instructions:
# Add the develop repository
sudo add-apt-repository -y ppa:pervices/develop && sudo add-apt-repository -y ppa:pervices/tools
# Install the nightly version of UHD and GNURadio
sudo apt install -y libuhdpv-nightly libuhdpv-dev-nightly uhdpv-host-nightly gnuradiopv-nightly
Note
If you want to go back to release builds, uninstall the develop packages and remove the develop repository. And follow the instructions in section 1.3
$ sudo apt remove libuhdpv-nightly libuhdpv-dev-nightly uhdpv-host-nightly gnuradiopv-nightly
$ sudo add-apt-repository --remove ppa:pervices/develop
3.4 Oracle Linux 8 / Rocky Linux 8
To install the nightly version of Per Vices UHD and GNU Radio on Oracle Linux 8 or Rocky Linux 8, follow these instructions:
# Enable the develop repository
$ sudo dnf copr enable -y pervices/develop && dnf copr enable -y pervices/tools && yum update --refresh
# Install the nightly version of UHD and GNURadio
$ sudo yum install -y libuhdpv-nightly gnuradiopv --allowerasing
Note
If you have the release version installed, please remove them before installing the nightly version
$ sudo dnf remove libuhdpv
Note
To go back to release builds, uninstall the nightly version and follow the instructions in 1.4
$ sudo dnf remove libuhdpv-nightly gnuradiopv
4. Updating Packages
Per Vices libUHD and GNU Radio could be updated via a package manager if they are installed according to section 2.
If the packages have not been installed with a package manager, i.e., installed with the legacy methods in section 5., please follow the installation instructions for a re-install to update the package.
The binary files for the legacy method will no longer be updated beyond version 4.4.0.23. You may need to migrate to the latest installation method to receive future updates. Please see section 2 for how to migrate to use a package manager.
Below are the instructions for only updating libUHD and GNU Radio. Please note that a full system upgrade is recommended over only updating specific packages.
4.1 Arch Linux
To update Per Vices UHD and GNU Radio on Arch Linux, follow these instructions:
# Refresh package database and update UHD and GNURadio
$ sudo pacman -Sy home_pervices_release_Arch/libuhdpv home_pervices_release_Arch/gnuradiopv
Note
If the package manager pacman
report conflicts, please try updating the corresponding packages, or do a full system upgrade with pacman -Syu
4.2 Ubuntu 20.04/22.04/24.04
To update Per Vices UHD and GNU Radio on Ubuntu, follow these instructions:
# Update UHD and GNURadio
$ sudo apt update
$ sudo apt install --only-upgrade libuhdpv libuhdpv-dev uhdpv-host gnuradiopv
4.3 Oracle Linux 8 / Rocky Linux 8
To update Per Vices UHD and GNU Radio on Oracle Linux 8 or Rocky Linux 8, follow these instructions:
# Update UHD and GNURadio
$ sudo yum update --refresh
$ sudo yum update libuhdpv gnuradiopv
5. Legacy Installation Methods
5.1. Installing from Binaries
Warning
The binary files for the legacy method will no longer update beyond version 4.4.0.23. You may migrate to the latest method i.e. installing from a Package Manager, for the latest packages. Please see section 2 for details.
uhdpv-v4.2.0.0-2209-g85d40a83-2024-08-20.tar.gz
and gnuradiopv_v3.10.5.1-0-gfed5b967_2024-08-20.tar.gz
will be the last version on file.pervices.com.
The binary files will be preserved for the legacy installation method.
Note
When installing from source, the packaged binaries for each distribution are created using the dockerfiles specified in the pvpkg repository.
Note
Ensure you do not have any other versions of UHD or GNU Radio installed! Remove all versions of UHD or GNU Radio if you are doing a fresh install.
5.1.1. Arch Linux Binaries
To install Per Vices UHD and GNU Radio on Arch Linux, follow these instructions:
-
Download the pre-compiled binaries for GNU Radio and Per Vices UHD:
Note
If the host is running headless, use these two commands to download the GNU Radio and UHD files.
$ wget -r -np -nH --cut-dirs=3 -R "*index.html*" http://files.pervices.com/latest/sw/archlinux/gnuradio/
$ wget -r -np -nH --cut-dirs=3 -R "*index.html*" https://files.pervices.com/latest/sw/archlinux/uhd/
-
Use this command to install the tar file first for UHD, and then for GNURadio.
$ sudo pacman -U --noconfirm <package name>
5.1.2. Ubuntu 20.04 Binaries
To install Per Vices UHD and GNU Radio on Ubuntu 20.04, follow these instructions:
-
Ensure the proper packages are installed to allow for building Debian packages on the host system:
$ sudo apt-get -y install dpkg-dev sudo apt-utils dh-make bzr-builddeb equivs xz-utils iputils-ping net-tools software-properties-common cmake git coreutils build-essential
-
Add a repo to allow for gcc-11 install:
$ sudo add-apt-repository ppa:ubuntu-toolchain-r/test
-
Install gcc-11:
$ sudo apt update && apt install -y gcc-11 g++-11
-
After installing gcc, determine the currently running compiler of GNU Radio with the following:
$ gcc --version
-
If the currently active gcc in step 5 is anything other than gcc 11, run these commands to ensure gcc-11 is used by default:
$ sudo update-alternatives --remove-all cpp && \ sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-9 90 --slave /usr/bin/g++ g++ /usr/bin/g++-9 --slave /usr/bin/gcov gcov /usr/bin/gcov-9 --slave /usr/bin/gcc-ar gcc-ar /usr/bin/gcc-ar-9 --slave /usr/bin/gcc-ranlib gcc-ranlib /usr/bin/gcc-ranlib-9 --slave /usr/bin/cpp cpp /usr/bin/cpp-9 && \ sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-11 110 --slave /usr/bin/g++ g++ /usr/bin/g++-11 --slave /usr/bin/gcov gcov /usr/bin/gcov-11 --slave /usr/bin/gcc-ar gcc-ar /usr/bin/gcc-ar-11 --slave /usr/bin/gcc-ranlib gcc-ranlib /usr/bin/gcc-ranlib-11 --slave /usr/bin/cpp cpp /usr/bin/cpp-11
-
Install pip to allow installation of necessary python module pygccxml:
$ sudo apt-get -y install python3-pip
-
Install the latest version of pygccxml to allow for C++17 Python compatibility (needed for gr-modtool):
$ sudo pip3 install pygccxml
-
Download the latest deb files (package) for UHD and GNU Radio here (Download UHD first then GNU Radio):
Note
If the host is running headless, use these two commands to download the GNU Radio and UHD files.
$ wget -r -np -nH --cut-dirs=3 -R "*index.html*" http://files.pervices.com/latest/sw/ubuntu20.04/uhd/
$ wget -r -np -nH --cut-dirs=3 -R "*index.html*" http://files.pervices.com/latest/sw/ubuntu20.04/gnuradio/
-
Navigate to where you downloaded the UHD deb files above and untar the build files:
$ sudo tar -xvzf <archive_name_ending_in .tar.gz>
-
Install UHD in the directory you untared the files using dpkg:
$ sudo dpkg -i uhd*.deb
-
The above command will most likely fail with missing dependencies, but the install will work by subsequently running the following command to retrieve these:
$ sudo apt --fix-broken install
-
Install volk 2.4.1 (this is the mimimum version required). Note that you will need to run this after installing UHD and before installing the GNU Radio Debian package.
$ git clone --branch v2.4.1 --recursive https://github.com/gnuradio/volk.git && cd volk && mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../ && make && sudo make install
-
Untar and install the GNU Radio deb packages as was done for UHD in steps 9 to 11.
$ sudo dpkg -i libgnuradio*.deb $ sudo apt --fix-broken install $ sudo dpkg -i gnuradio*.deb $ sudo apt --fix-broken install
5.1.3. Ubuntu 22.04 Binaries
To install Per Vices UHD and GNU Radio on Ubuntu 22.04, follow these instructions:
-
Ensure the proper packages are installed to allow for building Debian packages on the host system:
$ sudo apt-get -y install dpkg-dev sudo apt-utils dh-make bzr-builddeb equivs xz-utils iputils-ping net-tools software-properties-common cmake git coreutils build-essential
-
Install pip to allow installation of necessary python module pygccxml:
$ sudo apt-get -y install python3-pip
-
Install the latest version of pygccxml to allow for C++17 Python compatibility (needed for gr-modtool):
$ sudo pip3 install pygccxml
-
Download the latest deb files (package) for UHD and GNU Radio here (Download UHD first then GNU Radio):
Note
If the host is running headless, use these two commands to download the GNU Radio and UHD files.
$ wget -r -np -nH --cut-dirs=3 -R "*index.html*" http://files.pervices.com/latest/sw/ubuntu22.04/uhd/
$ wget -r -np -nH --cut-dirs=3 -R "*index.html*" http://files.pervices.com/latest/sw/ubuntu22.04/gnuradio/
-
Navigate to where you downloaded the UHD deb files above and untar the build files:
$ sudo tar -xvzf <archive_name_ending_in .tar.gz>
-
Install UHD in the directory you untared the files using dpkg:
$ sudo dpkg -i uhd*.deb
-
The above command will most likely fail with missing dependencies, but the install will work by subsequently running the following command to retrieve these:
$ sudo apt --fix-broken install
-
Install volk 2.5.1 (this is the mimimum version required). Note that you will need to run this after installing UHD and before installing the GNU Radio Debian package.
$ git clone --branch v2.5.1 --recursive https://github.com/gnuradio/volk.git && cd volk && mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../ && make && sudo make install
-
Untar and install the GNU Radio deb packages as was done for UHD in steps 5 to 7.
$ sudo dpkg -i libgnuradio*.deb $ sudo apt --fix-broken install $ sudo dpkg -i gnuradio*.deb $ sudo apt --fix-broken install
5.1.4. Oracle 8/Centos 8/Redhat 8.5 Binaries
To install Per Vices UHD and GNU Radio on Oracle Linux 8, follow these instructions:
-
Ensure that you have packages installed that are required before beginning the UHD/Volk/Gnuradio install:
$ sudo yum -y install dnf-plugins-core oracle-epel-release-el8 make gcc rpm-build git rpmdevtools wget cmake python3-pip
-
Add a repository necessary for some of the dependencies
$ sudo dnf config-manager --set-enabled ol8_codeready_builder
-
To ensure C++17 Python compatibility, you need to move local install from pip to rpm site-packages to use in GNU Radio install or else it will not be located. Run the following to do this:
$ sudo pip3 install retrying==1.3.3 pygccxml==2.2.1 pyqtgraph==0.11.1 && \ cd /usr/local/lib/python3.6/site-packages/ && \ mv pygccxml pygccxml-2.2.1.dist-info pyqtgraph pyqtgraph-0.11.1.dist-info retrying-1.3.3-py3.6.egg-info retrying.py /usr/lib/python3.6/site-packages
-
Get the latest version of Per Vices UHD and GNU Radio build files:
Note
If the host is running headless, use these two commands to download the GNU Radio and UHD files.
$ wget -r -np -nH --cut-dirs=3 -R "*index.html*" https://www.files.pervices.com/latest/sw/oracle8/gnuradio/
$ wget -r -np -nH --cut-dirs=3 -R "*index.html*" https://www.files.pervices.com/latest/sw/oracle8/uhd/
-
Untar the the build files:
$ sudo tar -xvzf <archive_name_ending_in .tar.gz>
-
From directory where the UHD build files are extracted, run this command to install all the necessary UHD dependencies:
$ sudo dnf builddep -y uhd.spec
-
To install UHD, run the following command in the directory with the UHD RPM files (package):
$ sudo rpm -i uhd*.rpm
-
Ensure gcc-11 is set as compiler for application runtime (adjust path if gcc-toolset-11 is installed at different location).
$ sudo source /opt/rh/gcc-toolset-11/enable
-
Install all dependencies necessary for GNU Radio (these commands are run in the directory that the gnuradio tar file is extracted to):
$ sudo dnf builddep -y gnuradio.spec
-
From directory where GNU Radio files are extracted, run the following commands to install:
$ sudo rpm -i volk*.rpm && rpm -i libgnuradio*.rpm && rpm -i python3*.rpm && rpm -i gnuradio*.rpm
6. Compiling from Source
6.1 Compiling from Source Using a Package Manager
The following assumes legacy installation method is being used.
We automatically compile the UHD and GNU Radio binaries used with our product using dockerfiles found in the pvpkg repo, for specific distributions, including Arch Linux, Ubuntu, and Centos.
Figure 8: Overview of libUHD installation process
We encourage you to clone this repo, as it includes a number of patches and dependencies required to make the installation easier, and it also allows you to use your package manager for installation. You can clone the repo as follows;
$ git clone https://github.com/pervices/pvpkg
To build the package, we use a Jenkinsfile. Instructions on how to install Jenkins is found in the README.md file within the above repo. You may also create the required binaries yourself, using the dockerfiles associated with each distribution.
6.1.1. Arch Linux
To compile the current UHD binaries from source, you can use the dockerfile to help determine the required dependencies necessary to compile UHD and Gnuradio from your own distribution. This dockerfile assumes a clean installation of Arch Linux, and presents you with a guide on how to install it.
We suggest cloning the pvpkg repo, and then entering the arch subdirectory. This includes the required dependencies, along with a dockerfile that may be used to help guide installation.
In particular, you’ll first need to install the required dependencies for Arch Linux. You can find these dependencies in the archlinux dockerfile, which specifies all the steps we use to automatically build the Arch Linux binaries we post.
To download the latest UHD library from git hub, and install all the required dependencies, here is the command
sudo wget https://raw.githubusercontent.com/pervices/pvpkg/master/Arch/UHD/PKGBUILD && \
yay -Sy --noconfirm \
$(pacman --deptest $(source ./PKGBUILD && echo ${depends[@]} ${makedepends[@]})) && \
makepkg --noconfirm --syncdeps --install --needed
You may also find the above command in the archlinux UHD PKGBUILD script
6.1.2 Ubuntu
We suggest first cloning the pvpkg repo:
$ git clone https://github.com/pervices/pvpkg
Then, you can use the dockerfile for ubuntu20.04 as a guide, as shown here.
When following the dockerfile, note that we require a libboost dependency of 1.67. If you’ve update your boost library, you will need to uninstall the older versions of boost, and install the 1.67 version. This may be a bit tricky, but running apt-get remove, along with apt-get autoremove, will help.
This is especially true if you’re not able to successfully run the mk-build-deps command. In this case, running the following may help;
$ apt-get install libboost1.67-all-dev
You may need to manually install the unmet dependencies if this is the case. Otherwise, you can follow the dockerfile commands, substituting the notroot directory for your own home directory.
6.2. Compiling from Source Manually
Provided you’re prepared to resolve your own dependencies, you can easily compile UHD and Gnuradio from source. The specific commands and flags used to compile the sources, are most easily found within the Arch Linux PKGBUILD associated with each application.
6.2.1. Manual Compilation Tips
If you are committed to using another operating system, then you will want to build GNU Radio and UHD from source. However, your package manager can be useful for obtaining the necessary dependencies. We suggest installing all GNU Radio and UHD dependencies using your distribution package management system, and then actually installing GNU Radio and UHD from source.
-
Install all GNU Radio and UHD dependencies, but do NOT actually install GNU Radio or UHD.
- You need to ensure that you have all the required install dependencies.
- Though you will try to avoid installing GNU Radio or UHD
-
After installing the required dependencies, confirm that you do NOT have any of the following installed;
- gnuradio
- libgnuradio
- libvolk
- libuhd
- uhd-host
-
If you have previously attempted to install GNU Radio or UHD from source, confirm that you do not have any residual files.
- Ideally, if you still have the original source directory, you can run ?make uninstall? as root, to delete all the installed files.
- The default installation settings see gnuradio installed in /usr/local/{bin,lib…}. Check each of the subdirectories in /usr/src to see whether you have old installation files. The presence of these files WILL cause problems down the road; either move them somewhere else, or delete them.
-
Download the Per Vices UHD driver sources code, and compile and install it.
- For compatability, you may want to use the
-DCMAKE_INSTALL_PREFIX=/usr
cmake flag to install binaries to /usr (this is consistent with most linux distributions). - In order to successfully install the remaining components, you will need to have successfully installed the Per Vices UHD driver.
- We recommend confirming that you have installed the correct
uhd version, by typing;
uhd_find_devices -v
and confirming that the version number matches what you expect.
- For compatability, you may want to use the
-
Download the gnuradio source code, compile and install it.
- The gnuradio application needs to use the systems python interpreter and some accompanying python libraries to run. To ensure that our system can locate these tools, we will need to ensure that the
PYTHONPATH
andLD_LIBRARY_PATH
are properly set. - You can verify that the
LD_LIBRARY_PATH
is set correctly usingsudo ldconfig
- The gnuradio application needs to use the systems python interpreter and some accompanying python libraries to run. To ensure that our system can locate these tools, we will need to ensure that the
echo 'export PYTHONPATH=/usr/local/lib/python3/dist-packages:usr/local/lib/python2.7/site-packages:$PYTHONPATH' >> ~/.bashrc
echo 'export LD_LIBRARY_PATH=/user/local/lib:$LD_LIBRARY_PATH' >> ~/.bashrc
echo 'export PYTHONPATH=/usr/local/lib/python3/dist-packages:usr/local/lib/python2.7/site-packages:$PYTHONPATH' >> ~/.profile
echo 'export LD_LIBRARY_PATH=/user/local/lib:$LD_LIBRARY_PATH' >> ~/.profile
7. After installation
Confirm your installation by testing successful set up and operation.
You can also learn more about how to use our software by looking at our tutorials.