Recommended build procedure

Make sure you:

Are on a Supported Platforms.
Fulfill the Prerequisites .
Have a github account with SSH authentication.

Choose a root folder for the project. It will be populated as described in Superbuild Folder Structure.

Then run the following commands:

    cd \<root_dir\>
    git clone git@github.com:SINTEFMedTek/CustusX.git CX/CX
    ./CX/CX/install/cxInstaller.py --full --all -t Release

Run cxInstaller.py -h for more options.

Prerequisites

CMake
Qt5 including the sqlite plugin.
openCL
boost
doxygen
cppunit
...

These must be installed prior to installing CustusX.

Several other libraries (see External libraries) are part of the Superbuild, and thus does not need to be installed separately.

For convenience, setup scripts for some platforms are available in the repository. They will help setup a machine from scratch, but might give you more than you expected. Look for your platform in install/platforms.

If you run into trouble, try building VTK, then CTK and run an example application, ctkPluginBrowser for instance. There is a wealth of resources on the net describing how to compile these projects. If this fails, try the specific resources on CustusX.

Superbuild Folder Structure

The default CustusX folder structure differs from the standard CMake source+build structure. All libraries, CustusX included, are placed within a root folder, with source and build folders grouped according to library.

The CustusX Superbuild defines and sets up this structure. It is fully possible to use a different structure, in that case you must configure cmake yourself.


root	CX	CX
		build_Release
	VTK	VTK
		build_Release
	CTK	CTK
		build_Release
	some_lib	some_lib
		build_Release