Introduction

The CMake-based build system of MITK supports a "superbuild" process, meaning that it will download, configure, and build all required third-party libraries (except Qt) automatically. These instructions will show you how to use the MITK superbuild.

Note: This page explains explicitly how to build MITK itself. If you want to create your own project based on MITK, the process described below is completely automated. Please see Creating a new MITK project.

For more advanced users, the last sections explains how to inject custom build libraries into the superbuild process.

Prerequisites

You need:

Git (there are also numerous third-party graphical clients available). We recommend using Git, but see below for a way how to get the current source code without using it.
CMake (version 3.18 or higher)
Qt 5.12 if you plan to develop Qt-based applications
If you are using macOS you need an XCode installation and the Command Line Tools as it provides the neccessary compilers and SDKs

To build MITK on Linux, install the following packages, e. g. with APT:

sudo apt install build-essential doxygen git graphviz libfreetype6-dev libglu1-mesa-dev libssl-dev libtiff5-dev libxcomposite1 libxcursor1 libxdamage-dev libxi-dev libxkbcommon-x11-0 libxt-dev mesa-common-dev

For the optional and experimental (!) Python integration, install NumPy and SimpleITK v1.x, e. g.:

sudo apt install python3-numpy python3-pip

pip3 install SimpleITK

A note about Qt

As we do not provide Qt in the MITK superbuild you need to install Qt manually. The Qt Company provides online installers for all supported platforms.

We highly recommend to install Qt to the default location of the installer as it will allow MITK to automatically find Qt without any further action needed.

Make sure to also select the following required components:

QtWebEngine
QtScript

On Windows, the Qt installer offers a welcome and straight forward way to install OpenSSL. You find it under the Tools node.

Get a source tree

Since MITK is under active development we recommend to use Git to check out the latest stable release from the homepage. If you decide to use the most current nightly release, make sure to get a stable tree: Check the MITK dashboard before checking out. If the build tree is not clean, you can specify an older revision for the checkout or get a stable tar ball from www.mitk.org.

To clone MITK's current Git repository do:

git clone https://phabricator.mitk.org/source/mitk.git MITK

Build MITK with CMake

Create a new directory for the superbuild binary tree, change to it and call CMake:

In the shell (assuming your current directory is the same as the one where you issued the git clone command):

mkdir MITK-superbuild
cd MITK-superbuild
ccmake ../MITK

If you use Windows or prefer to use the CMake GUI, start the CMake GUI and enter the location of the source tree and binary tree, choose a suitable generator and configure the project.

CMake will present you a couple of options, these are the most important ones:

CMAKE_PREFIX_PATH The path to your Qt installation, e.g., C:/Qt/5.12.9/msvc2017_64 or /home/user/Qt/5.12.9/gcc_64
MITK_USE_BLUEBERRY Build the BlueBerry application framework
MITK_USE_Boost_LIBRARIES If you need binary Boost libraries, specify them here.
MITK_USE_OpenCV Build MITK code which depends on OpenCV (this will download and build OpenCV 2.4)
MITK_USE_Python3 Enables Python wrapping in MITK. This will also configure ITK, VTK, and OpenCV (if enabled) to build Python wrappers.
MITK_USE_Qt5 Build MITK code which depends on Qt 5

If you are satisfied with the configuration of your MITK superbuild, generate the project files with CMake by pressing "Generate".

Linux and macOS users usually just enter "make" (optionally supplying the number threads to be used for a parallel build):

make -j6

Windows users using Visual Studio can open the generated MITK-superbuild.sln solution file in the MITK-superbuild directory and start the build by building the BUILD_ALL project.

Customize your MITK superbuild

The MITK superbuild configures MITK as well as all external libraries. The build directories of these libraries, and of MITK itself are located inside the MITK-superbuild directory. For example, the directory layout may look like:

MITK-superbuild
 |- ep "external projects"
    |-bin
    |-lib
    |-include
    |-src
 |- MITK-build

To change the configuration of the MITK build itself, choose the MITK-build directory as the binary directory in the CMake GUI (not the MITK-superbuild directory). After generating the project files, build the MITK project by either issuing "make" in the MITK-build directory (Linux, macOS), or by opening MITK-build/MITK.sln (Windows).

You may also change the configuration of any project configured via the superbuild process. Make sure to also build the changed project and also the projects which depend on it.

Running Applications

On Linux, just execute the application you want to run. MITK executables are located in MITK-superbuild/MITK-build/bin

On Windows, the PATH environment variable must contain the directories containing the third-party libraries. This is automatically done from Visual Studio. For running the applications directly use the generated batch files in the MITK-superbuild/MITK-build/bin.

Documentation

If you have the Doxygen documentation tool installed, you get a new project (Visual Studio) or "make" target named "doc". You can build this to generate the HTML documentation of MITK in the Documentation/Doxygen directory of your MITK-build binary tree or in the MITK_DOXYGEN_OUTPUT_DIR CMake variable (if specified).

Use MITK in your own project (as a toolkit)

To use MITK in your external project, add the CMake command find_package(MITK REQUIRED) to your CMakeLists.txt and make use of the CMake macros mitk_create_module() and mitk_create_executable() provided by MITK.

Here is a very basic example CMakeLists.txt including MITK as a project:

cmake_minimum_required(VERSION 3.18 FATAL_ERROR)
 
project(MyProject)
 
find_package(MITK 2023.04 REQUIRED)
 
add_executable(MyApp main.cpp)
 
target_link_libraries(MyApp MitkCore)

with the main.ccp being

#include <iostream>
#include <mitkLogMacros.h>
 
int main()
{
  MITK_INFO << "Hello world!";
  return 0;
}

Superbuild customization

You can inject pre-build third-party libraries into the MITK superbuild by setting certain CMake variables before the first configure step. MITK will then use these third-party libraries instead of downloading and building them by itself. Note that you must take care of configuring those libraries with all options MITK requires.

The variables listed below are provided for injecting third-party libraries. Their occurrence in the CMake GUI or in ccmake may depend on specific MITK_USE_* options set to ON. You may also use the variable names below without the EXTERNAL_ prefix, for example when providing their values on a command line call to CMake.

EXTERNAL_BOOST_ROOT Set this variable to your custom Boost installation
EXTERNAL_CTK_DIR Set this variable to your CTK binary tree (the directory containing the CTKConfig.cmake file)
EXTERNAL_CableSwig_DIR Set this variable to your CableSwig binary tree for Python wrapping (the directory containing the CableSwigConfig.cmake file)
EXTERNAL_DCMTK_DIR Set this variable to your DCMTK binary tree (the directory containing the DCMTKConfig.cmake file)
EXTERNAL_GDCM_DIR Set this variable to your GDCM binary tree (the directory containing the GDCMConfig.cmake file)
EXTERNAL_ITK_DIR Set this variable to your ITK binary tree (the directory containing the ITKConfig.cmake file)
EXTERNAL_OpenCV_DIR Set this variable to your OpenCV binary tree (the directory containing the OpenCVConfig.cmake file)
EXTERNAL_VTK_DIR Set this variable to your VTK binary tree (the directory containing the VTKConfig.cmake file)

To set CMake options before the first configure step is invoked, supply them on the command line, i.e.

ccmake -DITK_DIR:PATH=/opt/ITK-release ../MITK

Table of Contents