InstallingGR: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
(Fix git clone URI)
Line 70: Line 70:


  (doesn't matter which directory you start in, can be home, or /tmp, or ~/Downloads)
  (doesn't matter which directory you start in, can be home, or /tmp, or ~/Downloads)
  git clone --recursive http://git.gnuradio.org/git/gnuradio.git
  git clone --recursive https://github.com/gnuradio/gnuradio.git
  cd gnuradio
  cd gnuradio
  mkdir build
  mkdir build

Revision as of 11:23, 28 June 2019

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, but are lazy)
  3. Premade Linux Live DVD/USB (great for someone without a Linux machine who just wants to try it out)

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.

Windows

Binary installers are now available for 3.7.10, 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 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:

  • If you want to use GNU Radio with a USRP, install UHD package or follow the UHD Manual Build Guide.
  • By default GNU Radio will be installed under /usr/local - for installing in a custom directory you might as well just use PyBOMBS since it creates the correct directory structure and setup_env.sh file for you.
  • Running and developing out-of-tree modules does not require GNU Radio to be installed from source.

For how to install dependencies, if you are using Ubuntu see UbuntuInstall.

To install system wide:

(doesn't matter which directory you start in, can be home, or /tmp, or ~/Downloads)
git clone --recursive https://github.com/gnuradio/gnuradio.git
cd gnuradio
mkdir build
cd build
cmake ../
make
make test
sudo make install

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 UHD and GNU Radio from source, and installing into a specific isolated directory. It creates the proper directory structure and setup_env.sh file for you. To install the latest stable version of GNU Radio and UHD, run the following:

sudo apt-get install python-pip
sudo pip install pybombs
pybombs auto-config
pybombs recipes add-defaults
pybombs prefix init ~/gnuradio -R gnuradio-default
(wait a while) 
. ~/gnuradio/setup_env.sh
gnuradio-companion

This will clone and install uhd and gnuradio (i.e., recipe "gnuradio-default") into a directory called "gnuradio" in your home directory (you can use a different name, like "prefix" or "target").

Bootable DVD with GNU Radio Pre-installed

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.

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 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, Corgan Labs offers a 3-day, hands-on training class that can be held at your own location.