silverweed/rntviewer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
silverweed 2024-07-25 18:02:31 +02:00
parent 2c5471e05f
commit 4918c152b5
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -34,6 +34,19 @@ $ ./rntviewer ntpl lmext1.root
``` ```
### Usage ### Usage
Basic usage is:
``` ```
$ ./rntviewer <ntuple_name> <ntuple_file.root> $ ./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.