Slicer Wiki - User contributions [en]

Documentation/4.0/Developers/Build Instructions

2011-07-01T16:26:21Z

BnLg: /* STEP 0: Prerequisites */

[[Slicer4| Back to Slicer 4]]

The goal of the Super-Build is to provide a cross-platform build system that allows developers to quickly install and configure the multiple packages.

Where [[Slicer3:Build_Instructions|Slicer3's build system]] relied on a [[Slicer3:getbuildtest|custom build script called getbuildtest]], new features added to [http://www.cmake.org CMake], partly driven by slicer's requirements, allow porting of the scripts to rely more on native CMake functionality with the benefit that build script is more modular and general purpose.

== STEP 0: Prerequisites ==

Please check that the following tools are installed on your machine.

*Mac
** git version >= 1.6.5
*** [http://git-scm.com/download Download and install Git]
**[http://www.cmake.org/cmake/resources/software.html CMake] version >= 2.8.2

* Linux prerequisites (''need to confirm'')
** Ubuntu users, just type the following line in a terminal <code>sudo apt-get install gcc libX11-dev libXt-dev libgl1-mesa-dev libosmesa6-dev libglu1-mesa-dev git cmake cmake-curses-gui</code>
** gcc
** gcc-c++
** libX11
** libX11-devel (libX11-dev on Ubuntu 7.04)
** libXt-devel (libXt-dev on Ubuntu)
** opengl/mesa (libgl1-mesa-dev on Ubuntu) (and libosmesa6-dev on Ubuntu)
** glu (libglu1-mesa-dev on Ubuntu)
** git version >= 1.6.5
*** [http://git-scm.com/download Download Git]
*** install git: <code>sudo apt-get install git</code>. If <code>git --version</code> is inferior to 1.6.5, then:<code>sudo dpkg --install git-core_1.6.5-1~bpo50+1_amd64.deb</code>
**[http://www.cmake.org/cmake/resources/software.html CMake] version >= 2.8.2

* Windows prerequisites
**[http://www.cmake.org/cmake/resources/software.html CMake] version >= 2.8.2** Microsoft Visual Studio 2008 or 2010 (including [http://www.microsoft.com/express/Downloads/#2010-Visual-CPP Express Edition])
** SVN
** git version >= 1.6.5. [http://code.google.com/p/msysgit/ msysgit] is recommended. Using [http://code.google.com/p/tortoisegit/ TortoiseGit] is a plus.
* '''All Platforms: Qt.'''{{note}} Use one of the links provided in the table below to download the source code or binary of Qt. If required, you can download the source code and compile Qt using the instructions in [[Slicer4:Build_Instructions_for_QT|Slicer4: Build Instructions for Qt]].

{| border="1"
|- bgcolor="#FFFFCC"
!rowspan="3"|
!colspan="2" rowspan="2"|Linux
!colspan="2"|Mac
!colspan="2" rowspan="2"|Windows
|- bgcolor="#FFFFCC"
!colspan="1"|Tiger
!colspan="1"|Leopard, SnowLeopard
|- bgcolor="#FFFFCC"
!|32bits
!|64bits
!|32bits
!colspan="1"|64bits
!|32bits
!|64bits
|-
! bgcolor="#FFFFCC" | [http://get.qt.nokia.com/qt/source/ Qt source link]
|align="center" colspan="4"| [http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz 4.6.3]
|align="center" colspan="2"| [http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.zip 4.6.3 (vs2008)] [http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.7.3.zip 4.7.3 (vs2010)]
|-
! bgcolor="#FFFFCC" | [http://get.qt.nokia.com/qt/source/ Qt binary link]
|align="center" colspan="1"| [http://get.qt.nokia.com/qtsdk/qt-sdk-linux-x86-opensource-2010.05.bin x86_2010.05]
|align="center" colspan="1"| [http://get.qt.nokia.com/qtsdk/qt-sdk-linux-x86_64-opensource-2010.05.bin x86_64_2010.05]
|align="center" colspan="1"| [http://get.qt.nokia.com/qt/source/qt-mac-carbon-opensource-4.7.0.dmg carbon_4.7.0]
|align="center" colspan="1"| [http://get.qt.nokia.com/qtsdk/qt-sdk-mac-opensource-2010.05.dmg cocoa_4.7.0]
|align="center" colspan="1"| [http://get.qt.nokia.com/qt/source/qt-win-opensource-4.6.3-vs2008.exe 4.6.3 (vs2008)] [http://get.qt.nokia.com/qt/source/qt-win-opensource-4.7.3-vs2008.exe 4.7.3 (vs2010)]
|align="center" colspan="1"| -
|}

== Step1: Checkout slicer source files using subversion ==
For example:
<pre>
cd MyProjects
svn co http://svn.slicer.org/Slicer4/trunk Slicer4
</pre>

== Step2: Configure and generate Slicer solution files ==
You can configure and generate Slicer solution files using either ccmake or cmake-gui.
*cmake-gui (Recommended): Configure using default options.
{{note}}
#If you downloaded the Qt binary then qmake will be detected and all paths will be set automatically.
#If you built your own Qt (e.g. in Debug mode for use with the designer) set the QT_QMAKE_EXECUTABLE in cmake-gui.QT_QMAKE_EXECUTABLE should be set to the path of the qmake.exe file, which is inside the bin directory (for example, ./QT/qt-everywhere-opensource-src-4.7.3/bin/qmake.exe).

*ccmake (for linux/mac): Configure using the following commands. For developers, set the '''CMAKE_BUILD_TYPE''' to '''Debug'''.
<pre>
mkdir Slicer4-SuperBuild
cd Slicer4-SuperBuild
ccmake -DQT_QMAKE_EXECUTABLE:FILEPATH=/home/myself/qt-4.6.3/qt/bin/qmake ../Slicer4

</pre>

Two projects are generated by ccmake/cmake-gui. One of them is in the top-level bin directory Slicer4-Superbuild and the other one is in the subdirectory Slicer4-Superbuild/Slicer-build:

#The first project in Slicer4-Superbuild manages all the external dependencies of Slicer (VTK, ITK, Python, ...). To build Slicer for the first time, run make (or build the solution file in Visual Studio) in Slicer4-Superbuild, which will update and build the external libraries and if successful will then build the subproject Slicer-build. 
#The second project in Slicer4-Superbuild/Slicer-build is the "traditional" build directory of Slicer. After local changes in Slicer (or after an svn update on the source directory of Slicer), only running make (or building the solution file in Visual Studio) in Slicer4-Superuild/Slicer-build is necessary (the external libraries are considered built and up to date). 

{{warning}}
#For Windows users:Windows doesn't support path longer than 260 characters, please make sure that the total path name of your Slicer-build directory is no longer than 75 characters ( for example "c:\work\Slicer\Slicer-Superbuild" (32 characters) is fine)
#Warning: a lot of space disk is necessary to compile Slicer (>10GB on Windows)

== Step3: Build Slicer4 ==
After configuration, start the build process in the Slicer4-SuperBuild directory
*Linux / Mac: Run the following code:
<pre>
make -j<NUMBEROFCORES>
</pre>
*Windows: Open Slicer4-SuperBuild\Slicer.sln (or Slicer-4.0\Slicer4-SuperBuild\Slicer-build\Slicer.sln) in Visual Studio and build the ALL_BUILD project.

{{warning}}
# As it is indicated in Step2, if you make local changes in Slicer4, run make (or build the solution file in Visual Studio) in the directory Slicer4-Superuild/Slicer-build.
# If you would like to make local changes and debug your code in Debug mode in Visual Studio, use the Visual Studio Command Prompt to open the solution file in Slicer4-Superuild/Slicer-build:
#* Open Visual Studio Command Prompt
#* Go to the directory Slicer4-Superuild/Slicer-build
#* Write Slicer.exe --VisualStudio Slicer.sln

==Step4: Run Slicer4 ==
Run the launcher in Slicer4-SuperBuild/Slicer-build/Slicer (Slicer.exe on windows)

==Platform Notes==

* Linux Ubuntu: if you have odd rendering artifacts, try disabling visual effects (System/Appearance/Visual Effects)

Documentation/4.0/Developers/Build Instructions

2011-07-01T14:49:20Z

BnLg: Add all-in-1 line prerequisites for Ubuntu

[[Slicer4| Back to Slicer 4]]

The goal of the Super-Build is to provide a cross-platform build system that allows developers to quickly install and configure the multiple packages.

Where [[Slicer3:Build_Instructions|Slicer3's build system]] relied on a [[Slicer3:getbuildtest|custom build script called getbuildtest]], new features added to [http://www.cmake.org CMake], partly driven by slicer's requirements, allow porting of the scripts to rely more on native CMake functionality with the benefit that build script is more modular and general purpose.

== STEP 0: Prerequisites ==

Please check that the following tools are installed on your machine.

*Mac
** git version >= 1.6.5
*** [http://git-scm.com/download Download and install Git]
**[http://www.cmake.org/cmake/resources/software.html CMake] version >= 2.8.2

* Linux prerequisites (''need to confirm'')
** Ubuntu users, just type the following line in a terminal <code>sudo apt-get install gcc libX11-dev libXt-dev libgl1-mesa-dev libosmesa6-dev libglu1-mesa-dev git cmake</code>
** gcc
** gcc-c++
** libX11
** libX11-devel (libX11-dev on Ubuntu 7.04)
** libXt-devel (libXt-dev on Ubuntu)
** opengl/mesa (libgl1-mesa-dev on Ubuntu) (and libosmesa6-dev on Ubuntu)
** glu (libglu1-mesa-dev on Ubuntu)
** git version >= 1.6.5
*** [http://git-scm.com/download Download Git]
*** install git: <code>sudo apt-get install git</code>. If <code>git --version</code> is inferior to 1.6.5, then:<code>sudo dpkg --install git-core_1.6.5-1~bpo50+1_amd64.deb</code>
**[http://www.cmake.org/cmake/resources/software.html CMake] version >= 2.8.2

* Windows prerequisites
**[http://www.cmake.org/cmake/resources/software.html CMake] version >= 2.8.2** Microsoft Visual Studio 2008 or 2010 (including [http://www.microsoft.com/express/Downloads/#2010-Visual-CPP Express Edition])
** SVN
** git version >= 1.6.5. [http://code.google.com/p/msysgit/ msysgit] is recommended. Using [http://code.google.com/p/tortoisegit/ TortoiseGit] is a plus.
* '''All Platforms: Qt.'''{{note}} Use one of the links provided in the table below to download the source code or binary of Qt. If required, you can download the source code and compile Qt using the instructions in [[Slicer4:Build_Instructions_for_QT|Slicer4: Build Instructions for Qt]].

{| border="1"
|- bgcolor="#FFFFCC"
!rowspan="3"|
!colspan="2" rowspan="2"|Linux
!colspan="2"|Mac
!colspan="2" rowspan="2"|Windows
|- bgcolor="#FFFFCC"
!colspan="1"|Tiger
!colspan="1"|Leopard, SnowLeopard
|- bgcolor="#FFFFCC"
!|32bits
!|64bits
!|32bits
!colspan="1"|64bits
!|32bits
!|64bits
|-
! bgcolor="#FFFFCC" | [http://get.qt.nokia.com/qt/source/ Qt source link]
|align="center" colspan="4"| [http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz 4.6.3]
|align="center" colspan="2"| [http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.zip 4.6.3 (vs2008)] [http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.7.3.zip 4.7.3 (vs2010)]
|-
! bgcolor="#FFFFCC" | [http://get.qt.nokia.com/qt/source/ Qt binary link]
|align="center" colspan="1"| [http://get.qt.nokia.com/qtsdk/qt-sdk-linux-x86-opensource-2010.05.bin x86_2010.05]
|align="center" colspan="1"| [http://get.qt.nokia.com/qtsdk/qt-sdk-linux-x86_64-opensource-2010.05.bin x86_64_2010.05]
|align="center" colspan="1"| [http://get.qt.nokia.com/qt/source/qt-mac-carbon-opensource-4.7.0.dmg carbon_4.7.0]
|align="center" colspan="1"| [http://get.qt.nokia.com/qtsdk/qt-sdk-mac-opensource-2010.05.dmg cocoa_4.7.0]
|align="center" colspan="1"| [http://get.qt.nokia.com/qt/source/qt-win-opensource-4.6.3-vs2008.exe 4.6.3 (vs2008)] [http://get.qt.nokia.com/qt/source/qt-win-opensource-4.7.3-vs2008.exe 4.7.3 (vs2010)]
|align="center" colspan="1"| -
|}

== Step1: Checkout slicer source files using subversion ==
For example:
<pre>
cd MyProjects
svn co http://svn.slicer.org/Slicer4/trunk Slicer4
</pre>

== Step2: Configure and generate Slicer solution files ==
You can configure and generate Slicer solution files using either ccmake or cmake-gui.
*cmake-gui (Recommended): Configure using default options.
{{note}}
#If you downloaded the Qt binary then qmake will be detected and all paths will be set automatically.
#If you built your own Qt (e.g. in Debug mode for use with the designer) set the QT_QMAKE_EXECUTABLE in cmake-gui.QT_QMAKE_EXECUTABLE should be set to the path of the qmake.exe file, which is inside the bin directory (for example, ./QT/qt-everywhere-opensource-src-4.7.3/bin/qmake.exe).

*ccmake (for linux/mac): Configure using the following commands. For developers, set the '''CMAKE_BUILD_TYPE''' to '''Debug'''.
<pre>
mkdir Slicer4-SuperBuild
cd Slicer4-SuperBuild
ccmake -DQT_QMAKE_EXECUTABLE:FILEPATH=/home/myself/qt-4.6.3/qt/bin/qmake ../Slicer4

</pre>

Two projects are generated by ccmake/cmake-gui. One of them is in the top-level bin directory Slicer4-Superbuild and the other one is in the subdirectory Slicer4-Superbuild/Slicer-build:

#The first project in Slicer4-Superbuild manages all the external dependencies of Slicer (VTK, ITK, Python, ...). To build Slicer for the first time, run make (or build the solution file in Visual Studio) in Slicer4-Superbuild, which will update and build the external libraries and if successful will then build the subproject Slicer-build. 
#The second project in Slicer4-Superbuild/Slicer-build is the "traditional" build directory of Slicer. After local changes in Slicer (or after an svn update on the source directory of Slicer), only running make (or building the solution file in Visual Studio) in Slicer4-Superuild/Slicer-build is necessary (the external libraries are considered built and up to date). 

{{warning}}
#For Windows users:Windows doesn't support path longer than 260 characters, please make sure that the total path name of your Slicer-build directory is no longer than 75 characters ( for example "c:\work\Slicer\Slicer-Superbuild" (32 characters) is fine)
#Warning: a lot of space disk is necessary to compile Slicer (>10GB on Windows)

== Step3: Build Slicer4 ==
After configuration, start the build process in the Slicer4-SuperBuild directory
*Linux / Mac: Run the following code:
<pre>
make -j<NUMBEROFCORES>
</pre>
*Windows: Open Slicer4-SuperBuild\Slicer.sln (or Slicer-4.0\Slicer4-SuperBuild\Slicer-build\Slicer.sln) in Visual Studio and build the ALL_BUILD project.

{{warning}}
# As it is indicated in Step2, if you make local changes in Slicer4, run make (or build the solution file in Visual Studio) in the directory Slicer4-Superuild/Slicer-build.
# If you would like to make local changes and debug your code in Debug mode in Visual Studio, use the Visual Studio Command Prompt to open the solution file in Slicer4-Superuild/Slicer-build:
#* Open Visual Studio Command Prompt
#* Go to the directory Slicer4-Superuild/Slicer-build
#* Write Slicer.exe --VisualStudio Slicer.sln

==Step4: Run Slicer4 ==
Run the launcher in Slicer4-SuperBuild/Slicer-build/Slicer (Slicer.exe on windows)

==Platform Notes==

* Linux Ubuntu: if you have odd rendering artifacts, try disabling visual effects (System/Appearance/Visual Effects)