Editing MacInstall

= Installing GNU Radio on MacOS X / macOS =

GNU Radio has been compiled and installed on OSX 10.4 (&quot;Tiger&quot;) through 10.15 (&quot;Catalina&quot;) running any compatible version of Xcode on all recent and many older Macs -- whether Intel or PowerPC/PPC. There is very little support for getting the background libraries and applications installed on OSX 10.5 or earlier, nor 32-bit Intel or any PPC, though all of these should be possible. Primary support is for 64-bit Intel-based Macs running OSX 10.6 or newer.

== Prerequisite: X11.app, recommended via XQuartz ==

Running almost any GNU Radio graphical interface (GUI) will require [http://xquartz.macosforge.org/landing/ downloading and installing X11/XQuartz] first. Through OSX 10.8, Apple provided a means to install X11.app, but XQuartz has always been more up to date and hence is recommended for use. Staring in OSX 10.9, Apple no longer provided a full working version of X11.app. Hence, just use XQuartz from the get-go. Note that unless you experiment with using the Quartz interface to various graphical toolkits (e.g., GTK), you ''must'' use X11.app as the terminal interface for GNU Radio GUI applications including GRC, the GNU Radio Companion.

== A note about DYLD_LIBRARY_PATH and other DYLD environment variables ==

On OSX, the library search path is set primarily by the environment variable <code>DYLD_LIBRARY_PATH</code> (and the few other <code>DYLD_*</code> variables). Because of the way the OSX dynamic library loader works, this variable works differently than the <code>LD_LIBRARY_PATH</code> on Linux. Its primary purpose is in finding libraries in a local path, such as when testing software before installing it (we use it in <code>make test</code> in GR), or inside an application. <b>We strongly recommend against setting this variable globally as is typically done with Linux and <code>LD_LIBRARY_PATH</code>.</b> Setting any <code>DYLD_*</code> environment variable for general use is ''highly'' discouraged, because doing so, in our experience, leads to problems down the road that are very difficult to diagnose. OSX provides robust means for correcting DYLD-based issues even after dependencies are installed.

== Via MacPorts (recommended) ==

If you do not already have MacPorts installed, you will need to [https://www.macports.org/install.php install it] first. Make sure to follow the [https://guide.macports.org/chunked/installing.shell.html MacPorts shell environment changes] needed such that MacPorts installed executables are found before all others. These are the only changes to the shell environment needed to execute any MacPorts-installed executable!

Once MacPorts is installed, GNU Radio and all of its dependencies can be installed by executing

 sudo port install gnuradio

This method of installing GNU Radio is actively kept up to date by [http://lists.gnu.org/archive/html/discuss-gnuradio/2013-08/msg00372.html Michael Dickens], and hence is the recommended way to install GNU Radio on Mac OS X.

The latest developments in GNU Radio can be installed via

<pre>sudo port install gnuradio-devel</pre>
Please note that the <code>gnuradio-devel</code> port, while tested for basic compilation and functionality, is not a formal release and hence should be considered beta software which might contain bugs or major issues.

== Other Package Managers ==

[http://fink.sourceforge.net/ Fink] and [http://brew.sh HomeBrew] might provide a simple way to install GNU Radio; they are untested (as of early 2020).

== From Source ==

=== Background Dependencies ===

There are a number of background libraries and applications that must be installed from source or binary in order to compile or execute GNU Radio. These can be obtained by using [http://www.macports.org/ MacPorts], [http://fink.sourceforge.net/ Fink], [http://brew.sh HomeBrew], and/or from source / scratch. MacPorts tends to be more up-to-date with respect to new releases, which can be both a blessing and a curse since sometimes new released are untested and result in build or runtime errors. MacPorts, HomeBrew, and Fink offer thousands of ready-to-install libraries and applications, and hence they are highly recommended to use instead of installing from source / scratch.

NOTE: We highly recommended that you install all dependencies via the same package manager! When issues arise, they are much easier to track down, and your updating to newer versions is also much easier.

Many GNU Radio developers first install GNU Radio using MacPorts in order to get all of the necessary background dependencies installed, then remove just GNU Radio via

<pre>sudo port uninstall gnuradio</pre>

=== Compiling GNU Radio from Source ===

Installing GNU Radio from source follows the standard [[InstallingGR#From_Source|build guide]], with changes to the <code>cmake</code> command such that it always finds the correct version of Python, uses the desired compiler, and finds Sphinx to build documentation.

For example, using Xcode 5 or later's Apple GCC (llvm flavor), MacPorts installed into <code>/opt/local</code> (the default), and for Python 2.7 (as installed by MacPorts), issue the following commands from within the GNU Radio source directory:

<pre>
$ mkdir build
$ cd build
$ CC=/usr/bin/llvm-gcc CXX=/usr/bin/llvm-g++ cmake \
-DPYTHON_EXECUTABLE=/opt/local/bin/python2.7 \
-DPYTHON_INCLUDE_DIR=/opt/local/Library/Frameworks/Python.framework/Versions/2.7/Headers \
-DPYTHON_LIBRARY=/opt/local/Library/Frameworks/Python.framework/Versions/2.7/Python \
-DSPHINX_EXECUTABLE=/opt/local/bin/rst2html-2.7.py \
-DGR_PYTHON_DIR=/opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages \
..
$ make
</pre>

If <code>make</code> succeeds, then you can test the build for errors via

<code>$ make test</code>

To install the build, issue

<code>$ sudo make install</code>

Selecting another compiler is as simple as changing the CC and CXX pre-arguments to the <code>cmake</code> command. Note that all of the <code>-DPYTHON*</code> defines must point to the same install of Python, otherwise runtime errors are likely to occur. <code>GR_PYTHON_DIR</code> sets the location into which GNU Radio's Python and SWIG files are to be installed.

By default, the location where cmake built projects will be installed is <code>/usr/local</code>. To change this location, add <code>-DCMAKE_INSTALL_PREFIX=/path/to/new/location</code> to the cmake command line, substituting in the actual desired path for <code>/path/to/new/location</code>. For example, to install into <code>/opt/local</code>, use <code>-DCMAKE_INSTALL_PREFIX=/opt/local</code>. Although we do not generally recommend installing into the same location as some other package manager does, this technique can be useful for debugging purposes; just remember to <code>sudo make uninstall</code> before installing via the owning package manager.

== A note about GR_PYTHON_DIR CMake setting and the PYTHONPATH environment variable ==

In the above <code>cmake</code> command, we use the flag <code>GR_PYTHON_DIR</code> to tell GNU Radio where to install its Python scripts and related SWIG libraries. The path noted in that command will work for the MacPorts installed <code>python2.7</code> command. All of the rest of the installed files will be under the <code>/usr/local</code> prefix -- the default CMake setting for when <code>-DCMAKE_INSTALL_PREFIX</code> is not specified.

If you either do not set the <code>GR_PYTHON_DIR</code> flag, or use some other location, you might need to tell Python where to find the installed files. This is done by setting the environment variable <code>PYTHONPATH</code> to include this path. For example, if no <code>GR_PYTHON_DIR</code> or <code>CMAKE_INSTALL_PREFIX</code> flag is specified on the <code>cmake</code> command, then the default install directory will be <code>/usr/local/lib/python2.7/site-packages</code>, and you'll want to set the <code>PYTHONPATH</code> such as the folllwing

<code>export PYTHONPATH=/usr/local/lib/python2.7/site-packages:$PYTHONPATH</code>

This setting might be in the file <code>~/.profile</code>, <code>~/.bashrc</code>, or <code>~/.bash_profile</code>.

When using a package manager such as MacPorts, for most users it is recommended to use the version of GNU Radio provided by the package manager, which will not require changing the <code>PYTHONPATH</code> since that package manager will automatically install the GNU Radio Python files where its Python will find them.

== Upgrading to a new version of OSX on the same computer ==

When you upgrade OSX, you'll generally need to reinstall GNU Radio (and, all of its dependencies). If you are using MacPorts, you can [https://trac.macports.org/wiki/Migration follow their migration guide] to do the reinstallation. You can always just remove all of the old installed files and/or reinstall over them.

== Typical Errors and Warnings ==

=== Library not found ===

If you are compiling an out of tree module from source, some of them do not set the INSTALL_NAME by default. Without a correct set INSTALL_NAME, the library's self-id will be incorrect and the SWIG library will fail to be able to find the module's primary library. The actual runtime error will look like

<pre>
ImportError: dlopen(/opt/local/lib/python2.7/site-packages/air_modes/_air_modes_swig.so, 2): Library not loaded: libair_modes.0.dylib
  Referenced from: /opt/local/lib/python2.7/site-packages/air_modes/_air_modes_swig.so
  Reason: image not found
</pre>
Running <code>otool -L</code> on the libraries returns just the dependent library name without path, e.g.,

<pre>
$ otool -L  /opt/local/lib/python2.7/site-packages/air_modes/_air_modes_swig.so
/opt/local/lib/python2.7/site-packages/air_modes/_air_modes_swig.so:
        /opt/local/Library/Frameworks/Python.framework/Versions/2.7/Python (compatibility version 2.7.0, current version 2.7.0)
        libair_modes.0.dylib (compatibility version 0.0.0, current version 0.0.0)
[snip]
$ otool -L /opt/local/lib/libair_modes.dylib 
/opt/local/lib/libair_modes.dylib:
        libair_modes.0.dylib (compatibility version 0.0.0, current version 0.0.0)
[snip]
</pre>

This issue has been fixed within GNU Radio and is in <code>modtool</code>, and has been propagated to many GR projects. The simple solution is to paste the following chunk of code into the module's top-level CMakeLists.txt file (just after <code>GR_LIBRARY_DIR</code> is defined):

<pre>
########################################################################
# On Apple only, set install name and use rpath correctly, if not already set
########################################################################
if(APPLE)
    if(NOT CMAKE_INSTALL_NAME_DIR)
        set(CMAKE_INSTALL_NAME_DIR
            ${CMAKE_INSTALL_PREFIX}/${GR_LIBRARY_DIR} CACHE
            PATH &quot;Library Install Name Destination Directory&quot; FORCE)
    endif(NOT CMAKE_INSTALL_NAME_DIR)
    if(NOT CMAKE_INSTALL_RPATH)
        set(CMAKE_INSTALL_RPATH
            ${CMAKE_INSTALL_PREFIX}/${GR_LIBRARY_DIR} CACHE
            PATH &quot;Library Install RPath&quot; FORCE)
    endif(NOT CMAKE_INSTALL_RPATH)
    if(NOT CMAKE_BUILD_WITH_INSTALL_RPATH)
        set(CMAKE_BUILD_WITH_INSTALL_RPATH ON CACHE
            BOOL &quot;Do Build Using Library Install RPath&quot; FORCE)
    endif(NOT CMAKE_BUILD_WITH_INSTALL_RPATH)
endif(APPLE)
</pre>

Another solution is to change the installed main and SWIG libraries to have the correct settings. In the case above for gr-air-modes, one could do the following to fix the issue:
<pre>
$ sudo install_name_tool -change libair_modes.0.dylib /opt/local/lib/libair_modes.0.dylib  /opt/local/lib/python2.7/site-packages/air_modes/_air_modes_swig.so
$ sudo install_name_tool -id /opt/local/lib/libair_modes.0.dylib  /opt/local/lib/libair_modes.0.dylib
</pre>

=== Warnings: GTK ===

When executing a GNU Radio GUI, including gnuradio-companion, GTK will produce the following warnings on OSX 10.8; they can safely be ignored:

<pre>
** (process:#####): WARNING **: Trying to register gtype 'GMountMountFlags' as enum when in fact it is of type 'GFlags'
** (process:#####): WARNING **: Trying to register gtype 'GDriveStartFlags' as enum when in fact it is of type 'GFlags'
** (process:#####): WARNING **: Trying to register gtype 'GSocketMsgFlags' as enum when in fact it is of type 'GFlags'
</pre>

=== Error: Unusable DISPLAY ===

When executing a GNU Radio GUI, including gnuradio-companion, from a terminal window (e.g., Terminal.app, iTerm2.app, X11.app) when not the primary user or when the DISPLAY environment variable is not correctly set, one typically sees the following, regardless of OSX version:

<pre>
/opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/gtk-2.0/gtk/__init__.py:57: GtkWarning: could not open display warnings.warn(str(e), _gtk.Warning)
/opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/gnuradio/grc/gui/Actions.py:32: GtkWarning: gdk_keymap_get_for_display: assertion 'GDK_IS_DISPLAY (display)' failed
</pre>
followed by a host of related failed assertions and errors.

If you are using Terminal.app, you'll need to switch to another terminal application such as XQuartz/X11.app or iTerm2.app .

If you are already using an application that correctly sets the <code>DISPLAY</code> environment variable, then you'll want to make sure you're logged in as the primary user (e.g., not as <code>su</code> to another user). If all else fails, try quitting and restarting the application. Try rebooting your computer. When all else fails, contact Michael.

=== Fatal error: 'unistd.h' file not found ===

If your install fails and you notice a line in the reported log file that says something like <code>Fatal error: 'unistd.h' file not found</code>, it's likely due to the path to the active developer tools not correctly setup. To fix, simply execute the following command:

<code>xcode-select --install</code>

A confirmation dialog box will pop-up and the tools will be installed. From here, re-kickstart the gnuradio installation and you should be good to go.

[[Category:Installation]]