You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,14 @@ Eventually, we will also provide a set of reference `.root` and `.json` files (s
11
11
> Its structure and implementation may change during development.
12
12
> We welcome early feedback on the current state from any interested party.
13
13
14
+
## Test Categories
15
+
16
+
Tests in the RNTuple Validation Suite are organized into (nested) *categories*.
17
+
This is mirrored by the hierarchical directory layout in the repository.
18
+
For example, the [`types`](types) directory contains tests related to type support in the RNTuple specification.
19
+
It has subdirectories for tests concerning [fundamental types](types/fundamental) and C++ types, for example [`std::vector`](types/vector).
20
+
More tests are planned in the future, please [consult the list of issues](https://github.com/root-project/rntuple-validation/issues) in the GitHub repository.
21
+
14
22
## Reference Implementation
15
23
16
24
This repository also contains a reference implementation with ROOT macros.
@@ -19,3 +27,13 @@ In this release, the API is not yet finalized and all classes are in the `ROOT::
19
27
We plan to rely on this version until a first version of the RNTuple Validation Suite is done.
20
28
Then we will produce a first set of reference files that can be used to test backwards compatibility.
21
29
Afterwards, the implementation will be updated for the stable API (expected in ROOT v6.36).
30
+
31
+
### How to Run
32
+
33
+
For each test, we implement a `write.C` and `read.C` macro in the corresponding subdirectory.
34
+
The `write.C` macro produces a `.root` file with the contents as described in the `README` of each test subdirectory.
35
+
The `read.C` macro produces a `.json` file with a human-readable representation of the data in the `.root` file.
36
+
They can be run individually or all at once with `make` using the top-level [`Makefile`](Makefile).
37
+
The latter is also exercised by a GitHub Actions Workflow:
0 commit comments