Skip to content

Commit e0279cd

Browse files
committed
Dependency finder: Update documentation
1 parent fe620e0 commit e0279cd

3 files changed

Lines changed: 44 additions & 43 deletions

File tree

docs/tools/TRACKSELECTION.png

228 KB
Loading

docs/tools/dependencyFinder.md

Lines changed: 44 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ optional arguments:
3535
-c be case-sensitive with table names
3636
-g {pdf,svg,png} make a topology graph in a given format
3737
-x EXCLUDE [EXCLUDE ...]
38-
tables and workflows to exclude
38+
name patterns of tables and workflows to exclude
3939
-l LEVELS maximum number of workflow tree levels (default = 0, include all if < 0)
4040
```
4141

@@ -54,12 +54,14 @@ The backward mode searches for **parents** of the given object in the dependency
5454

5555
Gives a list of workflows that produce a given table.
5656

57+
If the origin prefix is not provided, it is assumed to be `AOD`.
58+
5759
Example: `-t BC_001`
5860

5961
```text
60-
Table: BC_001
62+
Table: AOD/BC_001
6163
62-
BC_001 <- ['o2-analysis-bc-converter']
64+
AOD/BC_001 <- ['o2-analysis-bc-converter']
6365
```
6466

6567
Examples of use:
@@ -76,7 +78,7 @@ Example: `-w o2-analysis-bc-converter`
7678
```text
7779
Workflow: o2-analysis-bc-converter
7880
79-
o2-analysis-bc-converter <- ['BC']
81+
o2-analysis-bc-converter <- ['AOD/BC']
8082
```
8183

8284
Examples of use:
@@ -92,12 +94,14 @@ The forward mode searches for **children** of the given object in the dependency
9294

9395
Gives a list of workflows that consume a given table.
9496

97+
If the origin prefix is not provided, it is assumed to be `AOD`.
98+
9599
Example: `-T BC`
96100

97101
```text
98-
Table: BC
102+
Table: AOD/BC
99103
100-
BC -> ['o2-analysis-bc-converter']
104+
AOD/BC -> ['o2-analysis-bc-converter']
101105
```
102106

103107
Examples of use:
@@ -114,7 +118,7 @@ Example: `-W o2-analysis-bc-converter`
114118
```text
115119
Workflow: o2-analysis-bc-converter
116120
117-
o2-analysis-bc-converter -> ['BC_001']
121+
o2-analysis-bc-converter -> ['AOD/BC_001']
118122
```
119123

120124
Examples of use:
@@ -132,58 +136,55 @@ If the provided number is negative, all levels are considered.
132136

133137
If not provided, only direct dependencies (`-l 0`) are considered.
134138

135-
Example: `-t timestamps -l 1`
139+
Example: `-w o2-analysis-timestamp -l 1`
136140

137141
```text
138-
Table: timestamps
139-
140-
timestamps <- ['o2-analysis-timestamp']
141-
142-
Workflow dependency tree:
142+
Workflow: o2-analysis-timestamp
143143
144-
o2-analysis-timestamp <- ['BC_001']
145-
BC_001 <- ['o2-analysis-bc-converter']
146-
o2-analysis-bc-converter <- ['BC']
144+
o2-analysis-timestamp <- ['AOD/BC_001']
145+
AOD/BC_001 <- ['o2-analysis-bc-converter']
146+
o2-analysis-bc-converter <- ['AOD/BC']
147147
```
148148

149149
## Exclude (`-x`)
150150

151-
Workflows and tables can be excluded from the search using the `-x` option.
151+
Workflows and tables can be excluded from the search using the `-x` option which supports regular expressions.
152+
153+
Whitelisting can be achieved using the negative lookahead `(?!...)`.
154+
155+
Example: `-T TRACKSELECTION -x 'o2-analysis(?!-em-)'` finds workflows that consume the `TRACKSELECTION` table and their name contains `o2-analysis-em-`.
156+
157+
```text
158+
Table: AOD/TRACKSELECTION
159+
160+
AOD/TRACKSELECTION -> ['o2-analysis-em-omega-meson-emc', 'o2-analysis-em-efficiency-ee', 'o2-analysis-em-mc-templates', 'o2-analysis-em-heavy-neutral-meson']
161+
```
152162

153163
## Graphical output (`-g`)
154164

155165
The dependency tree can be visualised in a graph. (Requires [Graphviz](https://graphviz.org/) installed.)
156166

157-
Example: `-w o2-analysis-event-selection -l 1 -x o2-analysis-onthefly-tracker o2-analysis-track-propagation-tester -g png`
167+
Example: `-t TRACKSELECTION -l 1 -x converter onthefly alice3 run2 service -g png`
158168

159169
```text
160-
Workflow: o2-analysis-event-selection
161-
162-
o2-analysis-event-selection <- ['BC_001', 'FDD_001', 'FT0', 'FV0A', 'FV0C', 'RUN2BCINFO_001', 'TIMESTAMPS', 'ZDC_001', 'BCSEL', 'COLLISION_001', 'TRACK', 'TRACKEXTRA_002', 'TRACK_IU']
163-
BC_001 <- ['o2-analysis-bc-converter']
164-
o2-analysis-bc-converter <- ['BC']
165-
FDD_001 <- ['o2-analysis-fdd-converter']
166-
o2-analysis-fdd-converter <- ['FDD']
167-
RUN2BCINFO_001 <- ['o2-analysis-run2bcinfos-converter']
168-
o2-analysis-run2bcinfos-converter <- ['RUN2BCINFO']
169-
TIMESTAMPS <- ['o2-analysis-timestamp']
170-
o2-analysis-timestamp <- ['BC_001']
171-
ZDC_001 <- ['o2-analysis-zdc-converter']
172-
o2-analysis-zdc-converter <- ['BC_001', 'ZDC']
173-
BCSEL <- ['o2-analysis-event-selection']
174-
COLLISION_001 <- ['o2-analysis-collision-converter']
175-
o2-analysis-collision-converter <- ['COLLISION']
176-
TRACK <- ['o2-analysis-track-propagation']
177-
o2-analysis-track-propagation <- ['BC_001', 'COLLISION_001', 'MCPARTICLE_001', 'MCTRACKLABEL', 'TIMESTAMPS', 'TRACKCOV_IU', 'TRACKEXTRA_002', 'TRACK_IU']
178-
TRACKEXTRA_002 <- ['o2-analysis-tracks-extra-v002-converter']
179-
o2-analysis-tracks-extra-v002-converter <- ['TRACKEXTRA', 'TRACKEXTRA_001', 'TRACKEXTRA_002']
180-
181-
Making dot file in: o2-analysis-event-selection.gv
182-
Making graph in: o2-analysis-event-selection.png
170+
Table: AOD/TRACKSELECTION
171+
172+
AOD/TRACKSELECTION <- ['o2-analysis-trackselection']
173+
174+
Workflow dependency tree:
175+
176+
o2-analysis-trackselection <- ['AOD/TRACK', 'AOD/TRACKDCA', 'AOD/TRACKEXTRA_002']
177+
AOD/TRACK <- ['o2-analysis-track-propagation']
178+
o2-analysis-track-propagation <- ['AOD/BC_001', 'AOD/COLLISION_001', 'AOD/MCPARTICLE_001', 'AOD/MCTRACKLABEL', 'AOD/TIMESTAMPS', 'AOD/TRACKCOV_IU', 'AOD/TRACKEXTRA_002', 'AOD/TRACK_IU']
179+
AOD/TRACKDCA <- ['o2-analysis-trackextension', 'o2-analysis-track-propagation']
180+
o2-analysis-trackextension <- ['AOD/BC_001', 'AOD/COLLISION_001', 'AOD/TIMESTAMPS', 'AOD/TRACK', 'AOD/TRACKEXTRA_002']
181+
182+
Making dot file in: TRACKSELECTION.gv
183+
Making graph in: TRACKSELECTION.png
183184
```
184185

185-
The output graph `o2-analysis-event-selection.png` is shown below:
186+
The output graph `TRACKSELECTION.png` is shown below:
186187

187188
<div align="center">
188-
<img src="o2-analysis-event-selection.png" width="1200px" alt="o2-analysis-event-selection">
189+
<img src="TRACKSELECTION.png" width="1000px" alt="TRACKSELECTION">
189190
</div>
-350 KB
Binary file not shown.

0 commit comments

Comments
 (0)