Documentation/Nightly/Developers/Build Instructions/Prerequisites

For the latest Slicer documentation, visit the read-the-docs.

PREREQUISITES

Consider reading platform specific requirements listed below.

Linux

• CMake >= 3.x
• Git >= 1.7.10
• Svn >= 1.7
• Qt 4.8.6. See details here (Note that any version >= Qt 4.7.4 can be used only for Ubuntu < 12.04)

Ubuntu / Debian

• Ubuntu, Debian squeeze/wheezy/testing(jessie) users, start by pasting the following lines in a terminal

sudo apt-get install subversion git-core git-svn
sudo apt-get install make gcc g++ libX11-dev libXt-dev libgl1-mesa-dev libosmesa6-dev libglu1-mesa-dev libfontconfig-dev libxrender-dev libncurses5-dev
sudo apt-get install cmake
sudo apt-get install qt-sdk

For Ubuntu 12.04, 12.10, 13.04, and 14.04: You *MUST download and build the standard cmake* from http://cmake.org/ because the distributed version of cmake cannot be used to build slicer.

sudo apt-get install openssl libssl-dev

mkdir ~/Support && cd Support     # This is where we will download and install required software

# By copying this one-liner in your terminal, it will download and build CMake
cmake_package="cmake-3.0.0"; \
wget http://www.cmake.org/files/v3.0/$cmake_package.tar.gz -v -O $cmake_package.tar.gz && \
tar -xzvf $cmake_package.tar.gz; \
cd $cmake_package && \
cmake -DCMAKE_USE_OPENSSL:BOOL=ON && \
make -j4

# By copying this one-liner, symbolic links to cmake tools will be created in /usr/local/bin. 
# That way calling cmake, ctest, ... from the command line will resolve to this version of CMake.
for tool in cmake ccmake ctest cpack; do sudo ln -s ~/Support/$cmake_package/bin/$tool /usr/local/bin/$tool; done

For Ubuntu 12.04, 12.10, 13.04 and 13.10: Qt 4 >= 4.8.5 MUST be used. See reference below for more details.

cd ~/Support   # This is where we will build Qt and dependent libraries
 
# Keep track of our working directory
cwd=$(pwd)

# This will download, then build zlib and openssl in the current folder
rm -f get-and-build-openssl-for-slicer.sh
wget https://gist.githubusercontent.com/jcfr/9513568/raw/21f4e4cabca5ad03435ecc17ab546dab5e2c1a2f/get-and-build-openssl-for-slicer.sh
chmod u+x get-and-build-openssl-for-slicer.sh 
./get-and-build-openssl-for-slicer.sh 

# This will download Qt source in the current folder
wget http://packages.kitware.com/download/item/6175/qt-everywhere-opensource-src-4.8.6.tar.gz
md5=`md5sum ./qt-everywhere-opensource-src-4.8.6.tar.gz | awk '{ print $1 }'` &&
[ $md5 == "2edbe4d6c2eff33ef91732602f3518eb" ] || echo "MD5 mismatch. Problem downloading Qt"

# This will configure and build Qt in RELEASE against the zlib and openssl previously built
tar -xzvf qt-everywhere-opensource-src-4.8.6.tar.gz
mv qt-everywhere-opensource-src-4.8.6 qt-everywhere-opensource-release-src-4.8.6
mkdir qt-everywhere-opensource-release-build-4.8.6
cd qt-everywhere-opensource-release-src-4.8.6
./configure -prefix $cwd/qt-everywhere-opensource-release-build-4.8.6/    \
                   -release \
                   -opensource -confirm-license \
                   -no-qt3support \
                   -webkit \
                   -nomake examples -nomake demos \
                   -openssl -I $cwd/openssl-1.0.1e/include   -L $cwd/openssl-1.0.1e \
&& make -j7 && make install

References:

• Why cmake should be built from Source on Ubuntu 12.04 and above ?
  • http://slicer-devel.65872.n3.nabble.com/PYTHON-INCLUDE-DIR2-when-building-Slicer4-td4028557.html
  • Slicer issue #3103
  • Slicer issue #3116
  • CMake issue #14156

• Why Qt 4 >= 4.8.5 should be used on Ubuntu 12.04 and above ?
  • Slicer issue #3325

CentOS

• CentOS user type:

yum install make gcc-c++ libX11-devel libXt-devel libXext-devel libGLU-devel mesa-libOSMesa-devel mesa-libGL-devel mesa-libGLU-devel ncurses

