Skip to content

Commit 1e388f5

Browse files
authored
Update README to clarify tutorial aim and library config
Clarified the aim of the tutorial and added information about the configuration file for library tools.
1 parent 81bf301 commit 1e388f5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The notebooks presented here aim to serve as a guide to use the `nsbi-common-uti
4242
<br/>
4343
<br/>
4444

45-
The aim is to demonstrate the usage of `nsbi-common-utils` applied to a full-scale LHC analysis. The physics results presented in the notebooks only serve as examples of the workflow. The code in this tutorial is partially derived from the original ATLAS analysis code written by Jay Sandesara [[git](https://github.com/JaySandesara)], R.D. Schaffer [[git](https://gitlab.cern.ch/schaffer)] and Arnaud Maury [[git](https://github.com/Maury98)].
45+
We demonstrate the usage of `nsbi-common-utils` applied to a full-scale LHC analysis. The physics results presented in the notebooks only serve as examples of the workflow. The code in this tutorial is partially derived from the original ATLAS analysis code written by Jay Sandesara [[git](https://github.com/JaySandesara)], R.D. Schaffer [[git](https://gitlab.cern.ch/schaffer)] and Arnaud Maury [[git](https://github.com/Maury98)].
4646

4747
The workflow currently uses the ttbar open data released by CMS, and the Higgs to tau tau dataset from FAIR universe challenge. More open datasets will be added in the future.
4848

@@ -54,6 +54,8 @@ To use the library `nsbi_common_utils` developed here in general cases outside o
5454
python -m pip install --upgrade 'nsbi-common-utils @ git+https://github.com/iris-hep/NSBI-workflow-tutorial.git'
5555
```
5656

57+
The library tools are steered by a configuration file - an example can be found in the FAIR Universe Challenge workflow [config.yml](https://github.com/iris-hep/NSBI-workflow-tutorial/blob/main/FAIR_universe_Higgs_tautau/config.yml).
58+
5759
Workflow bluprint (**tentative**):
5860

5961
![NSBI_flowchart](https://github.com/user-attachments/assets/f9bd85be-10d8-487b-a7ed-1bdd3028fb4e)

0 commit comments

Comments
 (0)