Skip to content

Commit 846b978

Browse files
undefined-pandahahnjo
authored andcommitted
README update
1 parent c8023d7 commit 846b978

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,31 @@ They can be run individually or all at once with `make` using the top-level [`Ma
3030
The latter is also exercised by a GitHub Actions Workflow:
3131
![Execute ROOT macros](https://github.com/root-project/rntuple-validation/actions/workflows/root.yml/badge.svg)
3232
The job also uploads the produced set of `.root` and `.json` files, which can be downloaded from the Summary page.
33+
34+
Running the complete Validation Suite with `make` creates three folders:
35+
- _dict_: contains the produced dictionaries (`.so`, `.pcm` and `.cxx` files)
36+
- _write_: contains the produced `.root` files
37+
- _read_: contains the produced `.json` files
38+
39+
Each operation can also be run individually, i.e. `make dict`, `make write` and `make read`.
40+
41+
To store results separately per version, subdirectories can be defined via the `dict_dir`, `write_dir` or `read_dir` arguments. Note that `read_dir` creates a subdirectory inside the folder named by `write_dir` within _read_. For example:
42+
```
43+
make dict_dir=6.38.00 write_dir=6.38.00 read_dir=6.38.00
44+
```
45+
produces the following structure:
46+
```
47+
dict/
48+
├── 6.38.00/
49+
├── .so
50+
├── .pcm
51+
└── .cxx
52+
write/
53+
├── 6.38.00/
54+
└── .root
55+
read/
56+
├── 6.38.00/ <- version that wrote the .root files (write_dir)
57+
└── 6.38.00/ <- version that read them and produced the .json files (read_dir)
58+
└── .json
59+
```
60+
The two-level hierarchy in _read_ reflects the cross-validation between ROOT versions: the outer directory identifies the version whose `.root` files were used as input, and the inner directory identifies the version that read them and produced the `.json` output.

0 commit comments

Comments
 (0)