InstallingGR: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
m (Update radioconda version and links)
 
(199 intermediate revisions by 25 users not shown)
Line 1: Line 1:
= From Binaries =
<div style="float:right">
 
{{Template:BeginnerTutorials}}
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.
</div>
 
= Quick Start =
In addition to using binaries, GNU Radio can be installed:
{| class="wikitable"
 
|+
# '''[[#From_Source|From source]]''' (for those who want full control)
! Platform !! Method !! GNU Radio version
# '''Using PyBOMBS''' (for those who want multiple versions of GR, or to just avoid having it installed system-wide)
<!-- ======================================================================================================================================================================== -->
# '''Install script''' (this was the popular method many years ago, it's not maintained anymore)
<!-- DEBIANOIDS ============================ -->
# '''Premade Linux Live DVD/USB''' (great for someone without a Linux machine who just wants to try it out)
<!-- ======================================================================================================================================================================== -->
 
|-
== Linux ==
|rowspan=3 style="background-color:#eaecf0;"| [[File:Debian.png|32px|middle|link=]] '''Debian''' ≥12<br>[[File:Ubuntu.png|32px|middle|link=]] '''Ubuntu''' ≥22.04<br>[[File:LinuxMint.png|32px|middle|link=]] '''Linux Mint''' ≥21.1<br>[[File:RaspberryPi.png|32px|middle|link=]]'''Raspberry Pi OS'''<sub>64-bit</sub> ≥2021-10-30
 
|rowspan=3| <syntaxhighlight lang="shell">sudo apt-get install gnuradio</syntaxhighlight>
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.
||<div style="min-width: 25ch; display: flex; justify-content: space-between; flex-flow: row wrap;"><div style="min-width: 12ch; clear: none;">Ubuntu 22.04:</div><div>v3.10.1.1</div></div>
 
|-
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.
||<div style="min-width: 25ch; display: flex; justify-content: space-between; flex-flow: row wrap;"><div style="min-width: 12ch; clear: none;">Debian 12:</div><div>v3.10.5.1</div></div>
 
|-
If the version shipped in your distribution is outdated please contact the corresponding maintainer to update it in the packaging system.
||<div style="min-width: 25ch; display: flex; justify-content: space-between; flex-flow: row wrap;"><div style="min-width: 12ch; clear: none;">Ubuntu 23.10:</div><div>v3.10.7.0</div></div>
 
<!-- ======================================================================================================================================================================== -->
Examples of how to install GNU Radio in various Linux distributions (click each one for more installation details):
<!-- FEDORA ============================ -->
{|class="wikitable" style="margin: auto; width: 90%;"
<!-- ======================================================================================================================================================================== -->
!scope="col"|Distribution
|-
!scope="col"|Command
| rowspan=3 style="background-color:#eaecf0;"| [[File:Fedora.png|32px|middle|link=]] '''Fedora''' ≥38
| rowspan=3 |
<syntaxhighlight lang="shell">
sudo dnf install gnuradio
</syntaxhighlight>
||<div style="min-width: 25ch; display: flex; justify-content: space-between; flex-flow: row wrap;"><div style="min-width: 12ch; clear: none;">Fedora 38:</div><div>v3.10.4.0</div></div>
|-
|-
| [[UbuntuInstall|Debian/Ubuntu and derivates]]
||<div style="min-width: 25ch; display: flex; justify-content: space-between; flex-flow: row wrap;"><div style="min-width: 12ch; clear: none;">Fedora 39:</div><div>v3.10.6.0</div></div>
| <pre>$ apt install gnuradio</pre>
|-
|-
| [[FedoraInstall|Fedora]]
||<div style="min-width: 25ch; display: flex; justify-content: space-between; flex-flow: row wrap;"><div style="min-width: 12ch; clear: none;">Fedora 40:</div><div>v3.10.6.0</div></div>
| <pre>$ dnf install gnuradio</pre>
<!-- ======================================================================================================================================================================== -->
<!-- PPA UBUNTU ============================ -->
<!-- ======================================================================================================================================================================== -->
|-
|-
| RHEL/CentOS
|style="background-color:#eaecf0;"| [[File:Ubuntu.png|32px|middle|link=]] '''Ubuntu''' 20.04<br><small>Consider [https://ubuntu.com/tutorials/upgrading-ubuntu-desktop#1-before-you-start upgrading] your Ubuntu</small><br><br>[[File:Ubuntu.png|32px|middle|link=]] '''Ubuntu''' 22.04
| <pre>$ yum install gnuradio</pre>
||
<syntaxhighlight lang="shell">
sudo add-apt-repository ppa:gnuradio/gnuradio-releases
sudo apt-get update
sudo apt-get install gnuradio python3-packaging
</syntaxhighlight>
| style="text-align: right;" | v3.10.7.0
<!-- ======================================================================================================================================================================== -->
<!-- OTHER LINUXES ========================= -->
<!-- ======================================================================================================================================================================== -->
|-
|-
| [[ArchInstall|Archlinux]]
|style="background-color:#eaecf0;"| [[File:Tux.png|32px|middle|link=]] '''Other Linux Distros'''
| <pre>$ pacman -S gnuradio</pre>
||
<syntaxhighlight lang="shell">
sudo {apt,dnf,yay,emerge,…} install gnuradio
</syntaxhighlight>
| style="text-align: right;" | See [https://repology.org/project/gnuradio/badges this table]
|-
|-
| [[GentooInstall|Gentoo Linux]]
<!-- ======================================================================================================================================================================== -->
| <pre>$ emerge net-wireless/gnuradio</pre>
<!-- WINDOWS ========================= -->
<!-- ======================================================================================================================================================================== -->
|style="background-color:#eaecf0;"| [[File:Windows.png|32px|middle|link=]] '''Windows'''
||
Run [https://github.com/ryanvolz/radioconda/releases/download/2024.01.26/radioconda-2024.01.26-Windows-x86_64.exe Windows Radioconda installer]<br>
and launch "GNU Radio Companion" from the Start menu
| style="text-align: right;" rowspan=3 |v3.10.9.2
<!-- ======================================================================================================================================================================== -->
<!-- Mac OS ========================= -->
<!-- ======================================================================================================================================================================== -->
|-
|-
| [[SuseInstall|Suse Linux]]
|rowspan=2 style="background-color:#eaecf0;"| [[File:MacOS.png|32px|middle|link=]] '''macOS'''
|
| Intel: Run [https://github.com/ryanvolz/radioconda/releases/download/2024.01.26/radioconda-2024.01.26-MacOSX-x86_64.pkg macOS Radioconda installer (x86_64)]
|-
|-
| Apple Silicon: Run [https://github.com/ryanvolz/radioconda/releases/download/2024.01.26/radioconda-2024.01.26-MacOSX-arm64.pkg macOS Radioconda installer (aarch64)]
|}
|}


On other distributions, simply use the appropriate package management command to install the <code>gnuradio</code> 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.
= Other Installation Methods =


== Windows ==
== Platform-specific guides ==


Binary installers are now available for 3.7.10, download them [http://www.gcndevelopment.com/gnuradio/downloads.htm here].<br />
* [[LinuxInstall|Linux install guide]]
If you need to install GNU Radio from source refer to the [[WindowsInstall|Windows install guide]].
* [[WindowsInstall|Windows install guide]]
* [[MacInstall|Mac OS X 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.
== Cross-platform guides ==


== Mac OS X ==
* [[CondaInstall|Conda install guide]]
* [https://github.com/gnuradio/pybombs#pybombs PyBOMBS] - Note: We are no longer including PyBOMBS as a recommended method of installing GNU Radio, unless you want to play around with old versions (e.g. GR 3.7, 3.8, and OOTs of matching version)


Refer to the [[MacInstall|Mac OS X install guide page]].
== VMs and Live Images ==
Over the years a number of Live Images and VMs have been created.  There are currently no official versions but here are some current options:
*[https://github.com/bastibl/instant-gnuradio Instant GNU Radio] A customizable, programmatically generated VM and live environment for GNU Radio.
*[[UbuntuVM]] An Ubuntu 20.04 virtual machine image with GNU Radio 3.8.2.0, Fosphor, GQRX, and several other useful pieces of software. (Created using Instant GNU Radio)


= From Source =
= OK, it's installed, what now? =


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.
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]].
 
Notes:
 
* If you want to use GNU Radio with a USRP, install UHD package or follow the [https://files.ettus.com/manual/page_build_guide.html 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 http://git.gnuradio.org/git/gnuradio.git
cd gnuradio
mkdir build
cd build
cmake ../
make
make test
sudo make install
 
Common cmake flags:
 
* <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_INSTALL_PREFIX=XXX</code> Install your stuff to XXX.
* <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.
 
For a list of additional cmake flags, as well as minimum versions of dependencies, see [https://www.gnuradio.org/doc/doxygen/build_guide.html]
 
= 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").
 
= Using the Old Build Script =
 
(Note: Currently does not support Ubuntu 18.04)
 
The [https://www.sbrac.org/files/build-gnuradio <code>build-gnuradio</code>] is an install script for recent Fedora and Ubuntu systems provided by Marcus Leech.
 
The <code>build-gnuradio</code> script has a number of options that we can use to install different versions of GNU Radio. Just running <code>build-gnuradio</code> with no additional options, it fetches/builds the latest released version from the 3.7 series.
 
Passing the flag <code>-m</code> will fetch and build master/HEAD.
 
Passing the flag <code>-o</code> will fetch and build the latest in the old 3.6 series.
 
For the impatient: open a terminal window, move to the directory you would like the source files to be stored (e.g. 'cd src/'), remove old build-gnuradio file, and run this command:
 
<pre>$ wget https://www.sbrac.org/files/build-gnuradio &amp;&amp; chmod a+x build-gnuradio &amp;&amp; ./build-gnuradio</pre>
This downloads the installer (<code>build-gnuradio</code>) and makes it executable. It then downloads and installs all dependencies, downloads both UHD and GNU Radio from Git (which means it will automatically install the latest version from the 'master' branch), runs the make process, and installs it on your system (a lot of this is done silently, so if there's a lot to do for the script, don't be surprised if it doesn't say anything for a while). In most cases, simply running the script will do all you need to get a running GNU Radio system built from source. Also, you will have all the source code lying on your hard disk and therefore available for future modifications. It combines the flexibility of installing from source with the ease of using binaries and is recommended for most users of Ubuntu and Fedora.
 
Thanks to Marcus Leech for putting this together and hosting it.
 
= 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 [[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 21:34, 26 January 2024

Beginner Tutorials

Introducing GNU Radio

  1. What is GNU Radio?
  2. Installing GNU Radio
  3. Your First Flowgraph

Flowgraph Fundamentals

  1. Python Variables in GRC
  2. Variables in Flowgraphs
  3. Runtime Updating Variables
  4. Signal Data Types
  5. Converting Data Types
  6. Packing Bits
  7. Streams and Vectors
  8. Hier Blocks and Parameters

Creating and Modifying Python Blocks

  1. Creating Your First Block
  2. Python Block With Vectors
  3. Python Block Message Passing
  4. Python Block Tags

DSP Blocks

  1. Low Pass Filter Example
  2. Designing Filter Taps
  3. Sample Rate Change

Quick Start

Platform Method GNU Radio version
Debian.png Debian ≥12
Ubuntu.png Ubuntu ≥22.04
LinuxMint.png Linux Mint ≥21.1
RaspberryPi.pngRaspberry Pi OS64-bit ≥2021-10-30
sudo apt-get install gnuradio
Ubuntu 22.04:
v3.10.1.1
Debian 12:
v3.10.5.1
Ubuntu 23.10:
v3.10.7.0
Fedora.png Fedora ≥38
sudo dnf install gnuradio
Fedora 38:
v3.10.4.0
Fedora 39:
v3.10.6.0
Fedora 40:
v3.10.6.0
Ubuntu.png Ubuntu 20.04
Consider upgrading your Ubuntu

Ubuntu.png Ubuntu 22.04
sudo add-apt-repository ppa:gnuradio/gnuradio-releases
sudo apt-get update
sudo apt-get install gnuradio python3-packaging
v3.10.7.0
Tux.png Other Linux Distros
sudo {apt,dnf,yay,emerge,…} install gnuradio
See this table
Windows.png Windows

Run Windows Radioconda installer
and launch "GNU Radio Companion" from the Start menu

v3.10.9.2
MacOS.png macOS Intel: Run macOS Radioconda installer (x86_64)
Apple Silicon: Run macOS Radioconda installer (aarch64)

Other Installation Methods

Platform-specific guides

Cross-platform guides

  • Conda install guide
  • PyBOMBS - Note: We are no longer including PyBOMBS as a recommended method of installing GNU Radio, unless you want to play around with old versions (e.g. GR 3.7, 3.8, and OOTs of matching version)

VMs and Live Images

Over the years a number of Live Images and VMs have been created. There are currently no official versions but here are some current options:

  • Instant GNU Radio A customizable, programmatically generated VM and live environment for GNU Radio.
  • UbuntuVM An Ubuntu 20.04 virtual machine image with GNU Radio 3.8.2.0, Fosphor, GQRX, and several other useful pieces of software. (Created using Instant GNU Radio)

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).