Skip to content

Commit 0ae83df

Browse files
committed
Updated list of tags and reformatted details. Updated in use cases too.
1 parent 75b5a8e commit 0ae83df

2 files changed

Lines changed: 61 additions & 43 deletions

File tree

_episodes/02-rucio_usage.md

Lines changed: 50 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -188,48 +188,64 @@ The following tags are available as of March 2026:
188188
189189
- **software\_release**
190190
- Software release used in the simulation. Written as a container version tag/simulation campaign naming:
191-
- v**YY**.**MM**.**v**
192-
- E.g. v25.06.2 -> June 2025 software container, version 2
191+
- **YY**.**MM**.**v**
192+
- E.g. 25.06.2-stable -> June 2025 software container, version 2
193+
- **is\_background\_mixed**
194+
- True/false depending upon whether sample includes any background mixing
195+
- **data\_level**
196+
- Level of simulation data, `simulation` or `reconstruction`
197+
- **geometry\_config**
198+
- Geometry config tag, e.g. `craterlake_18x275`, `craterlake_5x41_He3`
199+
- **generator**
200+
- MC event generator used to generate the simulated data
201+
- `pythia6`, `pythia8`, `beagle`, `djangoh`, `rapgap`, `dempgen`, `sartre`, `lager`, `estarlight`, `eic_sr_geant4`, `eic_esr_xsuite`, `sherpa`, `single_particle`, `other`
193202
- **requester\_pwg**
194203
- Defines the physics working group (PWG) that the simulated data relates to, options are:
195-
- edt (exclusive, diffractive and tagging)
196-
- inclusive
197-
- jets\_hf
198-
- semi\_inclusive
199-
- ew\_bsm
200-
- other
204+
- `edt` (exclusive, diffractive and tagging), `inclusive`, `jets_hf`, `semi_inclusive`, `ew_bsm`, `other`
201205
- **Can be one or more**
202-
- **q2\_min**
203-
- Minumum Q2 value (GeV^2) in the simulation file, entered as a number.
204-
- **Optional tag** - Not all simulated files use this
205-
- **q2\_max**
206-
- Maximum Q2 value (GeV^2) in the simulation file, entered as a number.
207-
- **Optional tag** - Not all simulated files use this
208-
- **electron\_beam\_energy**
206+
- Skipped for SINGLE/BACKGROUNDS
207+
- **requester\_dsc**
208+
- Detector subsystem collaboration requester
209+
- `tracking`, `other`
210+
- Set to `tracking` for background related datasets
211+
- **electron\_beam\_energy\_gev**
209212
- Electron beam energy in GeV
210-
- **ion\_beam\_energy**
213+
- **ion\_beam\_energy\_gev**
211214
- Ion/nucleus beam energy in GeV
212-
- **is\_background\_mixed**
213-
- True/false depending upon whether sample includes any background mixing
214215
- **ion\_species**
215216
- Ion species in the simulation, defaults to `p`, proton, if not specified
216217
- Typed as formatted in files, e.g. `Au197` for gold, `He3` for helium 3 etc.
217218
- `Cu63`, `H2`, `Ru96` and `p` are some other options
218-
- **generator**
219-
- MC event generator used to generate the simulated data
220-
- E.g. Pythia8, Herwig etc
221-
- Entered as all lower case
222-
- E.g. `dempgen` *not* `DEMPgen`
223-
224-
As noted on some items in this list, some tags are optional and may not be applied to all datasets. However, the following tags are **required** for all datasets:
219+
- **q2\_min\_gev2**
220+
- Minimum Q2 value (GeV^2) in the simulation file, entered as a number.
221+
- **q2\_max_gev2**
222+
- Maximum Q2 value (GeV^2) in the simulation file, entered as a number.
223+
- **gun\_particle**
224+
- Single particle type
225+
- `e-`, `e+`, `proton`, `neutron`, `pi+`, `pi-`, `pi0`, `kaon-`, `kaon+`, `gamma`, `mu-`
226+
- **gun\_momentum\_min\_gev**
227+
- Minimum gun momentum in GeV
228+
- **gun\_momentum\_max\_gev**
229+
- Maximum gun momentum in GeV
230+
- **gun\_theta\_min\_deg**
231+
- Minimum gun polar angle in degrees
232+
- **gun\_theta\_max\_deg**
233+
- Maximum gun polar angle in degrees
234+
- **gun\_phi\_min\_deg**
235+
- Minimum gun azimuthal angle in degrees, default 0
236+
- **gun\_phi\_max\_deg**
237+
- Maximum gun azimuthal angle in degrees, default 360
238+
- **gun\_distribution**
239+
- Type of distribution for particle gun
240+
- `uniform`, `cos(theta)`, `eta`, `pseudorapidity`, `ffbar`
241+
242+
Most of the tags in this list are optional and may not be applied to all datasets. However, the following tags are **required** for all datasets:
225243
226-
- software\_release
227-
- physics\_process
228-
- electron\_beam\_energy
229-
- ion\_beam\_energy
230-
- is\_background\_mixed
231-
- ion\_species
232-
- generator
244+
- **software\_release**
245+
- **is\_background\_mixed**
246+
- **data\_level**
247+
- **geometry\_config**
248+
- **generator**
233249
234250
Note that as mentioned for the generator, tags are entered in lower case, **with the exception of ion species**.
235251
@@ -242,13 +258,13 @@ rucio did list --filter 'TAG==*' 'scope:*'
242258
So, as an example, we could list all DIDs with electron beam energies of 10 GeV via:
243259
244260
```bash
245-
rucio did list --filter 'electron_beam_energy==10' 'epic:*'
261+
rucio did list --filter 'electron_beam_energy_gev==10' 'epic:*'
246262
```
247263
248264
We can also combine tags and filter on several at once, e.g:
249265
250266
```bash
251-
rucio did list --filter 'electron_beam_energy==10, ion_beam_energy==250' 'epic:*'
267+
rucio did list --filter 'electron_beam_energy_gev==10, ion_beam_energy_gev==250' 'epic:*'
252268
```
253269
254270
which will return only datasets with 10x250 collisions (10 GeV electrons on 250 GeV ions using the standard ePIC conventions). We can keep adding filters in this manner as we like to really narrow down the DIDs we return with our query.

