User:Muaddib: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(Replaced content with "-Push-Button I/Q Field Recorder -I/Q File Rolodex for Fast Post-Analysis -Slow Motion I/Q File Playback")
Tag: Replaced
Line 1: Line 1:
<div style="float:right">
-Push-Button I/Q Field Recorder
{{Template:BeginnerTutorials}}
</div>


{| class="wikitable"
-I/Q File Rolodex for Fast Post-Analysis
|+ Install Quickstart<br>(Refer to the rest of this page for more OS and installation options)
! Linux
||
# [https://releases.ubuntu.com/20.04/ Install Ubuntu 20.04] (either as a VM or natively)
# <code>sudo add-apt-repository ppa:gnuradio/gnuradio-releases-3.9</code>
# <code>sudo apt-get update</code>
# <code>sudo apt-get install gnuradio</code>
||v3.9.5
|-
! Windows
||
# Install the latest [https://github.com/ryanvolz/radioconda/releases Radioconda installer]
# Launch "GNU Radio Companion" from the Start menu
||v3.10.0
|-
! macOS
||
# [https://brew.sh/ Install Homebrew]
# <code>brew install gnuradio</code>
||v3.9.3
|}


 
-Slow Motion I/Q File Playback
= Types of Installation Methods =
 
The recommended way to install GNU Radio on most platforms is using already available binary packages. Find your platform below in the [[#From_Binaries|From Binaries]] section for instructions on how to get GNU Radio through your regular package manager (e.g. [[#Ubuntu_PPA_Installation|Ubuntu PPA Installation]]), or visit the [[CondaInstall|Conda Installation]] page for instructions on how to use the Conda package manager to install GNU Radio on any Linux distribution, macOS, or Windows. For some platforms there are no binaries provided by available package managers or the GNU Radio project. In these cases please contact the maintainer of the package manager or the GNU Radio project to find a sensible way to provide binaries for your platform.
 
GNU Radio can be installed with these 3 methods:
# '''[[#From_Binaries|From Binaries]]''' (recommended for beginners)
# '''[[#From_Source|From source]]''' (for those who want full control)
# '''[[#Using_PyBOMBS|Using PyBOMBS]]''' (for those who want GNURadio built from source in custom prefix)
 
'''NOTES'''
# If you already know that you will be using a specific Out-of-Tree (OOT) module(s), find out which version(s) of GNURadio the OOT supports before installing GNURadio. There is typically a lag in the porting of maintained OOT's to the latest GNURadio version. For most maintained OOT's the supported version can be found on the OOT's repository under the 'branch' or 'tags' section, usually denoted with <code>maint-3.x</code> or <code>gr3.x</code>. If you wish to port an existing OOT to a newer version of GNURadio than it currently supports, read the Module Porting Guides [[Main Page#Documentation|here]].
# If you intend to modify existing In-Tree Blocks or the GNURadio Source Code, you will need to install '''[[#From_Source|from source]]'''
# If you want to install multiple versions of GNURadio on the same machine, PyBOMBS enables multiple installations using custom prefixes (environments). See [[#Using_PyBOMBS|Using PyBOMBS]]
 
= From Binaries =
 
== Linux ==
 
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.
 
The development of GNU Radio 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 a new issue.
 
If the version shipped in your distribution is outdated please contact the corresponding maintainer to update it in the packaging system.
 
Here are examples of how to install GNU Radio in various Linux distributions.
 
{|class="wikitable" style="margin: auto; width: 90%;"
!scope="col"|Distribution
!scope="col"|Command
|-
| Debian/Ubuntu and derivates
| <pre># apt install gnuradio</pre>
|-
| Fedora
| <pre># dnf install gnuradio</pre>
|-
| RHEL/CentOS
| <pre># yum install gnuradio</pre>
|-
| Archlinux
| <pre># pacman -S gnuradio</pre>
|-
| Gentoo Linux
| <pre># emerge net-wireless/gnuradio</pre>
|-
|}
 
On other distributions, simply use the appropriate package management command to install the <code>gnuradio</code> package and then please 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 [https://launchpad.net/~gnuradio launchpad].  Be sure to uninstall any previously installed versions of gnuradio first.
 
To access the current released version (3.10), add the gnuradio/gnuradio-releases ppa (removing other gnuradio ppas if already configured)
 
<pre>$ sudo add-apt-repository ppa:gnuradio/gnuradio-releases</pre>
 
To access the 3.9 released version, add the gnuradio/gnuradio-releases-3.9 ppa (removing other gnuradio ppas if already configured)
 
<pre>$ sudo add-apt-repository ppa:gnuradio/gnuradio-releases-3.9</pre>
 
To access the 3.8 released version, add the gnuradio/gnuradio-releases-3.8 ppa (removing other gnuradio ppas if already configured)
 
<pre>$ sudo add-apt-repository ppa:gnuradio/gnuradio-releases-3.8</pre>
 
To access the 3.7 released version (legacy), add the gnuradio/gnuradio-releases-3.7 ppa (removing other gnuradio ppas if already configured)
 
<pre>$ sudo add-apt-repository ppa:gnuradio/gnuradio-releases-3.7</pre>
 
Then, update the apt sources, and install gnuradio
<pre>$ sudo apt-get update</pre>
<pre>$ sudo apt install gnuradio</pre>
 
'''Attention:''' Do '''NOT''' try to install further packages like `gr-osmosdr` via Ubuntu's package management (i.e. using "apt"). Ubuntu will try to install a potentially incompatible version and your system will be in an undefined state.
 
 
'''Note on 3.10 packaging dependency'''
For some distributions you may need to install the python module 'packaging' using pip (which may also need to be installed).
 
$ sudo apt install python3-pip
$ pip install packaging
 
==== Modtool on Ubuntu ====
NOTE: On released builds for Ubuntu 18.04 (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 work around 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 ===
 
**NOTE: FEDORA COPR not currently maintained**
 
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>
 
=== Raspberry Pi ===
 
There is a pre-built 32 bit SDR flavored Raspberry Pi OS distro, [https://github.com/luigifcruz/pisdr-image PiSDR] that includes GNU Radio and other SDR utilities.  There are also instructions for [[InstallingGRFromSource_on_Raspberry_Pi]].
 
== Windows ==
 
See the [[CondaInstall|Conda install guide]] or [https://github.com/ryanvolz/radioconda radioconda] to install GNU Radio 3.8 or newer on Windows.<br />
 
If you need to install GNU Radio from source refer to the [[WindowsInstall|Windows install guide]].
 
'''Note''': GNU Radio support on Windows is improving significantly but remains less tested and there are known problems and even significant bugs which affect regular usage of GNU Radio Companion. Please report bugs on the [https://github.com/gnuradio/gnuradio/issues GitHub Issues page] and if you have Windows development experience please consider investigating some of the [https://github.com/gnuradio/gnuradio/issues?q=is%3Aopen+is%3Aissue+label%3AWindows known issues].
 
== Mac OS X ==
 
Refer to the [[MacInstall|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 <code>/usr/local</code> directory.  See notes about [[InstallingGR#Common_cmake_flags|-DCMAKE_INSTALL_PREFIX]] to install it elsewhere.
* Running and developing out-of-tree modules does not require GNU Radio to be installed from source.
* <b>If you want to use GNU Radio with a USRP, you FIRST must clone and install UHD</b>. See the [https://kb.ettus.com/Building_and_Installing_the_USRP_Open-Source_Toolchain_(UHD_and_GNU_Radio)_on_Linux UHD Installation Page] for more info, <b>OR</b> follow the instructions in [[InstallingGRFromSource_on_Raspberry_Pi#Load_prerequisites|Install UHD from source]].
* To install on a Raspberry Pi, see [[InstallingGRFromSource on Raspberry Pi]].
* To build from source from within a conda environment, see [[CondaInstall#Building GNU Radio from source within a conda environment|the conda install guide]].
 
==Dependencies==
For example, on Ubuntu 20.04 [[UbuntuInstall#Focal_Fossa_.2820.04.29_through_Impish_Indri_.2821.10.29|use this command]].
 
{|class="wikitable" style="margin: auto; width: 90%;"
!scope="col"|Distribution
|-
| [[UbuntuInstall|Debian/Ubuntu and derivates]]
|-
| [[FedoraInstall|Fedora]]
|-
| RHEL/CentOS
|-
| [[ArchInstall|Archlinux]]
|-
| [[GentooInstall|Gentoo Linux]]
|-
| [[SuseInstall|Suse Linux]]
|
|-
|}
 
=== For GNU Radio 3.10, 3.9, and Main Branch ===
 
This section describes how to install GNU Radio 3.10, 3.9, and the Main branch from source code.
 
==== Installing Dependencies ====
 
Refer to the table above to find your specific Linux distro and how to install dependencies.
 
==== Installing Volk ====
 
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.
 
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.
 
* <code>cd</code>
* <code>git clone --recursive https://github.com/gnuradio/volk.git</code>
* <code>cd volk</code>
* <code>mkdir build</code>
* <code>cd build</code>
<b>Note:</b> In the following command, you can add <code>-DCMAKE_INSTALL_PREFIX=XXX</code> to install Volk 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</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>
 
==== Installing GNU Radio ====
 
* <code>cd</code>
* <code>git clone https://github.com/gnuradio/gnuradio.git</code>
* <code>cd gnuradio</code>
<b>Note:</b> If you want to build the <code>maint-3.10</code> or <code>maint-3.9</code> branch rather than the default <code>main</code> branch, enter:
<code>git checkout maint-3.10</code> and then<br>
* <code>mkdir build</code>
* <code>cd build</code>
<b>Note:</b> In the following command, you can add <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.)
<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>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>
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.<br>
If you have installed in a custom path with <code>-DCMAKE_INSTALL_PREFIX=XXX</code>, you will need to add that path to $PATH in order to find gnuradio-companion.
 
=== For GNU Radio 3.8 or Earlier ===
 
==== Installing Dependencies ====
 
Refer to [[Installing Dependencies|this page for your specific Linux distro]] to find how to install dependencies.  For example, on Ubuntu 20.04 [[UbuntuInstall#Focal_Fossa_.2820.04.29_through_Impish_Indri_.2821.10.29|use this command]].
 
==== Installing GNU Radio ====
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 add <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>
 
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.<br>
If you have installed in a custom path with <code>-DCMAKE_INSTALL_PREFIX=XXX</code>, you will need to add that path to $PATH in order to find gnuradio-companion.
 
==== For Ubuntu 18.04 ====
 
An easy way to install GNU Radio 3.8 on many Ubuntu systems is to use the following commands (note that this skips the setup for UHD hardware):
 
* <code>sudo apt install git cmake g++ libboost-all-dev libgmp-dev swig python3-numpy python3-mako python3-sphinx python3-lxml doxygen libfftw3-dev libsdl1.2-dev libgsl-dev libqwt-qt5-dev libqt5opengl5-dev python3-pyqt5 liblog4cpp5-dev libzmq3-dev python3-yaml python3-click python3-click-plugins python3-zmq python3-scipy python3-pip python3-gi-cairo</code>
* <code>pip3 install git+https://github.com/pyqtgraph/pyqtgraph@develop</code>
* <code>pip3 install numpy scipy</code>
* <code>echo 'export PYTHONPATH=/usr/local/lib/python3/dist-packages:usr/local/lib/python2.7/site-packages:$PYTHONPATH' >> ~/.bashrc</code>
* <code>echo 'export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH' >> ~/.bashrc</code>
* <code>echo 'export PYTHONPATH=/usr/local/lib/python3/dist-packages:usr/local/lib/python2.7/site-packages:$PYTHONPATH' >> ~/.profile</code>
* <code>echo 'export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH' >> ~/.profile</code>
* <code>cd ~/</code>
* <code>git clone --recursive https://github.com/gnuradio/gnuradio</code>
* <code>cd gnuradio</code>
* <code>git checkout maint-3.8</code>
* <code>mkdir build</code>
* <code>cd build</code>
* <code>git pull --recurse-submodules=on</code>
* <code>git submodule update --init</code>
* <code>cmake -DENABLE_GR_UHD=OFF ..</code>
* <code>make -j $(nproc --all)</code>
* <code>sudo make install</code>
* <code>sudo ldconfig</code>
 
Once this is done, reboot your computer and GNU Radio should be all set for you.
 
== 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.
<p>For a list of additional cmake flags, as well as minimum versions of dependencies, see [https://www.gnuradio.org/doc/doxygen/build_guide.html]</p>
 
= 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 [https://github.com/gnuradio/pybombs#pybombs README].
 
= 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)
 
 
= 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 <code>volk_profile</code> on your terminal to help libvolk to determine the optimal kernels (may speed up GNU Radio).
 
[[Category:Installation]]
[[Category:Guide]]

Revision as of 01:19, 20 February 2022

-Push-Button I/Q Field Recorder

-I/Q File Rolodex for Fast Post-Analysis

-Slow Motion I/Q File Playback

Retrieved from "https://wiki.gnuradio.org/index.php?title=User:Muaddib&oldid=11469"