rntviewer/README.md

rntviewer

This is a work-in-progress interactive visualization tool for RNTuple.

Getting the repo

Clone this repository with

$ git clone --recurse-submodules <repo_url>

Dependencies

rntviewer currently only works on Linux (PRs welcome).

The dependencies are:

• GLFW3 (libglfw3-dev on debian, glfw-devel on fedora, glfw on arch)
• ROOT (likely bleeding edge version, compiled from sources)
• libxxhash3-dev

Other than those, rntviewer depends on Dear ImGui and GLAD (both included in the source tree).

The machine must support OpenGL 4.

Building

Building is done with make. Make sure to source /path/to/root/bin/thisroot.sh before running it. You probably want to build the release version:

$ make r

You can test that the tool is working properly with:

$ ./rntviewer ntpl lmext1.root

Usage

Basic usage is:

$ ./rntviewer <ntuple_name> <ntuple_file.root>

This will open a window and let you browse the RNTuple, jump around its sections and get some information about them.

There is also a non-interactive non-graphical mode that can be used in a terminal (useful e.g. for ssh sessions):

$ ./rntviewer -t <ntuple_name> <ntuple_file.root>

The -t flag enables terminal mode. Use ./rntviewer -h to get a help message about the other flags that rntviewer accepts and are particularly useful in non-interactive mode.