Skip to content

Commit 0f0dee0

Browse files
Benedikt Volkelchiarazampolli
authored andcommitted
Update code and README
* use flags --with-test-<test> and remove the need to know the correct value of the bit mask --> replaces --test|-t option * add relative path of where single histograms are stored to JSON summary and influxDB file * pipe RelVal macro verbosity to log file to focus on cerntral status messages * do not compare branches that cannot be compared * add simple pie charts for each compared file pair per test showing the fraction of test results * udpate README accordingly wrt flags (see above) and explain plots that are created
1 parent 13efffc commit 0f0dee0

File tree

2 files changed

+142
-54
lines changed

2 files changed

+142
-54
lines changed

RelVal/README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@ If you would like to compare 2 files, simply run
4242
```bash
4343
python o2dpg_release_validation.py rel-val -i <file1> <file2> [-o <output/dir>]
4444
```
45-
This performs all of the above mentioned tests. If only certain tests should be performed, this can be achieved with the flags `--with-<which-test>` where `<which-test>` is one of
45+
This performs all of the above mentioned tests. If only certain tests should be performed, this can be achieved with the flags `--with-test-<which-test>` where `<which-test>` is one of
4646
1. `chi2`,
4747
1. `bincont`,
4848
1. `numentries`.
49+
4950
By default, all of them are switched on.
5051

5152
### Apply to entire simulation outcome
@@ -56,6 +57,7 @@ In addition to simply comparing 2 ROOT files, the script offers the possibility
5657
1. TPC tracks output,
5758
1. MC kinematics,
5859
1. MC hits.
60+
5961
**NOTE** That each single one of the comparison types if only done if mutual files were found in the 2 corresponding directories. As an example, one could do
6062
```bash
6163
cd ${DIR1}
@@ -65,12 +67,12 @@ cd ${DIR2}
6567
python o2dpg_workflow_runner.py -f <workflow-json2>
6668
python ${O2DPG_ROOT}/ReleaseValidation/o2dpg_release_validation.py rel-val -i ${DIR1} ${DIR2} [-o <output/dir>] [<test-flags>]
6769
```
68-
Again, also here it can be specified explicitly on what the tests should be run by specifying one or more `<test-flags` such as
69-
1. `--with-qc`,
70-
1. `--with-analysis`,
71-
1. `--with-tpctracks`,
72-
1. `--with-kine`,
73-
1. `--with-hits`.
70+
Again, also here it can be specified explicitly on what the tests should be run by specifying one or more `<test-flags>` such as
71+
1. `--with-type-qc`,
72+
1. `--with-type-analysis`,
73+
1. `--with-type-tpctracks`,
74+
1. `--with-type-kine`,
75+
1. `--with-type-hits`.
7476

7577
### Quick inspection
7678

@@ -87,3 +89,10 @@ To convert the final output to something that can be digested by InfluxDB, use
8789
python ${O2DPG_ROOT}/ReleaseValidation/o2dpg_release_validation.py influx --dir <rel-val-out-dir> [--tags k1=v1 k2=v2 ...] [--table-name <chosen-table-name>]
8890
```
8991
When the `--tags` argument is specified, these are injected as TAGS for InfluxDB in addition. The table name can also be specified explicitly; if not given, it defaults to `O2DPG_MC_ReleaseValidation`.
92+
93+
## Plot output
94+
95+
There are various plots created during the RelVal run. For each compared file there are
96+
* overlay plots (to be found in the sub directory `overlayPlots`),
97+
* 2D plots summarising the results in a grid view (called `SummaryTests.png`),
98+
* pie charts showing the fraction of test results per test.

0 commit comments

Comments
 (0)