
                      CUBE LIBRARY INSTALL GUIDE
                      ==========================

This file describes how to configure, compile, and install the Cube Profile
library (CubeLib) using cmake.

Prerequisites
=============

To build CubeLib, various tools and packages are required:

  * ISO C++11 compiler (gcc >=4.9)
  * A "working" POSIX-compatible shell
  * cmake >= 3.16


Optionally, CubeLib can be configured to use the following support
libraries:

  * zlib library v1.2.3 or newer        (http://www.zlib.net/)

       The zlib library is only needed if the perfromance data should be compressed.
       Keep in mind that this might lead to lower performance.
       In cross-compiling environments, zlib has to be compiled for
       the compute nodes (i.e., backend).

Quick start
===========

In a nutshell, configuring, building, and installing CubeLib can be as
simple as executing the shell commands

    cmake -S . -B <build-dir> -DCMAKE_INSTALL_PREFIX=<installdir>
    cmake --build <build-dir> --target install

All cubelib specific options start with CUBELIB_ and can be changed in
CMakeCache.txt.

Particular systems
==================

Cube has been tested on Windows using Qt with MingW. Use the option -G "MinGW Makefiles"
to replace the default cmake generator nmake.
   cmake -S . -B <build-dir> -G "MinGW Makefiles"
