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

This file describes how to configure, compile, and install the Cube Profile
writer library (CubeW).
Crosscompiling is not supported yet. Use the autoconf build system, if this
is required.

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

To build CubeW, various tools and packages are required:

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


Optionally, CubeW 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 performance 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 CubeW can be as
simple as executing the shell commands

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

On Windows platform one might need to add an additional parameter
      cmake -S . -B <build-dir> -DCMAKE_INSTALL_PREFIX=<installdir> -G "MinGW Makefiles"