MacOSX

MacOSX 10.9.4 (Maverick):

(1) Make sure to install this update: http://support.apple.com/kb/DL1754

(2) Use CMake 3.0.1 - it is known to be working and is supported (if you want to use CMake already installed on your system, 2.8.12.2 is known to work on Mac OS X 10.9.5)

• Mac Os X >= 10.5 (Leopard)
• CMake >= 2.8.9
  • For Mac Os X >= 10.8 (Mountain Lion) and/or recent XCode >= 4.5.X - CMake >= 2.8.11 is required. See http://www.cmake.org/files/v2.8/cmake-2.8.11-Darwin64-universal.tar.gz

$ curl -O http://www.cmake.org/files/v2.8/cmake-2.8.11-Darwin64-universal.tar.gz
$ tar -xzvf cmake-2.8.11-Darwin64-universal.tar.gz --strip-components=1

$ CMake\ 2.8-11.app/Contents/bin/cmake --version
cmake version 2.8.11

• Git >= 1.7.10
• Svn >= 1.7
• XCode (for the SDK libs)
• Qt 4 >= 4.8.5. We recommend you install the following two packages:
  • Download and install qt-opensource-mac-4.8.6-1.dmg
  • Download and install qt-opensource-mac-4.8.6-1-debug-libs.dmg
  • For more details here
• XQuartz - For Mac Os X >= 10.8 (Mountain Lion) install XQuartz (http://xquartz.macosforge.org) to get X11 (no longer a default in OS X).

Windows

• CMake >= 3.0
• Git >= 1.7.10
  • For convenience, you could update the PATH variable so that git can be automatically discovered when configuring Slicer. If not, you will have to specify the GIT_EXECUTABLE at configure time.

• SlikSvn . If using TortoiseSVN (versions that support command line tools), make sure you install Command line tools (disabled by default)

• NSIS (optional): Needed if packaging Slicer - Click here to download.

• Qt 4.8.6 (for VS2008). See details here
  • Normally you should plan to build Qt from source to have complete control over the process. See one-liner build command
  • You may find that the unsigned binary downloads from this site are usable: http://sourceforge.net/projects/qt64ng/files/qt/x86-64/4.8.6/msvc2008/ (If you use .7z varaints extract them in the default location C:\Qt\ otherwise that installation will not be properly configured for use with CMake)
  • Details: Using the Qt Designer on Windows requires that the Slicer plugins are compiled in the same mode as Qt. If Qt was compiled in Release mode (default), Slicer would have to be compiled in Release mode as well. However if Qt is compiled in Debug mode only, Slicer has to be compiled in Debug too. When Qt is in "Release and Debug" mode only the Release version of Designer.exe is generated, Slicer would have to be compiled in Release. So for developers, the Debug mode is recommended.
  • For VS2012 Qt needs to be build from source. Build will fail, which can be fixed with this diff: https://gist.github.com/Vitallium/5220503 (read the comment too)

• IDE
  • Tested/Recommended: Microsoft Visual Studio 9 2008 (Any edition). VS Express 2008 with SP1 direct link (functional as of Jan 11, 2014)
    • Make sure to install:
      • SP1. Click here to download SP1 and click here to understand the motivation.
    • Make sure to patch VS2008 using the script fix-vc9-redist-manifests.ps1
  • Experimental: The plan is to support Microsoft Visual Studio 2010 (Any edition). NOTE THAT EXPERIMENTAL MEANS THIS DOESN'T YET WORK :)
    • Make sure to build or install:
      • Qt 4.8
    • Make sure to install:
      • SP1. Click here to download SP1 and click here to understand the motivation.
      • SP1 Compiler update. Click here to download and here to understand the motivation.
  • Experimental (Visual Studio 2012): Use a desktop version such as Visual Studio 2012 Express for Windows Desktop and remember Visual Studio 2012 Update 2). Do not use Visual Studio Express 2012 for Windows 8. You must install Windows SDK, otherwise CMake will not even find the C compiler during configure. In CMake, choose Visual Studio 11 Win64 as generator.
  • Experimental (Visual Studio 2013 with Update 5): As of commit e5eb478, Slicer compilation is successful in Debug mode after disabling numpy and SimpleITK modules in CMake.
  • Un-tested: Cygwin suite (building with cygwin gcc not supported, but the cygwin shell environment can be used to run git, svn, etc).