This page explains how to build ULIS from source.
ULIS favors the use of CMake to manage the build process, so this document shows how to generate project files and compile using it.
It is possible to setup your own custom build process, but this is not covered here.

Requirements

ULIS is meant to be used with desktop software applications on modern architectures, for processors supporting x86-64, and with 64-bit operating systems.
There is no guaranty that ULIS is able to compile and run for other platforms such as Android or embedded systems.

Softwares

The following softwares are required in order to collect and build ULIS from source:

CMake
git

Operating Systems

The following operating systems are officially supported, both as target platforms and hosts for compiling the library. They are tested on a regular basis:

Windows
- Windows 7
- Windows 8
- Windows 10
macOS
Linux
- Ubuntu

Compilers

The following compilers are officially supported and frequently tested:

MSVC
- 2017
- 2019
Clang/LLVM
GCC
MinGW GCC

Getting Started

First and foremost, you have to clone the repo and checkout a stable commit, we recommend building the release and not the latest dev state, unless you are willing to contribute or try the possibly unstable latest features. Then the build process is very similar for all the following platforms.
The steps involved describe commands typed in the shell or command prompt, assuming both cmake and git are available from the path.
This is the typical out of source build process with CMake:

git clone https://github.com/Praxinos/ULIS
cd ULIS
git checkout release
cd ..
mkdir ULIS_Build
cd ULIS_Build
cmake -G "Generator" ../ULIS

Here is a list of CMake generators and documentation

Windows

The following sections describes the step-by-step process for Windows.

Visual Studio 15 2017 - MSVC

git clone https://github.com/Praxinos/ULIS
mkdir ULIS_Build
cd ULIS_Build
cmake -G "Visual Studio 15 2017 Win64" ../ULIS

Visual Studio 16 2019 - MSVC

git clone https://github.com/Praxinos/ULIS
mkdir ULIS_Build
cd ULIS_Build
cmake -G "Visual Studio 16 2019" -A x64 ../ULIS

Visual Studio - Clang/LLVM

git clone https://github.com/Praxinos/ULIS
mkdir ULIS_Build
cd ULIS_Build
cmake -G "Visual Studio 15 2017 Win64" -T"llvm" ../ULIS

MinGW Makefiles - GCC

git clone https://github.com/Praxinos/ULIS
mkdir ULIS_Build
cd ULIS_Build
mkdir Release
cd Release
cmake -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release ../../ULIS
cd ..
mkdir Debug
cd Debug
cmake -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Debug ../../ULIS

macOS

The following sections describes the step-by-step process for macOS.

Xcode - Clang/LLVM

git clone https://github.com/Praxinos/ULIS
mkdir ULIS_Build
cd ULIS_Build
cmake -G "Xcode" ../ULIS

Linux

The following sections describes the step-by-step process for Linux.

Sublime Text2 - Unix Makefiles - GCC

git clone https://github.com/Praxinos/ULIS
mkdir ULIS_Build
cd ULIS_Build
mkdir Release
cd Release
cmake -G "Sublime Text 2 - Unix Makefiles" -DCMAKE_BUILD_TYPE=Release ../../ULIS
cd ..
mkdir Debug
cd Debug
cmake -G "Sublime Text 2 - Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug ../../ULIS

Additional Build Options

On top of the default CMake generation process, you can specify more build options to customize your build or enable or disable components in the ULIS library.

Option Name	Type	Default	Meaning
ULIS_BUILD_SHARED	BOOL	ON	Wether to build dynamic library or not.
ULIS_BUILD_PYTHON_MODULE	BOOL	OFF	Wether to generate and build the python binding or not.
ULIS_BUILD_TESTS	BOOL	OFF	Wether to generate and build the tests or not.
ULIS_BUILD_SAMPLES	BOOL	OFF	Wether to generate and build the samples or not.
ULIS_FORCE_ASSERTS	BOOL	OFF	Wether to force asserts in RelWithDebInfo or Release builds or not ( recommended for RelWithDebInfo ).
ULIS_BINARY_PREFIX	STRING	""	Indicates a prefix for the output binaries.
ULIS_QT_CMAKE_PATH	STRING	""	The path to Qt, needed for the samples and some tests.
ULIS_PYTHON_REL_LIB	STRING	""	The path to python release libraries.
ULIS_PYTHON_DEB_LIB	STRING	""	The path to python debug libraries.
ULIS_PYTHON_INCLUDE_PATH1	STRING	""	The path to python headers.
ULIS_PYTHON_INCLUDE_PATH2	STRING	""	Extra path to python headers.

This is an example for Windows, Visual Studio 16 2019 - MSVC, with all options:

git clone https://github.com/Praxinos/ULIS
mkdir ULIS_Build
cd ULIS_Build
cmake   -G "Visual Studio 16 2019"                                                              ^
        -A x64                                                                                  ^
        -DULIS_BUILD_SHARED=ON                                                                  ^
        -DULIS_BUILD_PYTHON_MODULE=ON                                                           ^
        -ULIS_BUILD_TESTS=ON                                                                    ^
        -ULIS_BUILD_SAMPLES=ON                                                                  ^
        -DULIS_QT_CMAKE_PATH:STRING="C:/Qt/5.12.6/msvc2017_64/lib/cmake/"                       ^
        -DULIS_PYTHON_REL_LIB:STRING="C:/Users/xxx/work/cpython/PCbuild/amd64/python39.lib"     ^
        -DULIS_PYTHON_DEB_LIB:STRING="C:/Users/xxx/work/cpython/PCbuild/amd64/python39_d.lib"   ^
        -DULIS_PYTHON_INCLUDE_PATH1:STRING="C:/Users/xxx/work/cpython/Include/"                 ^
        -DULIS_PYTHON_INCLUDE_PATH2:STRING="C:/Users/xxx/work/cpython/PC/"                      ^
        ../ULIS

Table of Contents