Skip to content

Documentation

Here you can find the documentation for the latest stable releases of the Cube components.

Installation

The Cube components use a build system based on GNU Autotools, customized to the specific needs on HPC systems. Detailed instructions on how to configure and build the various packages can be found in their installation guides.

Component Instruction instructions
Cube C Writer library Install Guide
Cube C++ library & tools Install Guide
Cube GUI Install Guide
Cube Java Reader library Install Guide

We also contribute and maintain build recipes for the Spack and EasyBuild frameworks, which are frequently used to install software in HPC environments. In addition, the latest Cube releases are also available via Homebrew:

    $ brew install fzj-jsc/scalasca/<component>
with <component> being one of cubew (Cube C Writer library), cubelib (Cube C++ library & tools), cubegui (Cube GUI), or simply cube (bundle of all three components).

Usage

To get started with using the Cube GUI and command-line tools, please take a look at the respective User Guides.

Component Documentation
Cube GUI User Guide (HTML) User Guide (PDF)
Cube command-line tools User Guide (HTML) User Guide (PDF)
Cube derived metrics User Guide (HTML) User Guide (PDF)

Plugin development

In case you want to develop your own plugins for the Cube GUI, please consult the Cube Plugins Developer Guide.

Developer Guide (HTML) Developer Guide (PDF)

Additional information