Documentation/Nightly/Developers/Build Instructions/Configure
From Slicer Wiki
Revision as of 18:19, 30 January 2016 by JChris.FillionR (talk | contribs) (Remove obsolete "Notes for advanced users". Java CLI have been removed in r21206, and the option Slicer_USE_PYTHONQT_WITH_OPENSSL allows to enable/disable SSL support)
Home < Documentation < Nightly < Developers < Build Instructions < Configure
For the latest Slicer documentation, visit the read-the-docs. |
Contents
CONFIGURE and generate Slicer solution files
You can configure and generate Slicer solution files using either ccmake
or cmake-gui
.
Per-platform instructions
Windows
- Recommended:
cmake-gui
- Set the build directory. For example:
C:\Slicer-SuperBuild-Debug
orC:\Slicer-SuperBuild-Release
.- Because Windows doesn't support file path longer than 260 characters and has a maximum command line length, please make sure that the total path name of your
Slicer-build
directory is no longer than 50 characters (for examplec:\work\Slicer\Slicer-SuperBuild
(32 characters) is fine). In case of any build error, use very short directory names: C:\S4 for source directory, C:\S4D for debug build, C:\S4R for release build. - 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.
- Because Windows doesn't support file path longer than 260 characters and has a maximum command line length, please make sure that the total path name of your
- Select your compiler: Visual Studio 9 2008 Win64
- Configure using default options. You may get a configuration error that
QT_QMAKE_EXECUTABLE
is not set, which is normal. - Verify that
QT_QMAKE_EXECUTABLE
variable is set correctly:- CMake may automatically detect an installed version of Qt, but you may want to use a custom built version of Qt (e.g. in Debug mode for use with the designer).
- Set
QT_QMAKE_EXECUTABLE
to the path of theqmake.exe
, which is inside thebin
directory (for example,C:/path/to/qt-everywhere-opensource-build-4.8.6/bin/qmake.exe
).
- If building in debug mode: 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')
- Click generate then close cmake-gui.
- If building in release mode:
- Open the top-level Slicer.sln file in the build directory in Visual Studio
- Set active configuration to Release. 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. Note: you can avoid this manual configuration mode selection by setting
CMAKE_CONFIGURATION_TYPES
toRelease
in cmake-gui.
- If building in debug mode:
- Start Visual Studio using the Slicer launcher as described in Step-by-step debug instuctions
- Build the ALL_BUILD project
- Set the build directory. For example:
Unix-like
- Recommended:
ccmake
- Configure using the following commands. By default CMAKE_BUILD_TYPE is set to Debug.
mkdir Slicer-SuperBuild-Debug cd Slicer-SuperBuild-Debug cmake -DCMAKE_BUILD_TYPE:STRING=Debug -DQT_QMAKE_EXECUTABLE:FILEPATH=/path/to/QtSDK/Desktop/Qt/486/gcc/bin/qmake ../Slicer
where you replace /path/to/QtSDK with the real path on your machine where QtSDK is located
- Remarks:
- Using top-level directory name like
Slicer-SuperBuild-Release
orSlicer-SuperBuild-Debug
is recommended. - Step-by-step debug instuctions
- On Mac OS X 10.9 (Mavericks) / 10.10 (Yosemite), also set the following variables (see discussion):
Variable | Description |
Slicer_USE_PYTHONQT_WITH_TCL | OFF |
CMAKE_OSX_DEPLOYMENT_TARGET | 10.9 or 10.10 |
General information
Two projects are generated by either cmake
, ccmake
or cmake-gui
.
One of them is in the top-level bin directory Slicer-SuperBuild
and the other one is in the subdirectory Slicer-build
:
Slicer-SuperBuild/Slicer-build
- The first project in
Slicer-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) inSlicer-SuperBuild
, which will update and build the external libraries and if successful will then build the subproject Slicer-build. - The second project in
Slicer-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) inSlicer-SuperBuild/Slicer-build
is necessary (the external libraries are considered built and up to date). - Warning: An significant amount of disk space is required to compile Slicer in Debug (>10GB on Windows)
Workaround firewall blocking git protocol
- Some firewall will be blocking the git protocol, a possible workaround is to configure Slicer disabling the option
Slicer_USE_GIT_PROTOCOL
. Then http protocol will be used instead. Consider also reading https://github.com/commontk/CTK/issues/33