Difference between revisions of "InstallingGR"

From GNU Radio
Jump to: navigation, search
(Linux)
m (add Ubuntu 19)
 
(47 intermediate revisions by 4 users not shown)
Line 7: Line 7:
 
# '''[[#From_Source|From source]]''' (for those who want full control)
 
# '''[[#From_Source|From source]]''' (for those who want full control)
 
# '''[[#Using_PyBOMBS|Using PyBOMBS]]''' (for those who want it built from source and/or installed to a specific directory using a script)
 
# '''[[#Using_PyBOMBS|Using PyBOMBS]]''' (for those who want it built from source and/or installed to a specific directory using a script)
# '''[[#Bootable_DVD_with_GNU_Radio_Pre-installed|Premade Linux Live DVD/USB]]''' (great for someone without a Linux machine who just wants to try it out)
 
  
 
== Linux ==
 
== Linux ==
Line 45: Line 44:
  
 
=== Ubuntu PPA Installation ===
 
=== Ubuntu PPA Installation ===
For Ubuntu, the latest builds (both released and pulled from master branch) are maintained as PPAs on launchpad.  Be sure to uninstall gnuradio first.
+
For Ubuntu, the latest builds (both released and pulled from master branch) are maintained as PPAs on [https://launchpad.net/~gnuradio/+archive/ubuntu/gnuradio-master launchpad].  Be sure to uninstall gnuradio first.
  
 
To access the latest released version, add the gnuradio/gnuradio-releases ppa (removing other gnuradio ppas if already configured)
 
To access the latest released version, add the gnuradio/gnuradio-releases ppa (removing other gnuradio ppas if already configured)
Line 62: Line 61:
 
<pre>$ sudo apt-get update</pre>
 
<pre>$ sudo apt-get update</pre>
 
<pre>$ sudo apt install gnuradio</pre>
 
<pre>$ sudo apt install gnuradio</pre>
 +
 +
==== Modtool on Ubuntu ====
 +
NOTE: On released builds for Ubuntu 18 (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 workaround 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 ===
 
=== Fedora COPR Installation ===
 +
 +
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>
  
 
== Windows ==
 
== Windows ==
Line 80: Line 101:
 
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.
 
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.
  
== Notes ==
+
=== Notes ===
  
* By default GNU Radio will be installed in the /usr/local directory.
+
* By default GNU Radio will be installed in the /usr/local directory.  See notes about -DCMAKE_INSTALL_PREFIX to install it elsewhere.
 
* Running and developing out-of-tree modules does not require GNU Radio to be installed from source.  
 
* Running and developing out-of-tree modules does not require GNU Radio to be installed from source.  
 
* If you are using Ubuntu, see [[UbuntuInstall#Install_the_Pre-Requisites]] for installing dependencies / pre-requisites.
 
* If you are using Ubuntu, see [[UbuntuInstall#Install_the_Pre-Requisites]] for installing dependencies / pre-requisites.
* If you want to use GNU Radio with a USRP, install the UHD package or follow the [https://files.ettus.com/manual/page_build_guide.html UHD Manual Build Guide].
+
* If you want to use GNU Radio with a USRP, you <b>FIRST</b> must clone and install UHD. See [[https://kb.ettus.com/Building_and_Installing_the_USRP_Open-Source_Toolchain_(UHD_and_GNU_Radio)_on_Linux UHD Installation Page]] for more info.
 
* To install on a Raspberry Pi, see [[InstallingGRFromSource on Raspberry Pi]].
 
* To install on a Raspberry Pi, see [[InstallingGRFromSource on Raspberry Pi]].
  
== To install system wide ==
+
=== For the GNU Radio Master Branch ===
  
<p>It doesn't matter which directory you start in; it can be home, ~/Downloads, etc.; but <b>gnuradio will become a sub-directory of that starting point.</b></p>
+
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.
* <code>git clone --recursive https://github.com/gnuradio/gnuradio.git</code>
+
 
 +
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.
 +
 
 +
==== Step 1: Installing Dependencies ====
 +
 
 +
Refer to [[InstallingGR#Linux|this page for your specific Linux distro]] to find how to install dependencies.  For example, on Ubuntu 18 and 19 [[UbuntuInstall#Bionic Beaver (18.04) through Eoan Ermine (19.10)|use this command]].
 +
 
 +
==== Step 2: Installing Volk ====
 +
 
 +
* <code>cd</code>
 +
* <code>git clone https://github.com/gnuradio/volk.git</code>
 +
* <code>cd volk</code>
 +
* <code>mkdir build</code>
 +
* <code>cd build</code>
 +
* <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>
 +
 
 +
==== Step 3: Installing GNU Radio ====
 +
* <code>cd</code>
 +
* <code>git clone https://github.com/gnuradio/gnuradio.git</code>
 
* <code>cd gnuradio</code>
 
* <code>cd gnuradio</code>
* <code>git checkout maint-3.8</code> # change `maint-3.8` if you want to use a different version; see [https://github.com/gnuradio/gnuradio/releases releases]
 
 
* <code>mkdir build</code>
 
* <code>mkdir build</code>
 
* <code>cd build</code>
 
* <code>cd build</code>
* <code>cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../</code> # see other options below
+
* <code>cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../</code>
* Note: if your computer has multiple cores, you can use the -j option for 'make' to speed compilation, e.g. <code>make -j3</code> but specify one less than the total so the system does not appear to 'freeze'.
 
 
* <code>make</code>
 
* <code>make</code>
 +
 +
<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>make test</code>
 
* <code>sudo make install</code>
 
* <code>sudo make install</code>
 +
 +
Again, if you're running Linux, then always remember to do the following command after installing any library:
 +
* <code>sudo ldconfig</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.
 +
 +
=== For GNU Radio 3.8 or Earlier ===
 +
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 some other branch or tag if you want to build a different version of GNU Radio; see [https://github.com/gnuradio/gnuradio/tags tags] for tagged releases including pre-releases ("rc"). For  [https://github.com/gnuradio/gnuradio/branches branches], it's generally wise to stick with "master" (the default after cloning), and, currently: <code>maint-3.7</code> or <code>maint-3.8</code>. Here we checkout the <code>maint-3.8</code> branch, which contains the latest 3.8 release plus any fixes or augmentations to it that will be in the next 3.8 release.
 +
 +
* <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 use <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 1 leave out the -j flag.)
 +
* <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>
 
* <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.
  
 
== Common cmake flags ==
 
== Common cmake flags ==
Line 115: Line 190:
 
PyBOMBS is good at building GNU Radio, UHD, and various Out of Tree (OOT) modules from source and then installing into a specified user directory rather than in the system files. PyBOMBS detects the user's Operating System and loads all of the prerequisites in the first stage of the build.
 
PyBOMBS is good at building GNU Radio, UHD, and various Out of Tree (OOT) modules from source and then installing into a specified user directory rather than in the system files. PyBOMBS detects the user's Operating System and loads all of the prerequisites in the first stage of the build.
  
The PyBOMBS documentation is in the PyBOMBS [https://github.com/duggabe/pybombs#pybombs README].
+
The PyBOMBS documentation is in the PyBOMBS [https://github.com/gnuradio/pybombs#pybombs README].
  
= Bootable DVD with GNU Radio Pre-installed =
+
= OK, it's installed, what now? =
  
One can download a fully pre-configured [[GNURadioLiveDVD]] that allows trying out GNU Radio without installing GNU Radio onto a PC. To make a permanent installation of GNU Radio, one will still needs to choose from the options described above.
+
If the installation worked without any trouble, you're ready to use GNU Radio! If you have no idea how to do that, the best place to start is with the [[Tutorials]].
 
 
= OK, it's installed, what now? =
 
  
If the installation worked without any trouble, you're ready to use GNU Radio! If you have no idea how to do that, read the [[HowToUse|page on how to use GNU Radio]]. You probably want to connect some [[Hardware]] to your computer to try and receive or transmit stuff. If you or your group would like to get a professional jump start on using GNU Radio and the USRP, [http://corganlabs.com Corgan Labs] offers a 3-day, hands-on training class that can be held at your own location.
+
Optionally, you may run <code>volk_profile</code> on your terminal to help libvolk to determine the optimal kernels (may speed up GNU Radio).  
  
 
[[Category:Installation]]
 
[[Category:Installation]]
 
[[Category:Guide]]
 
[[Category:Guide]]

Latest revision as of 18:51, 5 May 2020

From Binaries

The recommended way to install GNU Radio on most platforms is using already available binary packages. For some platforms there are no binaries provided by available package managers or the GNU Radio project. In these cases please contact maintainer of the package manager or the GNU Radio project to find a sensible way to provide binaries for your platform.

In addition to using binaries, GNU Radio can be installed:

  1. From source (for those who want full control)
  2. Using PyBOMBS (for those who want it built from source and/or installed to a specific directory using a script)

Linux

Most distributions contain a package named gnuradio 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 is 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 it.

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

Examples of how to install GNU Radio in various Linux distributions (click each one for more installation details):

Distribution Command
Debian/Ubuntu and derivates
$ apt install gnuradio
Fedora
$ dnf install gnuradio
RHEL/CentOS
$ yum install gnuradio
Archlinux
$ pacman -S gnuradio
Gentoo Linux
$ emerge net-wireless/gnuradio
Suse Linux

On other distributions, simply use the appropriate package management command to install the gnuradio package and 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 launchpad. Be sure to uninstall gnuradio first.

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

$ sudo add-apt-repository ppa:gnuradio/gnuradio-releases

To access the latest from the master branch, add the gnuradio/gnuradio-master ppa (removing other gnuradio ppas if already configured)

$ sudo add-apt-repository ppa:gnuradio/gnuradio-master

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

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

Then, update the apt sources, and install gnuradio

$ sudo apt-get update
$ sudo apt install gnuradio

Modtool on Ubuntu

NOTE: On released builds for Ubuntu 18 (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 workaround this issue:

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

This issue does not appear for Ubuntu 19 and later packages

Fedora COPR Installation

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:

$ sudo dnf copr enable gnuradio/gnuradio-releases 

-- For the latest pull from git master:

$ sudo dnf copr enable gnuradio/gnuradio-master 

2. Install GNU Radio

$ sudo dnf install gnuradio 

Windows

Binary installers are now available for 3.8.0.0, download them here.
If you need to install GNU Radio from source refer to the Windows install guide.

Note: We do not officially support Windows. We do our best to provide installation instructions and work out build bugs on Windows when they are reported and patches received. As new versions of GNU Radio, its dependencies, and Windows itself come out, however, keeping all of them working together is beyond the scope of what the project currently supports. User updates to the above wiki installation instructions are very welcome.

Mac OS X

Refer to the Mac OS X install guide page.

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.

Notes

  • By default GNU Radio will be installed in the /usr/local directory. See notes about -DCMAKE_INSTALL_PREFIX to install it elsewhere.
  • Running and developing out-of-tree modules does not require GNU Radio to be installed from source.
  • If you are using Ubuntu, see UbuntuInstall#Install_the_Pre-Requisites for installing dependencies / pre-requisites.
  • If you want to use GNU Radio with a USRP, you FIRST must clone and install UHD. See [UHD Installation Page] for more info.
  • To install on a Raspberry Pi, see InstallingGRFromSource on Raspberry Pi.

For the GNU Radio Master Branch

Since Volk is no longer considered as a submodule of GNU Radio (GNU Radio commit #80c04479da962d048d41165081b026aafdaa0316 ),
you MUST FIRST 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.

Step 1: Installing Dependencies

Refer to this page for your specific Linux distro to find how to install dependencies. For example, on Ubuntu 18 and 19 use this command.

Step 2: Installing Volk

  • cd
  • git clone https://github.com/gnuradio/volk.git
  • cd volk
  • mkdir build
  • cd build
  • cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../
  • make
  • make test
  • sudo make install

If you're running Linux, then always remember to do the following command after installing any library:

  • sudo ldconfig

Step 3: Installing GNU Radio

Note: 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.

  • make test
  • sudo make install

Again, if you're running Linux, then always remember to do the following command after installing any library:

  • sudo ldconfig

If you encounter "Cannot import gnuradio" error, then go to Finding the Python library to set your PYTHONPATH and LD_LIBRARY_PATH.
After setting these environment variables, you need to do sudo ldconfig again for the Linux dynamic library loader to find the just-installed GNU Radio libraries.

For GNU Radio 3.8 or Earlier

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.

Note: In the following command, change maint-3.8 to some other branch or tag if you want to build a different version of GNU Radio; see tags for tagged releases including pre-releases ("rc"). For branches, it's generally wise to stick with "master" (the default after cloning), and, currently: maint-3.7 or maint-3.8. Here we checkout the maint-3.8 branch, which contains the latest 3.8 release plus any fixes or augmentations to it that will be in the next 3.8 release.

  • git checkout maint-3.8
  • git submodule update --init --recursive
  • mkdir build
  • cd build

Note: In the following command, you can use -DCMAKE_INSTALL_PREFIX=XXX to install GNU Radio into the PREFIX XXX; if not specified, then the PREFIX is /usr/local. See other CMake options in Common cmake flags.

  • cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../
  • make -j3 (e.g. if you want to use 3 CPU cores during the build. To use 8 do -j8, to use 1 leave out the -j flag.)
  • sudo make install

If you're running Linux, then always remember to do the following command after installing any library:

  • sudo ldconfig

Go to Finding the Python library to set your PYTHONPATH and LD_LIBRARY_PATH.
After setting these environment variables, you need to do sudo ldconfig again for the Linux dynamic library loader to find the just-installed GNU Radio libraries.

Common cmake flags

  • -DENABLE_GR_XXX=ON 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.
  • -DCMAKE_INSTALL_PREFIX=XXX Install your stuff to XXX.
  • -DCMAKE_BUILD_TYPE=Debug This causes gcc to add debug symbols to all binaries. Useful for debugging (otherwise, it decreases efficiency!)
  • -DPYTHON_EXECUTABLE=/usr/bin/python{2,3} 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.

For a list of additional cmake flags, as well as minimum versions of dependencies, see [1]

Using PyBOMBS

PyBOMBS is good at building GNU Radio, UHD, and various Out of Tree (OOT) modules from source and then installing into a specified user directory rather than in the system files. PyBOMBS detects the user's Operating System and loads all of the prerequisites in the first stage of the build.

The PyBOMBS documentation is in the PyBOMBS README.

OK, it's installed, what now?

If the installation worked without any trouble, you're ready to use GNU Radio! If you have no idea how to do that, the best place to start is with the Tutorials.

Optionally, you may run volk_profile on your terminal to help libvolk to determine the optimal kernels (may speed up GNU Radio).