Skip to content

Commit 6d66b2f

Browse files
committed
Update docs
1 parent 9a93859 commit 6d66b2f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

Tutorials/PWGHF/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Welcome to the heavy-flavour analysis tutorial!
66

77
This directory contains the code and configuration for running a minimalistic version of the D<sup>0</sup> analysis on Run 3 data.
88

9-
See the [official PWG-HF O<sup>2</sup> documentation](https://aliceo2group.github.io/analysis-framework/docs/advanced-specifics/pwghf.html) for the overview of the full heavy-flavour analysis framework.
9+
See the [PWG-HF O<sup>2</sup> documentation](https://aliceo2group.github.io/analysis-framework/docs/advanced-specifics/pwghf.html) for the overview of the full heavy-flavour analysis framework.
1010

1111
## Setup
1212

@@ -30,10 +30,10 @@ This table contains paired track indices which point to tracks in the track tabl
3030
These derived skims are produced by executing the [`run_skim.sh`](run_skim.sh) bash script in the working directory:
3131

3232
```bash
33-
bash ~/alice/O2Physics/Tutorials/PWGHF/run_skim.sh
33+
~/alice/O2Physics/Tutorials/PWGHF/run_skim.sh
3434
```
3535

36-
It will use the configuration from [`dpl-config_skim.json`](dpl-config_skim.json) and produce the `AnalysisResults_trees.root` file with the derived table and the `AnalysisResults.root` file with control histograms in the working directory.
36+
It processes files specified in `./input_skim.txt`, uses the configuration from [`dpl-config_skim.json`](dpl-config_skim.json), and produces the `./AnalysisResults_trees.root` file with the derived table and the `./AnalysisResults.root` file with control histograms.
3737

3838
## Mini task
3939

@@ -52,19 +52,21 @@ The absolute path to the parent file is stored in the derived file but it can be
5252
Run the mini task by executing the [`run_task.sh`](run_task.sh) bash script in the working directory:
5353

5454
```bash
55-
bash ~/alice/O2Physics/Tutorials/PWGHF/run_task.sh
55+
~/alice/O2Physics/Tutorials/PWGHF/run_task.sh
5656
```
5757

58-
It will use the configuration from [`dpl-config_task.json`](dpl-config_task.json) and produce the output file `AnalysisResults.root` with histograms in the working directory.
58+
It processes files specified in `./input_task.txt`, uses the configuration from [`dpl-config_task.json`](dpl-config_task.json), and produces the `./AnalysisResults.root` file with histograms.
5959

6060
## Exercise tips
6161

6262
Organise your working environment so that you can easily switch between running the code in the working directory and modifying the code in the O2Physics repository.
6363

64-
When you execute the bash script, the terminal output is saved in the `stdout.log` log file in the working directory.
64+
When you execute the bash script, the terminal output is saved in the `./stdout.log` log file.
6565
If an error occurs, the script will report the non-zero exit code and ask you to check the log file to find the problem.
66+
If you get errors that have to be tolerated, you need to remove the `--min-failure-level error` option from the command.
6667

67-
The full O<sup>2</sup> configuration is dumped at the end of processing into the `dpl-config.json` file in the working directory.
68+
The full O<sup>2</sup> configuration is dumped at the end of processing into the `./dpl-config.json` file.
69+
It is useful to compare it with the input configuration file to spot mismatches.
6870

6971
See the [rebuilding instructions](https://aliceo2group.github.io/analysis-framework/docs/gettingstarted/installing.html#building-partially-for-development-using-ninja) in the analysis framework documentation for advice on compiling your code changes.
7072

0 commit comments

Comments
 (0)