View source for LinuxInstall

The recommended way to install GNU Radio on most platforms is using already available binary packages. Find your platform below in the [[#From_Binaries|From Binaries]] section for instructions on how to get GNU Radio through your regular package manager (e.g. [[#Ubuntu_PPA_Installation|Ubuntu PPA Installation]]), or visit the [[CondaInstall|Conda Installation]] page for instructions on how to use the Conda package manager to install GNU Radio on any Linux distribution, macOS, or Windows. For some platforms there are no binaries provided by available package managers or the GNU Radio project. In these cases please contact the maintainer of the package manager or the GNU Radio project to find a sensible way to provide binaries for your platform.
<!-- LinuxInstall.mediawiki -->
== From Binaries ==

Most distributions contain a package named <code>gnuradio</code> or similar in their standard repositories. For most use cases it is enough to install this package and start developing.

The development of GNU Radio can be fast-paced, and binaries provided by your distribution may be outdated. '''Do check if the version you're installing is up to date! Sometimes old versions are not updated in the packaging systems.''' If you find a bug in a older GNU Radio version, please check if the bug still exists in the newer version of GNU Radio before filing a new issue.

{| class="wikitable"
|+ Versions of recent Ubuntu releases
!scope="col"|Distribution
!scope="col"|GR version
!scope="col"|UHD version
!scope="col"|VOLK version
|-
! Ubuntu 22.04
||v3.10.1.1
||4.1.0
||2.5.1
|-
! Ubuntu 20.04
||v3.8.1.0
||3.15.0
||2.2.1
|}

If the version shipped in your distribution is outdated please contact the corresponding maintainer to update it in the packaging system.

=== Distributions and Commands ===

Here are examples of how to install GNU Radio in various Linux distributions. <b>Click the link under &quot;Distribution&quot; for how to install dependencies.</b>

{|class="wikitable" style="margin: auto; width: 90%;"
!scope="col"|Distribution
!scope="col"|Command
|-
| [[UbuntuInstall|Debian/Ubuntu and derivates]]
| <pre># apt install gnuradio</pre>
|-
| [[FedoraInstall|Fedora]]
| <pre># dnf install gnuradio</pre>
|-
| RHEL/CentOS/Rocky Linux/AlmaLinux
| <pre># yum install gnuradio</pre>
|-
| [[ArchInstall|Archlinux]]
| <pre># pacman -S gnuradio</pre>
|-
| [[GentooInstall|Gentoo Linux]]
| <pre># emerge net-wireless/gnuradio</pre>
|-
| [[SuseInstall|Suse Linux]]
| 
|-
| [[InstallingGRFromSource_on_Raspberry_Pi|Raspberry Pi OS]]
| 
|-
|}

On other distributions, simply use the appropriate package management command to install the <code>gnuradio</code> package and then please add it to this list. If you need newer versions or have a different platform please contact the package maintainer of your distribution or raise your issue on the mailing list.

== Ubuntu PPA Installation ==
For Ubuntu, the latest builds (both released and pulled from master branch) are maintained as PPAs on [https://launchpad.net/~gnuradio launchpad].<br>
<b>Be sure to uninstall any previously installed versions of gnuradio first.</b> See [[UnInstallGR#From_PPA|UnInstallGR]].<br><br>

To access the current released version (3.10), add the gnuradio/gnuradio-releases ppa (removing other gnuradio ppas if already configured)

<pre>$ sudo add-apt-repository ppa:gnuradio/gnuradio-releases</pre>

To access the 3.9 released version, add the gnuradio/gnuradio-releases-3.9 ppa (removing other gnuradio ppas if already configured)

<pre>$ sudo add-apt-repository ppa:gnuradio/gnuradio-releases-3.9</pre>

To access the 3.8 released version, add the gnuradio/gnuradio-releases-3.8 ppa (removing other gnuradio ppas if already configured)

<pre>$ sudo add-apt-repository ppa:gnuradio/gnuradio-releases-3.8</pre>

To access the 3.7 released version (legacy), add the gnuradio/gnuradio-releases-3.7 ppa (removing other gnuradio ppas if already configured)

<pre>$ sudo add-apt-repository ppa:gnuradio/gnuradio-releases-3.7</pre>

Then, update the apt sources, and install gnuradio
<pre>$ sudo apt-get update</pre>
<pre>$ sudo apt install gnuradio</pre>

'''Attention:''' Do '''NOT''' try to install further packages like `gr-osmosdr` via Ubuntu's package management (i.e. using "apt"). Ubuntu will try to install a potentially incompatible version and your system will be in an undefined state. Instead, please first open GNURadio-Companion, and in the right-hand side block list, open "Soapy" -> "Source" or "Sink", to see whether the hardware you are most likely using is already integrated.


'''Note on 3.10 packaging dependency'''
For some distributions you may need to install the python module 'packaging' using pip (which may also need to be installed).

 $ sudo apt install python3-pip
 $ pip install packaging

=== Modtool on Ubuntu ===
NOTE: On released builds for Ubuntu 18.04 (bionic), there is an issue using gr_modtool after GNU Radio has been installed from the PPA.  This is due to byte-compiled code that remains in the modtool templates after installation.  To work around this issue:

<pre>$ cd /usr/share/gnuradio/modtool/templates/gr-newmod
$ sudo py3clean .</pre>

This issue does not appear for Ubuntu 19 and later packages

== Fedora COPR Installation ==

<b>NOTE: FEDORA COPR is not currently maintained.</b>

Packages are available for Fedora 29, 30, 31 hosted under COPR:

https://copr.fedorainfracloud.org/coprs/gnuradio/

1. Add the repository:

-- For the latest released version:
<pre>$ sudo dnf copr enable gnuradio/gnuradio-releases </pre>
-- For the latest pull from git master:
<pre>$ sudo dnf copr enable gnuradio/gnuradio-master </pre>

2. Install GNU Radio
<pre>$ sudo dnf install gnuradio </pre>

= From Source =

Binary installation should be sufficient for most users, and certainly for anyone who is new to GNU Radio. However, if you have special requirements, want the latest version, or the binary packages are not working for you, you may want to install GNU Radio from source. But note that running and developing out-of-tree modules does <b>NOT</b> require GNU Radio to be installed from source.

=== Notes ===

* By default GNU Radio will be installed in the <code>/usr/local</code> directory.  See notes about [[#Common_cmake_flags|-DCMAKE_INSTALL_PREFIX]] to install it elsewhere.
* <b>Running and developing out-of-tree modules does <u>not</u> require GNU Radio to be installed from source.</b>
* To install on a Raspberry Pi, see [[InstallingGRFromSource on Raspberry Pi]].
* To build from source from within a conda environment, see [[CondaInstall#Building GNU Radio from source within a conda environment|the conda install guide]].

=== For GNU Radio 3.10, 3.9, and Main Branch ===

This section describes how to install GNU Radio 3.10, 3.9, and the Main branch from source code.

==== Installing Dependencies ====

Refer to [[#Distributions_and_Commands|the table above for your specific Linux distro]] to find how to install dependencies.  For example, on Ubuntu 22.04 [[UbuntuInstall#Install_Dependencies|use this page]].

==== Installing UHD ====

<b>If you want to use GNU Radio with a USRP, you FIRST must clone and install UHD</b>.<br> Follow the instructions in [[Draft-AN-445#Building_and_installing_UHD_from_source_code|Install UHD from source]].

==== Installing Volk ====

Since Volk is no longer considered as a submodule of GNU Radio (GNU Radio commit #80c04479da962d048d41165081b026aafdaa0316),<br> you <b>MUST FIRST</b> install Volk, and then install GNU Radio. 

The basic idea is the same, but instead of building Volk along with GNU Radio, you need to clone and build it separately. For this example, we will start in the home directory. You can, of course, use any directory you wish and the results will be the same.

* <code>cd</code>
* <code>git clone --recursive https://github.com/gnuradio/volk.git</code>
* <code>cd volk</code>
* <code>mkdir build</code>
* <code>cd build</code>
<b>Note:</b> In the following command, you can add <code>-DCMAKE_INSTALL_PREFIX=XXX</code> to install Volk into the PREFIX <code>XXX</code>; if not specified, then the PREFIX is <code>/usr/local</code>. See other CMake options in [[#Common_cmake_flags|Common cmake flags]].<br>
* <code>cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../</code>
* <code>make</code>
* <code>make test</code>
* <code>sudo make install</code>

If you're running Linux, then always remember to do the following command after installing any library:
* <code>sudo ldconfig</code>

==== Installing GNU Radio ====

* <code>cd</code>
* <code>git clone https://github.com/gnuradio/gnuradio.git</code>
* <code>cd gnuradio</code>
<b>Note:</b> If you want to build the <code>maint-3.10</code> or <code>maint-3.9</code> branch rather than the default <code>main</code> branch, enter:<br>
<code>git checkout maint-3.10</code> or <code>git checkout maint-3.9</code> and then<br>
* <code>mkdir build</code>
* <code>cd build</code>
<b>Note:</b> In the following command, you can add <code>-DCMAKE_INSTALL_PREFIX=XXX</code> to install GNU Radio into the PREFIX <code>XXX</code>; if not specified, then the PREFIX is <code>/usr/local</code>. See other CMake options in [[#Common_cmake_flags|Common cmake flags]].<br>
* <code>cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../</code>
* <code>make -j3</code> (e.g. if you want to use 3 CPU cores during the build.  To use 8 do -j8, to use all cores use -j$(nproc), to use 1, leave out the -j flag.)
<b>Note:</b> In the following command, it is very possible that not all tests pass. Generally any error is a sign of a missing dependency such as the Python interface to ZMQ or NumPy or SciPy, none of which are required for building GNU Radio but are required for testing.
* <code>make test</code>
* <code>sudo make install</code>
If you're running Linux, then always remember to do the following command after installing any library:
* <code>sudo ldconfig</code>
As an optional step to increase performance, we recommend running the following, although it can take 10-15 minutes and you can always do it later:
* <code>volk_profile</code>
If you encounter "Cannot import gnuradio" error, then go to [[ModuleNotFoundError#B._Finding_the_Python_library|Finding the Python library]] to set your PYTHONPATH and LD_LIBRARY_PATH.<br><b>After setting these environment variables, you need to do</b> <code>sudo ldconfig</code> <b>again</b> for the Linux dynamic library loader to find the just-installed GNU Radio libraries.<br>
If you have installed in a custom path with <code>-DCMAKE_INSTALL_PREFIX=XXX</code>, you will need to add that path to $PATH in order to find gnuradio-companion.

=== For GNU Radio 3.8 or Earlier ===

==== Installing Dependencies ====

Refer to [[#Distributions_and_Commands|the table above for your specific Linux distro]] to find how to install dependencies.  For example, on Ubuntu 20.04 [[UbuntuInstall#Install_Dependencies|use this page]].

==== Installing UHD ====

<b>If you want to use GNU Radio with a USRP, you FIRST must clone and install UHD</b>.<br> Follow the instructions in [[Draft-AN-445#Building_and_installing_UHD_from_source_code|Install UHD from source]].

==== Installing GNU Radio ====
For this example, we will start in the home directory; you can, of course, use any directory you wish and the results will be the same.

* <code>cd</code>
* <code>git clone https://github.com/gnuradio/gnuradio.git</code>
* <code>cd gnuradio</code>

<b>Note:</b> In the following command, change <code>maint-3.8</code> to <code>maint-3.7</code> if you want to build that version.

* <code>git checkout maint-3.8</code>
* <code>git submodule update --init --recursive</code>
* <code>mkdir build</code>
* <code>cd build</code>

<b>Note:</b> In the following command, you can add <code>-DCMAKE_INSTALL_PREFIX=XXX</code> to install GNU Radio into the PREFIX <code>XXX</code>; if not specified, then the PREFIX is <code>/usr/local</code>. See other CMake options in [[#Common_cmake_flags|Common cmake flags]].<br>

* <code>cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../</code>
* <code>make -j3</code> (e.g. if you want to use 3 CPU cores during the build.  To use 8 do -j8, to use all cores use -j$(nproc), to use 1 leave out the -j flag.)
<b>Note:</b> In the following command, it is very possible that not all tests pass. Generally any error is a sign of a missing dependency such as the Python interface to ZMQ or NumPy or SciPy, none of which are required for building GNU Radio but are required for testing.
* <code>make test</code>
* <code>sudo make install</code>

If you're running Linux, then always remember to do the following command after installing any library:
* <code>sudo ldconfig</code>

Go to [[ModuleNotFoundError#B._Finding_the_Python_library|Finding the Python library]] to set your PYTHONPATH and LD_LIBRARY_PATH.<br><b>After setting these environment variables, you need to do</b> <code>sudo ldconfig</code> <b>again</b> for the Linux dynamic library loader to find the just-installed GNU Radio libraries.<br>
If you have installed in a custom path with <code>-DCMAKE_INSTALL_PREFIX=XXX</code>, you will need to add that path to $PATH in order to find gnuradio-companion.

==== For Ubuntu 18.04 ====

An easy way to install GNU Radio 3.8 on Ubuntu 18.04 systems is to use the following commands (note that this skips the setup for UHD hardware):

* <code>sudo apt install git cmake g++ libboost-all-dev libgmp-dev swig python3-numpy python3-mako python3-sphinx python3-lxml doxygen libfftw3-dev libsdl1.2-dev libgsl-dev libqwt-qt5-dev libqt5opengl5-dev python3-pyqt5 liblog4cpp5-dev libzmq3-dev python3-yaml python3-click python3-click-plugins python3-zmq python3-scipy python3-pip python3-gi-cairo</code>
* <code>pip3 install git+https://github.com/pyqtgraph/pyqtgraph@develop</code>
* <code>pip3 install numpy scipy</code>
* <code>echo 'export PYTHONPATH=/usr/local/lib/python3/dist-packages:usr/local/lib/python2.7/site-packages:$PYTHONPATH' >> ~/.bashrc</code>
* <code>echo 'export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH' >> ~/.bashrc</code>
* <code>echo 'export PYTHONPATH=/usr/local/lib/python3/dist-packages:usr/local/lib/python2.7/site-packages:$PYTHONPATH' >> ~/.profile</code>
* <code>echo 'export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH' >> ~/.profile</code>
* <code>cd ~/</code>
* <code>git clone --recursive https://github.com/gnuradio/gnuradio</code>
* <code>cd gnuradio</code>
* <code>git checkout maint-3.8</code>
* <code>mkdir build</code>
* <code>cd build</code>
* <code>git pull --recurse-submodules=on</code>
* <code>git submodule update --init</code>
* <code>cmake -DENABLE_GR_UHD=OFF ..</code>
* <code>make -j $(nproc --all)</code>
* <code>sudo make install</code>
* <code>sudo ldconfig</code>

Once this is done, reboot your computer and GNU Radio should be all set for you.

== Common cmake flags ==

* <code>-DCMAKE_INSTALL_PREFIX=XXX</code> Install the generated code in XXX. For example, <code>-DCMAKE_INSTALL_PREFIX=/home/<user>/gr3106</code> would put the code in <code>$HOME/gr3106/bin</code>, <code>$HOME/gr3106/include</code>, etc.
** Unless you need more than one version of UHD or Volk, those builds can be done in the standard location <code>/usr/local</code>.
** For the system to find 'gnuradio-companion' and other related programs, <code>$HOME/gr3106/bin</code> must be added to $PATH.
* <code>-DENABLE_GR_XXX=ON</code> This enables (or disables for =OFF) the GNU Radio component named XXX. You might not need all of them, and this way, you can compile quicker.
* <code>-DCMAKE_BUILD_TYPE=Debug</code> This causes gcc to add debug symbols to all binaries. Useful for debugging (otherwise, it decreases efficiency!)
* <code>-DPYTHON_EXECUTABLE=/usr/bin/python{2,3}</code> This selects the Python version and executable to be used during build time and will determine which Python libraries will be used for building the Python bindings.
<p>For a list of additional cmake flags, as well as minimum versions of dependencies, see [https://www.gnuradio.org/doc/doxygen/build_guide.html#cmake_options build_guide.html#cmake_options]</p>