= Building on MacOS X = In this approach I will try to avoid as much as possible building dependencies from source and rather use frameworks wherever possible. "Universal", SDK and non-default arch builds require more complex options and some fiddling with the system. It is best to stick with a single, default, architecture build and follow these instructions for an initial build. Included are notes for building on Mac OS X 10.5 (__Leopard__), 10.6 (__Snow Leopard__), 10.7 (__Lion__), 10.8 (__Mt. Lion__) and 10.9 (__Mavericks__) (These names will be used throughout the instructions.) Make sure to read each section completely before typing the first command you see. __General note on Terminal usage:__ When I say "cd" to a folder in a Terminal, it means type "cd " (without the quotes, make sure to type a space after) and then type the path to said folder, then . A simple way to do this without having to know and type the full path is, after type the "cd " part, drag the folder (use the icon in its window title bar, or drag a folder from within a window) from the Desktop to the Terminal, then tap . __Parallel Compilation:__ On multiprocessor/multicore Macs, it's possible to speed up compilation, but it's not automatic. Whenever you type "make" (but NOT "make install"), instead type: ``` make -j [#cpus] ``` Replace [#cpus] with the number of cores and/or processors your Mac has. On recent models with hyperthreading processors this can be double the physical count of processors and cores. ie: Mac Pro "8 Core" model (2 quad core processors) = 8 ie: Macbook Pro i5 (hyperthreading) = 2 cores X 2 = 4 To find out how many CPUs you have available, run the following in Terminal: ``` /usr/sbin/sysctl -n hw.ncpu ``` which can be used in build shell scripts like: ``` make -j $(/usr/sbin/sysctl -n hw.ncpu) ``` __Note:__ if you get an error in parallel compilation, try removing the -j # flag, so it's just 'make', or using a smaller number. Sometimes make can hiccup on too many threads. == Install Developer Tools == Developer tools are not a part of a standard OS X installation. Up through Snow Leopard, the Developer Tools, later called Xcode, were included with the system install disks, though it's best to download the latest version compatible with your system to get important updates fixing various issues. Starting with Lion, Xcode is available as a download and from the App Store. Downloading Xcode/Developer Tools for up through Snow Leopard requires a free developer account at developer.apple.com. Up through Snow Leopard, get the latest __Xcode__ that is supported for your system. For Lion and above, you can get Xcode from either a free developer account or for a minimal fee from the app store. When installing Xcode up through Snow Leopard, make sure to do a custom install and install the Unix Development or Command Line Tools option. On Lion, if you have installed Xcode 4.0 - 4.2 and are upgrading to 4.3, it's a good idea to uninstall the old version first with: ``` sudo /Developer/Library/uninstall-devtools ``` On Lion and Mt. Lion, using Xcode 4.4+, the developer command line tools can be installed via the Xcode preferences. Xcode 4.3+ also introduces the clang frontend to the LLVM compiler as default. **Note:** In XCODE 4.5 installed from the app store, you need to install the command line tools from XCode -> Preferences -> Downloads and choose command line tools. http://clang.llvm.org/ The supplied clang version 4 can compile QGIS, but presents many warnings compared to just using LLVM. You can specifically use LLVM by exporting paths to the compilers in Terminal, or shell scripts, prior to building QGIS: ``` export CC=/usr/bin/llvm-gcc export CXX=/usr/bin/llvm-g++ ``` If you have trouble building some of the dependencies listed below with clang (e.g. OSG & osgEarth), try using only the LLVM compilers. == Install Qt4 from disk image == You need a minimum of Qt-4.4.0. I suggest getting the latest (Qt 4, not 5). There is no need for the full Qt SDK, so save yourself some download time and get the frameworks only. This is available in the Libraries section of the Qt download page. __Snow Leopard+ note:__ If you are building on Snow Leopard+, you will need to decide between 32-bit support in the older Qt Carbon branch, or 64-bit support in the Qt Cocoa branch. Appropriate installers are available for both as of Qt-4.5.2, though they stopped making Carbon packages at Qt 4.7.4. Qt 4.6+ is recommended for Cocoa. Starting with Lion, Carbon may not work properly, if at all. Starting with Qt 4.8, only 64bit Cocoa installers are available. __General note:__ Support for new system versions in any given Qt version may not be present and may cause a 'This version of Mac OS X is unsupported' error when building QGIS. Try the next Qt version. __PPC note:__ The readymade Qt Cocoa installers don't include PPC support, you'd have to compile Qt yourself. But, there appear to be issues with Qt Cocoa on PPC Macs anyways. Qt Carbon is recommended on PPC Macs. http://qt-project.org/downloads If you want debug frameworks, Qt also provides a separate download with these. These are in addition to the non-debug frameworks. Earlier OS X systems may need an old Qt version - check the requirements of the current Qt version. To get old Qt downloads, there is an FTP link at the bottom of the download page. Files are in the qt/source (yes, even the binary packages). Once downloaded open the disk image and run the installer. Note you need admin privileges to install. __Leopard+ note:__ Qt includes a couple non-framework libraries in /usr/lib. When using a system SDK these libraries will not be found. To fix this problem, add symlinks to /usr/local: ``` sudo ln -s /usr/lib/libQtUiTools.a /usr/local/lib/ sudo ln -s /usr/lib/libQtCLucene.dylib /usr/local/lib/ ``` These should then be found automatically. Earlier systems may need some help by adding '-L/usr/local/lib' to CMAKE_SHARED_LINKER_FLAGS, CMAKE_MODULE_LINKER_FLAGS and CMAKE_EXE_LINKER_FLAGS in the cmake build. == Install CMake for OSX == Get the latest source release from here: http://www.cmake.org/cmake/resources/software.html Binary installers are available for OS X, but they are not recommended (2.4 versions install in /usr instead of /usr/local, and 2.6+ versions are a strange application). Instead, download the source. NOTE: 2.8.5 is broken for detecting part of Qt. Fixed in 2.8.6. Double-click the source tarball to unpack it, then cd to the source folder and: ``` ./bootstrap --docdir=/share/doc/CMake --mandir=/share/man make -j [#cpus] sudo make install ``` === Optional setup: ccache === __Xcode 4.4+ note:__ You will probably not need to install ccache if you are using the clang frontend to LLVM compiler, a setup that already provides fairly quick compile times. Setup ccache to significantly speed up compile times after initial build. (Switching git branches will again cause longer initial build times unless separate build directories are used for each branch.) Get the latest source release from here: http://ccache.samba.org/ Double-click the source tarball to unpack, then, in Terminal.app, cd to the source folder and: ``` ./configure make sudo make install ``` After install, symbolically link compilers to /usr/local/bin/ccache. (Note: this differs from instructions at http://ccache.samba.org/manual.html Changing the /usr/bin:/usr/local/bin order in PATH is not recommended on OS X. ``` sudo mkdir /usr/local/bin/compilers && cd /usr/local/bin/compilers sudo ln -s ../ccache gcc sudo ln -s ../ccache g++ sudo ln -s ../ccache cc sudo ln -s ../ccache c++ ``` Add the following to the end of your ~/.bash_profile (and optionally ~/.bashrc) to allow your login shell to discover the symbolically linked compilers before /usr/bin compilers and to easily toggle using ccache off, by commenting out the line and starting a new login session in Terminal. ``` export PATH=/usr/local/bin/compilers:$PATH ``` If you have trouble building some of the dependencies listed below (e.g. OSG & osgEarth), try bypassing ccache. == Install development frameworks for QGIS dependencies == Download William Kyngesburye's excellent GDAL Complete package that includes PROJ, GEOS, GDAL, SQLite3, Spatialite, and image libraries, as frameworks. There are also GSL and FreeType frameworks. http://www.kyngchaos.com/software/frameworks Once downloaded, open and install the frameworks. William provides an additional installer package for Postgresql (for PostGIS support). QGIS just needs the libpq client library, so unless you want to setup the full Postgres + PostGIS server, all you need is the client-only package. It's available here: http://www.kyngchaos.com/software/postgres Also available is a GRASS application: http://www.kyngchaos.com/software/grass Old versions of these packages for older systems are available in the software archive section. === Additional dependencies: General compatibility note === There are some additional dependencies that, at the time of writing, are not provided as frameworks or installers so we will need to build these from source. If you are wanting to build QGIS as a 64-bit application, you will need to provide the appropriate build commands to produce 64-bit support in dependencies. Likewise, for 32-bit support on Snow Leopard, you will need to override the default system architecture, which is 64-bit, according to instructions for individual dependency packages. Stable release versions are preferred. Beta and other development versions may have problems and you are on your own with those. === Additional dependencies: Expat === __Snow Leopard+ note:__ Snow Leopard includes a usable expat, so this step is not necessary on Snow Leopard or above. Get the expat sources: http://sourceforge.net/project/showfiles.php?group_id=10127 Double-click the source tarball to unpack, then, in Terminal.app, cd to the source folder and: ``` ./configure make sudo make install ``` === Additional dependencies: Spatialindex === Get the libspatialindex sources: http://download.osgeo.org/libspatialindex/ Double-click the source tarball to unpack, then, in Terminal.app, cd to the source folder and: ``` ./configure --disable-dependency-tracking CFLAGS=-Os make sudo make install ``` === Additional dependencies: Python === __Leopard+ note:__ Starting with Leopard a usable Python is included in the system. This is Python 2.5, 2.6 and 2.7, respectively for Leo, Snow and Lion+. So there is no need to install Python on Leopard and newer. You can still install Python from python.org if preferred. If installing from python.org, make sure you install the latest Python 2.x from http://www.python.org/download/ Python 3 is a major change, and may have compatibility issues, so try it at your own risk. === Additional dependencies: SIP === __Mt Lion note:__ SIP 4.15.7 appears to not work on Mt Lion. Install either a prior version to 4.14.6 or a later version 4.16.3+ Retrieve the python bindings toolkit SIP from http://www.riverbankcomputing.com/software/sip/download Double-click the source tarball to unpack it, then, in Terminal.app, cd to the source folder. Then for your chosen Python: __python.org Python__ ``` python configure.py make sudo make install ``` __Leopard system Python__ SIP wants to install in the system path -- this is not a good idea. More configuration is needed to install outside the system path: ``` python configure.py -n -d /Library/Python/2.5/site-packages -b /usr/local/bin \ -e /usr/local/include -v /usr/local/share/sip -s MacOSX10.5.sdk ``` __Snow Leopard system Python__ Similar to Leopard, you should install outside the system Python path. Also, you need to specify the architecture you want and make sure to run the versioned python binary (this one responds to the 'arch' command, 'python' does not). Substitute '2.7' for python version and 10.7 for SDK version below for Lion. If you are using 32-bit Qt (Qt Carbon): ``` python2.6 configure.py -n -d /Library/Python/2.6/site-packages -b /usr/local/bin \ -e /usr/local/include -v /usr/local/share/sip --arch=i386 -s MacOSX10.6.sdk ``` For 64-bit Qt (Qt Cocoa), use this configure line: ``` python2.6 configure.py -n -d /Library/Python/2.6/site-packages -b /usr/local/bin \ -e /usr/local/include -v /usr/local/share/sip --arch=x86_64 -s MacOSX10.6.sdk ``` __Lion+ system Python__ Similar to Snow Leopard, you should install outside the system Python path. The SDK option should match the system you are compiling on: for Lion: ``` python2.7 configure.py -d /Library/Python/2.7/site-packages -b /usr/local/bin \ -e /usr/local/include -v /usr/local/share/sip --arch=x86_64 -s MacOSX10.7.sdk ``` for Mt. Lion: ``` python2.7 configure.py -d /Library/Python/2.7/site-packages -b /usr/local/bin \ -e /usr/local/include -v /usr/local/share/sip --arch=x86_64 -s MacOSX10.8.sdk ``` for Mavericks: ``` python2.7 configure.py -d /Library/Python/2.7/site-packages -b /usr/local/bin \ -e /usr/local/include -v /usr/local/share/sip --arch=x86_64 -s MacOSX10.9.sdk ``` __continue...__ Then continue with compilation and installation: ``` make sudo make install ``` === Additional dependencies: QScintilla2 === Retrieve the Qt version of the Scintilla-based text editor widget from http://www.riverbankcomputing.co.uk/software/qscintilla/download Double-click the tarball to unpack it. Then, cd to the QScintilla2.x.x source folder in a Terminal. QScintilla2 wants to install in the system path -- with libraries going into /Library/Frameworks and headers into /usr/include/Qsci -- this is not a good idea, and it also basically breaks the QtDesigner plugin. More configuration is needed to install outside the system path, in /usr/local/: ``` cd Qt4Qt5 ``` Edit QScintilla-gpl-2.x.x/Qt4Qt5/qscintilla.pro in the following manner: ``` current line --> new line target.path = $$[QT_INSTALL_LIBS] --> target.path = /usr/local/lib header.path = $$[QT_INSTALL_HEADERS] --> header.path = /usr/local/include ``` Save the qscintilla.pro file and build the QScintilla2 C++ library: ``` qmake -spec macx-g++ qscintilla.pro make -j [#cpus] sudo make install ``` adjust the install_name_tool command for the version installed of QScintilla installed: ``` sudo install_name_tool -id /usr/local/lib/libqscintilla2.11.dylib \ /usr/local/lib/libqscintilla2.11.dylib ``` This installs QScintilla2's dylib in /usr/local/lib/ and the header files in /usr/local/include/Qsci/, both of which should be automatically found when building QGIS. ==== Optional setup: QScintilla2 QtDesigner plugin ==== The plugin allows QScintilla2 widgets to be used within QtDesigner. ``` cd cd designer-Qt4Qt5 qmake -spec macx-g++ designer.pro make sudo make install ``` Installs in /Developer/Applications/Qt/plugins/designer/ === Additional dependencies: PyQt === Retrieve the python bindings toolkit for Qt from http://www.riverbankcomputing.com/software/pyqt/download Double-click the source tarball to unpack it, then, in Terminal.app, cd to the source folder. Then for your chosen Python: __python.org Python__ ``` python configure.py -n /usr/local/Qt4.8/qsci yes ``` __Leopard system Python__ PyQt wants to install in the system path -- this is not a good idea. More configuration is needed to install outside the system path: ``` python configure.py -d /Library/Python/2.5/site-packages -b /usr/local/bin -n /usr/local/Qt4.8/qsci -v /usr/local/share/sip/PyQt4 ``` __Snow Leopard system Python__ Similar to Leopard, you should install outside the system Python path. Also, you need to specify the architecture you want (requires at least PyQt 4.6), and make sure to run the versioned python binary (this one responds to the 'arch' command, which is important for pyuic4, 'python' does not). Substitute '2.7' for python version and 10.7 for SDK version below for Lion. If you are using 32-bit Qt (Qt Carbon): ``` python2.6 configure.py -d /Library/Python/2.6/site-packages -b /usr/local/bin \ -n /usr/local/Qt4.8/qsci -v /usr/local/share/sip/PyQt4 --use-arch i386 ``` For 64-bit Qt (Qt Cocoa), use this configure line: ``` python2.6 configure.py -d /Library/Python/2.6/site-packages -b /usr/local/bin \ -n /usr/local/Qt4.8/qsci -v /usr/local/share/sip/PyQt4 --use-arch x86_64 ``` __Lion, Mt. Lion, and Mavericks system Python__ Similar to Snow Leopard, you should install outside the system Python path. But you don't need the use-arch option: ``` python2.7 configure.py -d /Library/Python/2.7/site-packages -b /usr/local/bin -n /usr/local/Qt4.8/qsci -v /usr/local/share/sip/PyQt4 ``` __continue...__ ``` make -j [#cpus] sudo make install ``` If there is a problem with undefined symbols in QtOpenGL on Leopard, edit QtOpenGL/makefile and add ""-undefined dynamic_lookup"" to LFLAGS. Then make again. === Additional dependencies: QScintilla2 Python Module === This will create the Qsci.so module in /Library/Python/2.x/site-packages/PyQt4. Like PyQt, it needs help to not install in system locations. __Snow Leopard:__ substitute '2.6' for Python version ``` cd cd Python python2.7 configure.py -o /usr/local/lib -n /usr/local/include \ -d /Library/Python/2.7/site-packages/PyQt4 -v /usr/local/share/sip/PyQt4 \ --sip-incdir=/usr/local/include --pyqt-sipdir=/usr/local/share/sip/PyQt4 cat >>Qsci.pro <> qwtconfig.pri <