_episodes/03-use_cases.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,23 @@ To find files that meet their requirements they could utilise the following tags
3030

3131
- software\_release
3232
- requester\_pwg
33-
- electron\_beam\_energy
34-
- ion\_beam\_energy
33+
- electron\_beam\_energy\_gev
34+
- ion\_beam\_energy\_gev
3535
- ion\_species
36+
- data\_level
3637

3738
We can use these tags to filter through the DIDs and find datasets of interest:
3839

3940
```bash
40-
rucio did list --filter 'software_release==XXX, requester_pwg==YYY, electron_beam_energy==ZZ, ion_beam_energy==iii, ion_species==jjj' 'epic:*'
41+
rucio did list --filter 'software_release==XXX, requester_pwg==YYY, electron_beam_energy_gev==ZZ, ion_beam_energy_gev==iii, ion_species==jjj' 'epic:*'
4142
```
4243

4344
Where we can substitute in our chosen values for each in place of `XXX`, `YYY`, `ZZ`, `iii` and `jjj`.
4445

4546
> ## `Beam Energies:`
46-
> Whilst we can enter any number for the `electron_beam_energy` and `ion_beam_energy` values, there are only certain combinations actually in use.
47-
> `electron_beam_energy` is typically 5, 10 or 18 GeV
48-
> `ion_beam_energy` is typically 41, 100, 130, 250 or 275 GeV for protons.
47+
> Whilst we can enter any number for the `electron_beam_energy_gev` and `ion_beam_energy_gev` values, there are only certain combinations actually in use.
48+
> `electron_beam_energy_gev` is typically 5, 10 or 18 GeV
49+
> `ion_beam_energy_gev` is typically 41, 100, 130, 250 or 275 GeV for protons.
4950
> For other ion species, 110 and 166 may also be used.
5051
{: .callout}
5152

@@ -89,11 +90,12 @@ To find files that meet their requirements they could utilise the following tags
8990

9091
- software\_release
9192
- physics\_process
92-
- electron\_beam\_energy
93-
- ion\_beam\_energy
93+
- electron\_beam\_energy\_gev
94+
- ion\_beam\_energy\_gev
9495
- generator
96+
- data\_level
9597

96-
They may also want to use the `q2_min` ad `q2_max` tags, along with the `ion_species` tags to narrow down to an even more specific subset of files. They may also want to analyse files with or without background enabled.
98+
They may also want to use the `q2_min_gev2` ad `q2_max_gev2` tags, along with the `ion_species` tags to narrow down to an even more specific subset of files. They may also want to analyse files with or without background enabled.
9799

98100
As they want to process a large number of files, **it is unlikely (and not recommended) that they download a large number of files to process them locally**. Instead, they may want to stream their files directly in their analysis script. They could do this via:
99101

0 commit comments

Comments
 (0)