View source for Documentation/4.10/Developers/Build Module

<noinclude>{{documentation/versioncheck}}</noinclude>
= Build module outside of Slicer source tree =

The different [[Documentation/{{documentation/version}}/Developers/Modules|type of modules]] supported by Slicer can easily be built outside of the Slicer source tree.

'''Note: to build C++ modules you need to have built Slicer from source on your machine; they cannot be built against a binary download.'''

The following examples are specific to unix-like platforms and can easily be adapted for Windows.



Assuming the source code of your module is located in folder <code>MyModule</code>, externally building modules could be achieved doing:
<pre>
$ mkdir MyModule-build
$ cd MyModule-build
$ cmake -DSlicer_DIR:PATH=/path/to/Slicer-Superbuild/Slicer-build ../MyModule
$ make
</pre>



For this to work, in addition to invoke <code>cmake_minimum_required</code> at the top of the top-level <code>CMakeLists.txt</code>, it's important to make sure the following line are added after setting <code>MODULE_NAME</code>:
<pre>
find_package(Slicer REQUIRED)
include(${Slicer_USE_FILE})
</pre>


For example:

<pre>
cmake_minimum_required(VERSION 2.8.9)  <- - - - ADD THIS

find_package(Slicer COMPONENTS ConfigurePrerequisites)  <- - - - ADD THIS

project(EmptyExtensionTemplate) <- - - - ADD THIS

#-----------------------------------------------------------------------------
set(MODULE_NAME ${PROJECT_NAME})
set(MODULE_TITLE ${MODULE_NAME})

string(TOUPPER ${MODULE_NAME} MODULE_NAME_UPPER)

#-----------------------------------------------------------------------------
find_package(Slicer REQUIRED)  <- - - - - - - ADD THIS
include(${Slicer_USE_FILE})  <- - - - - - - - ADD THIS

#-----------------------------------------------------------------------------
add_subdirectory(Logic)

#-----------------------------------------------------------------------------
set(MODULE_EXPORT_DIRECTIVE "Q_SLICER_QTMODULES_${MODULE_NAME_UPPER}_EXPORT")

[...]
</pre>

After successfully compiling the Slicer module, the Slicer module executables and libraries are located in your module build directory under lib <code>build_dir/lib/Slicer-X.Y/module_type</code>. Adding this directory to the Additional module paths in the Application Settings GUI within slicer, will allow testing of your module without recompiling the super-build.  Refer to [[Documentation/{{documentation/version}}/Developers/DirectoryStructure|Directory Structure]] description for more details.


{{:Documentation/{{documentation/version}}/Developers/FAQ/Modules|Modules}}