https://www.slicer.org/w/index.php?action=history&feed=atom&title=Documentation%2F4.4%2FDevelopers%2FBuild_Instructions%2FConfigureDocumentation/4.4/Developers/Build Instructions/Configure - Revision history2026-04-21T17:30:38ZRevision history for this page on the wikiMediaWiki 1.33.0https://www.slicer.org/w/index.php?title=Documentation/4.4/Developers/Build_Instructions/Configure&diff=40187&oldid=prevUpdateBot: Nightly -> 4.42014-12-25T06:43:31Z<p>Nightly -> 4.4</p>
<p><b>New page</b></p><div><noinclude>{{documentation/versioncheck}}</noinclude><br />
== CONFIGURE and generate Slicer solution files ==<br />
You can configure and generate Slicer solution files using either <code>ccmake</code> or <code>cmake-gui</code>.<br />
<br />
<!--<br />
<ol style="list-style-type:none; border-left:thick solid red; padding-left:1em;"><br />
<li>While it is not enforced, we strongly recommend you to '''AVOID''' the use of '''SPACES''' for both the <code>source directory</code> and the <code>build directory</code>. We mean it.<br />
</li><br />
</ol><br />
--><br />
<br />
=== Per-platform instructions===<br />
==== Windows ====<br />
*'''Recommended''': <code>cmake-gui</code><br />
** Configure using default options.<br />
** Set the build directory. For example: <code>C:\Slicer-SuperBuild-Debug</code> or <code>C:\Slicer-SuperBuild-Release</code>.<br />
* '''Remarks''':<br />
#If you downloaded the Qt binary then <code>qmake</code> will be detected and all paths will be set automatically. <br />
#If you built your own Qt (e.g. in Debug mode for use with the designer) set the <code>QT_QMAKE_EXECUTABLE</code> in <code>cmake-gui</code>.<code>QT_QMAKE_EXECUTABLE</code> should be set to the path of the qmake.exe file, which is inside the bin directory (for example, <code>\path\to\qt-everywhere-opensource-build-4.8.6\bin\qmake.exe</code>). <br />
#You cannot use the same build tree for both release or debug mode builds. If both build types are needed, then the same source directory can be used, but a separate build directory should be created and configured for each build type.<br />
#SimpleITK has to be disabled for building in debug mode. See more information at http://www.na-mic.org/Bug/view.php?id=3816 (you get this error if you attempt it: LINK : fatal error LNK1104: cannot open file 'python27_d.lib')<br />
#Windows [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath doesn't support path longer than 260 characters], please make sure that the total path name of your <code>Slicer-build</code> directory is no longer than 50 characters ( for example <code>c:\work\Slicer\Slicer-SuperBuild</code> (32 characters) is fine)<br />
#Visual Studio will select Debug build configuration by default when you first open the solution in the Visual Studio GUI. If you build Slicer in release mode and accidentally forget to switch the build configuration to Release then the build will fail. If you are making a release build, then you can avoid the need for a manual build configuration switching by setting your CMAKE_CONFIGURATION_TYPES to Release.<br />
# [[Documentation/{{documentation/version}}/Developers/Tutorials/Debug_Instructions|Step-by-step debug instuctions]]<br />
<br />
==== Unix-like ====<br />
*'''Recommended''': <code>ccmake</code><br />
** Configure using the following commands. By default '''CMAKE_BUILD_TYPE''' is set to '''Debug'''.<br />
<pre><br />
mkdir Slicer-SuperBuild-Debug<br />
cd Slicer-SuperBuild-Debug<br />
cmake -DCMAKE_BUILD_TYPE:STRING=Debug -DQT_QMAKE_EXECUTABLE:FILEPATH=/path/to/QtSDK/Desktop/Qt/486/gcc/bin/qmake ../Slicer<br />
</pre><br />
where you replace ''/path/to/QtSDK'' with the real path on your machine where QtSDK is located<br />
* '''Remarks''':<br />
# Using top-level directory name like <code>Slicer-SuperBuild-Release</code> or <code>Slicer-SuperBuild-Debug</code> is recommended.<br />
# [[Documentation/{{documentation/version}}/Developers/Tutorials/Debug_Instructions|Step-by-step debug instuctions]]<br />
<br />
=== General information ===<br />
<br />
Two projects are generated by either <code>cmake</code>, <code>ccmake</code> or <code>cmake-gui</code>. <br />
<br />
One of them is in the top-level bin directory <code>Slicer-SuperBuild</code> and the other one is in the subdirectory <code>Slicer-build</code>:<br />
<br />
<pre>Slicer-SuperBuild/Slicer-build</pre><br />
<br />
# The first project in <code>Slicer-SuperBuild</code> 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 <code>Slicer-SuperBuild</code>, which will update and build the external libraries and if successful will then build the subproject Slicer-build.<br><br />
# The second project in <code>Slicer-SuperBuild/Slicer-build</code> 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 <code>Slicer-SuperBuild/Slicer-build</code> is necessary (the external libraries are considered built and up to date). <br><br />
#'''Warning''': An significant amount of disk space is required to compile Slicer in Debug (>10GB on Windows)<br />
<br />
=== Workaround firewall blocking git protocol ===<br />
* Some firewall will be blocking the git protocol, a possible workaround is to configure Slicer disabling the option <code>Slicer_USE_GIT_PROTOCOL</code>. Then http protocol will be used instead. Consider also reading https://github.com/commontk/CTK/issues/33<br />
<br />
=== Notes for advanced users ===<br />
* By default, if CMake finds Java on your machine, it automatically builds Java CLIs. If you don't want any Java in your Slicer (or if you don't want to install Java on your Mac Os X), you can pass <code>-DCMAKE_DISABLE_FIND_PACKAGE_Java:BOOL=TRUE</code> when configuring Slicer.<br />
* Same applies for OpenSSL: <code>CMAKE_DISABLE_FIND_PACKAGE_OpenSSL:BOOL=TRUE</code> can be passed when building Slicer for packaging.</div>UpdateBot