
                             Cube GUI v4.9 README
                             ====================

Cube GUI is a graphics explorer for display and analysis of a multi-dimensional
performance space consisting of the dimensions (i) performance metric, (ii) call
path, and (iii) system resource. Each dimension can be represented as a tree,
where non-leaf nodes of the tree can be collapsed or expanded to achieve the
desired level of granularity.

Cube GUI is released as open source under a BSD-style license.
Please see the COPYING file in the package base directory for details.


Installation
============

See the INSTALL file for detailed information about how to configure, build
and install Cube GUI.

User Documentation
==================

Cube GUI documentation for a specific installation is by default
installed into the '$CUBEGUI_ROOT/share/doc/cubegui' subdirectory.  At
present, however, user documentation is still limited.

 * Cube GUI User Guide
    (CubeUserGuide.pdf | guide/html/index.html):

   The Cube GUI User Guide is currently being rewritten and still incomplete.
   However, it should already contain enough information to get you started and
   avoid the most common pitfalls.

 * Cube GUI Plugins User Guide
    (CubePluginsUserGuide.pdf | plugins-guide/html/index.html):

   The Cube GUI Plugins Guide is currently being rewritten and still incomplete.
   However, it should already contain enough information to get you started and
   avoid the most common pitfalls.


 * Cube GUI open issues & limitations (OPEN_ISSUES):

   Compendium of known limitations and unimplemented features that may affect
   Cube GUI usability on various platforms or with certain
   applications, with suggested workarounds where appropriate.  Although issues
   may be uncommon and/or quite technically complex, users are encouraged to
   briefly review this document, particularly if they believe they have
   encountered a problem when using Cube GUI, prior to contacting
   user support.


Web page & Contact
==================

For further more detailed information on Cube GUI see the
project webpages at

        http://www.scalasca.org/

For help, reporting bugs, and making comments or suggestions send an e-mail to

        scalasca@fz-juelich.de
