Difference between revisions of "Documentation/Nightly/Developers/Build Instructions/Configure"

From Slicer Wiki
Jump to: navigation, search
(Reference discussion on Windows maximum command line length)
(Clean up QT_QMAKE_EXECUTABLE tips)
Line 17: Line 17:
 
*** 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.
 
*** 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.
 
** Select your compiler: Visual Studio 9 2008 Win64
 
** Select your compiler: Visual Studio 9 2008 Win64
** Configure using default options. You may get a configuration error that <code>QT_QMAKE_EXECUTABLE</code> is not set, which is normal (you usually have to set Qt path manually unless you downloaded and installed the Qt binary package that you would like to use and only have one Qt version installed on your computer).
+
** Configure using default options. You may get a configuration error that <code>QT_QMAKE_EXECUTABLE</code> is not set, which is normal.
** Verify that <code>QT_QMAKE_EXECUTABLE</code>variable is set correctly and change as needed.
+
** Verify that <code>QT_QMAKE_EXECUTABLE</code> variable is set correctly:
*** Automatic detection may find an installed Qt version while you may want to use your own custom built Qt(e.g. in Debug mode for use with the designer) set the.
+
*** 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).
*** <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>).
+
*** Set <code>QT_QMAKE_EXECUTABLE</code> to the path of the <code>qmake.exe</code>, which is inside the <code>bin</code> directory (for example, <code>C:/path/to/qt-everywhere-opensource-build-4.8.6/bin/qmake.exe</code>).
 
** 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')
 
** 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.
 
** Click generate then close cmake-gui.

Revision as of 16:00, 4 August 2015

Home < Documentation < Nightly < Developers < Build Instructions < Configure


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 or C:\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 example c:\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.
    • 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 the qmake.exe, which is inside the bin 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 to Release in cmake-gui.
    • If building in debug mode:
    • Build the ALL_BUILD project

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:
  1. Using top-level directory name like Slicer-SuperBuild-Release or Slicer-SuperBuild-Debug is recommended.
  2. Step-by-step debug instuctions

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
  1. 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) in Slicer-SuperBuild, which will update and build the external libraries and if successful will then build the subproject Slicer-build.
  2. 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) in Slicer-SuperBuild/Slicer-build is necessary (the external libraries are considered built and up to date).
  3. 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

Notes for advanced users

  • 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 -DCMAKE_DISABLE_FIND_PACKAGE_Java:BOOL=TRUE when configuring Slicer.
  • Same applies for OpenSSL: CMAKE_DISABLE_FIND_PACKAGE_OpenSSL:BOOL=TRUE can be passed when building Slicer for packaging.