Talk:InstallingGR: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(Undo revision 6626 by Duggabe (talk))
(Undo revision 6625 by Duggabe (talk))
Line 1: Line 1:
= From Source =
= DRAFT revisions to "To install system wide" =


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.
== To install system wide ==
 
== 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 [https://files.ettus.com/manual/page_build_guide.html UHD Manual Build Guide].
* To install on a Raspberry Pi, see [[InstallingGRFromSource on Raspberry Pi]].


== To install system wide ==
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.


<p><b>It is highly recommended that you start in your home directory.</b></p>
* <code>cd</code>
* <code>cd ~/</code>
* <code>git clone --recursive https://github.com/gnuradio/gnuradio.git</code>
* <code>git clone --recursive https://github.com/gnuradio/gnuradio.git</code>
* <code>cd gnuradio</code>
* <code>cd gnuradio</code>
* <code>git checkout maint-3.8</code> # change `maint-3.8` if you want to use a different version; see [https://github.com/gnuradio/gnuradio/releases releases]
* <code>git checkout maint-3.8</code> # change <code>maint-3.8</code> if you want to use a different version; see [https://github.com/gnuradio/gnuradio/releases releases]
* <code>mkdir build</code>
* <code>mkdir build</code>
* <code>cd build</code>
* <code>cd build</code>
* Note: Use <code>-DCMAKE_INSTALL_PREFIX=XXX</code> in the following <code>cmake</code> command to install GNU Radio into the PREFIX <code>XXX</code>; if not specified, then the PREFIX is <code>/usr/local</code>.<br>
* <code>cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ..</code>
* <code>cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ../</code> # see other options below
Notes:<br>
* Note: If your computer's CPU has multiple cores, you can use the <code>-j#</code> option for <code>make</code> in the following command to speed compilation, e.g., <code>make -j3</code>; specify one less than the number of CPU cores so the system does not appear to 'freeze'.<br>
1) If your computer's CPU has multiple cores, you can use the <code>-j#</code> option for <code>make</code> to speed compilation, e.g., <code>make -j3</code>; specify one less than the number of CPU cores so the system does not appear to 'freeze'.<br>
2) Use <code>-DCMAKE_INSTALL_PREFIX=XXX</code> in the <code>cmake</code> command to install GNU Radio into the PREFIX <code>XXX</code>; if not specified then the PREFIX is <code>/usr/local</code>.
 
* <code>make</code>
* <code>make</code>
* <code>make test</code>
* <code>make test</code>
* <code>sudo make install</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>
* <code>sudo ldconfig</code>


* Use your prefix in place of <code>{prefix}</code> in the following commands, put them in your <code>~/.bashrc</code> or <code>~/.profile</code> or  <code>~/.bash_aliases</code> file and restart your terminal.
Go to [[ModuleNotFoundError#Setting_PYTHONPATH|Setting PYTHONPATH]] to set your PYTHONPATH and LD_LIBRARY_PATH. After setting these environment variables, you might need to redo this last command for the Linux dynamic library loader to find the just-installed GNU Radio libraries.
 
== 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:
<pre>
export PYTHONPATH={prefix}/lib/python3/dist-packages:{prefix}/lib/python3/site-packages:$PYTHONPATH
</pre>
 
-  For other 64-bit systems, use:
<pre>
export PYTHONPATH={prefix}/lib64/python3/site-packages:$PYTHONPATH
</pre>
 
== Setting LD_LIBRARY_PATH ==
 
=== Linux-based systems ===
-  For most 32-bit systems and most Debian / Ubuntu (and derivative) systems, use:
<pre>
export LD_LIBRARY_PATH={prefix}/lib:$LD_LIBRARY_PATH
</pre>
 
-  For other 64-bit systems, use:
<pre>
export LD_LIBRARY_PATH={prefix}/lib64:$LD_LIBRARY_PATH
</pre>
 
=== 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. <b>We strongly recommend against setting this variable globally.
 
== 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>

Revision as of 14:11, 28 January 2020

DRAFT revisions to "To install system wide"

To install system wide

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.

  • 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
  • cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ..

Notes:
1) If your computer's CPU has multiple cores, you can use the -j# option for make to speed compilation, e.g., make -j3; specify one less than the number of CPU cores so the system does not appear to 'freeze'.
2) Use -DCMAKE_INSTALL_PREFIX=XXX in the cmake command to install GNU Radio into the PREFIX XXX; if not specified then the PREFIX is /usr/local.

  • make
  • make test
  • sudo make install

If you're running Linux, then always remember to do the following command after installing any library:

  • sudo ldconfig

Go to Setting PYTHONPATH to set your PYTHONPATH and LD_LIBRARY_PATH. After setting these environment variables, you might need to redo this last command for the Linux dynamic library loader to find the just-installed GNU Radio libraries.

Retrieved from "https://wiki.gnuradio.org/index.php?title=Talk:InstallingGR&oldid=6635"