Talk:InstallingGR

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.
• 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, install the UHD package or follow the UHD Manual Build Guide.
• To install on a Raspberry Pi, see InstallingGRFromSource on Raspberry Pi.

To install system wide

It is highly recommended that you start in your home directory.

• cd ~/
• git clone --recursive https://github.com/gnuradio/gnuradio.git
• cd gnuradio
• git checkout maint-3.8 # change `maint-3.8` if you want to use a different version; see releases
• mkdir build
• cd build
• Note: Use -DCMAKE_INSTALL_PREFIX=XXX in the following cmake command to install GNU Radio into the PREFIX XXX; if not specified, then the PREFIX is /usr/local.
  
• cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../ # see other options below
• Note: If your computer's CPU has multiple cores, you can use the -j# option for make in the following command to speed compilation, e.g., make -j3; specify one less than the number of CPU cores so the system does not appear to 'freeze'.
  
• make
• make test
• sudo make install
• sudo ldconfig

• Use your prefix in place of {prefix} in the following commands, put them in your ~/.bashrc or ~/.profile or ~/.bash_aliases file and restart your terminal.

Setting PYTHONPATH

Linux-based systems and MacOSX / macOS

- For MacOSX / macOS, most Debian / Ubuntu (and derivative) systems, and most other 32-bit Unix/Linux systems, use:

export PYTHONPATH={prefix}/lib/python3/dist-packages:{prefix}/lib/python3/site-packages:$PYTHONPATH

- For other 64-bit systems, use:

export PYTHONPATH={prefix}/lib64/python3/site-packages:$PYTHONPATH

Setting LD_LIBRARY_PATH

Linux-based systems

- For most 32-bit systems and most Debian / Ubuntu (and derivative) systems, use:

export LD_LIBRARY_PATH={prefix}/lib:$LD_LIBRARY_PATH

- For other 64-bit systems, use:

export LD_LIBRARY_PATH={prefix}/lib64:$LD_LIBRARY_PATH

MacOSX / macOS

On MacOSX / macOS, the library search path is set primarily by the environment variable DYLD_LIBRARY_PATH. Because of the way the OSX dynamic library loader works, this variable works differently than on Linux. Its primary purpose is in finding libraries in a local path, such as when testing software before installing it, or inside an application. We strongly recommend against setting this variable globally.

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]