CubeGUI -- A Qt-based graphical explorer to view performance profiles

Thyre commented 1 month ago

Software Name

Cube GUI

Public URL

General URL: https://www.scalasca.org/scalasca/software/cube-4.x/download.html
Link to tarball: https://apps.fz-juelich.de/scalasca/releases/cube/4.8/dist/cubegui-4.8.2.tar.gz

Technical Overview

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 would be a great addition to OpenHPC, as it would allow users to better use both Score-P and Scalasca, both already being part of the OpenHPC repositories, view their results and get additional information.

Latest stable version number

v4.8.2

Open-source license type

BSD 3-Clause "New" or "Revised" License

Relationship to component?

[ ] contributing developer
[ ] user
[x] other

If other, please describe:

I'm not directly a developer of the software myself, but the people working on it are in my working group and I have close contact.

Build system

[x] autotools-based
[ ] CMake
[ ] other

If other, please describe:

Cube GUI will eventually also support installing via CMake, but the preferred installation method (for Linux) will stay at autotools-based for now.

Does the current build system support staged path installations? For example: make install DESTIR=/tmp/foo (or equivalent)

[x] yes
[ ] no

Does component run in user space or are administrative credentials required?

[x] user space
[ ] admin

Does component require post-installation configuration.

[ ] yes
[x] no

If yes, please describe briefly:

If component is selected, are you willing and able to collaborate with OpenHPC maintainers during the integration process?

[x] yes
[ ] no

Sure! I already discussed this with @adrianreber at ISC 2024 for a bit. I am willing to try to both provide new versions of our tools and update them once new versions come out. I've recently started to update the Fedora packages for Score-P and OPARI2 for the same reason.

Does the component include test collateral (e.g. regression/verification tests) in the publicly shipped source?

[ ] yes
[x] no

If yes, please briefly describe the intent and location of the tests.

Does the component have additional software dependencies (beyond compilers/MPI) that are not part of standard Linux distributions?

[x] yes
[ ] no

If yes, please list the dependencies and associated licenses.

Cube GUI requires having CubeLib, which is currently packaged as a part of Score-P in your OpenHPC repository. During integration of Cube GUI, I would also advise moving away from using the additional vendor dependencies in Score-P itself to install the dependencies as separate packages. This would allow upgrading the Cube libraries without needing to wait for another Score-P release.

The dependencies can all be found on the same webpage and include similar licenses.

Does the component include online or installable documentation?

[x] yes
[ ] no

If available online, please provide URL.

User Guide: https://apps.fz-juelich.de/scalasca/releases/cube/4.8/docs/CubeUserGuide.pdf
Install instructions: https://apps.fz-juelich.de/scalasca/releases/cube/4.8/INSTALL-cubegui.txt

[Optional]: Would you like to receive additional review feedback by email?

- [x] yes - [ ] no

adrianreber commented 1 month ago

@mghpcsim Can you add this to the next TSC meeting agenda? I cannot join, but I am definitely in favour of accepting this submission.

Thyre commented 2 weeks ago

Just for completeness, I've had a look at how difficult it would be to build a package. Disregarding tests (which probably would mostly involve checking the module via test_module), the addition seems to be straight-forward:

openhpc / submissions