InstallingGR: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
m (Update installation method for Fedora/Add CentOS/RHEL)
m (Update radioconda version and links)
 
(224 intermediate revisions by 26 users not shown)
Line 1: Line 1:
= Installing GNU Radio =
<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 =
== Linux ==
{| class="wikitable"
 
|+
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.
! Platform !! Method !! GNU Radio version
 
<!-- ======================================================================================================================================================================== -->
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.
<!-- DEBIANOIDS ============================ -->
 
<!-- ======================================================================================================================================================================== -->
If the version shipped in your distribution is outdated please contact the corresponding maintainer to update it in the packaging system.
|-
 
|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
Examples of how to install GNU Radio in various Linux distributions:
|rowspan=3| <syntaxhighlight lang="shell">sudo apt-get install gnuradio</syntaxhighlight>
{|class="wikitable" style="margin: auto; width: 90%;"
||<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>
!scope="col"|Distribution
|-
!scope="col"|Command
||<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>
|-
||<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>
<!-- ======================================================================================================================================================================== -->
<!-- FEDORA ============================ -->
<!-- ======================================================================================================================================================================== -->
|-
| 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>
|-
||<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>
|-
|-
| 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 40:</div><div>v3.10.6.0</div></div>
| <pre>$ apt install gnuradio</pre>
<!-- ======================================================================================================================================================================== -->
<!-- PPA UBUNTU ============================ -->
<!-- ======================================================================================================================================================================== -->
|-
|-
| Fedora
|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>$ dnf 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 ========================= -->
<!-- ======================================================================================================================================================================== -->
|-
|-
| RHEL/CentOS
|style="background-color:#eaecf0;"| [[File:Tux.png|32px|middle|link=]] '''Other Linux Distros'''
| <pre>$ yum install 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]
|-
|-
| Archlinux
<!-- ======================================================================================================================================================================== -->
| <pre>$ pacman -S 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 ========================= -->
<!-- ======================================================================================================================================================================== -->
|-
|-
| Gentoo Linux
|rowspan=2 style="background-color:#eaecf0;"| [[File:MacOS.png|32px|middle|link=]] '''macOS'''
| <pre>$ emerge net-wireless/gnuradio</pre>
| 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.
= Other Installation Methods =
 
If you need newer versions or have different platforms, see the [[BinaryPackages|guide on binary packages]]. We have our own up-to-date versions of GNU Radio for Ubuntu and Fedora, and as well as different platforms such as Windows there.
 
== Windows ==
 
Binary installers are now available for 3.7.9, download them [http://www.gcndevelopment.com/gnuradio/downloads.htm here].<br />
If you need to install GNU Radio from source refer to the [[WindowsInstall|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 [[MacInstall|Mac OS X install guide page]].


== Bootable DVD with GNU Radio pre-installed ==
== Platform-specific guides ==


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.
* [[LinuxInstall|Linux install guide]]
* [[WindowsInstall|Windows install guide]]
* [[MacInstall|Mac OS X install guide]]


== From Source ==
== Cross-platform guides ==


Binary installation should be sufficient for most users, and certainly anyone who is new to GNU Radio. However, if you have special requirements, or the binary packages are not working for you, you may want to install GNU Radio from source.
* [[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)


Note that running and developing out-of-tree modules does not require GNU Radio to be installed from source. Of course, if you want to hack on GNU Radio itself, you need a source build.
== 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)


See the [[InstallingGRFromSource|Installing From Source]] wiki page for more details.
= OK, it's installed, what now? =


== 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]].


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]]

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