Datasets-SU2020-Naming-Conventions: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Add note about how to access the private su2020 repo on github.) |
||
| (9 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
(work in progress) | (work in progress) | ||
=== Naming Conventions === | |||
Mu2e files are required to have 6 field-long names, see https://mu2ewiki.fnal.gov/wiki/FileNames for more details, example: | Mu2e files are required to have 6 field-long names, see https://mu2ewiki.fnal.gov/wiki/FileNames for more details, example: | ||
cnf.mu2e.su2020 | cnf.mu2e.dddddddddd.su2020.rrrrrr_ssssssss.art | ||
* Let's use MC run number 1000 only for all datasets | * Let's use MC run number 1000 only for all datasets | ||
* lets fix the | * lets fix the 4-th field to su2020 (lowcased) - that would allow to find handily for all su2020 datasets in SAM catalog | ||
* 1+2 fix 5 fields out of 6. | * 1+2 fix 5 fields out of 6. | ||
* It makes sense to treat the remaining field as a | * It makes sense to treat the remaining, 3-rd, field as a 10 char long dataset ID. Having fixed length dataset ID is handy | ||
: in many respects - we will need to propagate it through the whole analysis chain, from the MC files through the output | : in many respects - we will need to propagate it through the whole analysis chain, from the MC files through the output | ||
: of reconstruction to ntuples and histogram files. | : of reconstruction to ntuples and histogram files. | ||
| Line 14: | Line 16: | ||
: to be used for all practical purposes in the software. Ok, so | : to be used for all practical purposes in the software. Ok, so | ||
DDDDVsSObB (lowercased characters stay as is, uppercase - interpreted) | |||
DDDD: 4-character-long name stub (it looks that 4 chars would allow us to name meaningfully all datasets we have so far dealt with | DDDD: 4-character-long name stub (it looks that 4 chars would allow us to name meaningfully all datasets we have so far dealt with | ||
V : dataset version, i.e. 0,1,2 ... (in principle, could be anything and be used for any purpose) | |||
S : stage index: some datasets require a multi-stage generation, to make a clean and visible cut, can assign <b>S=a</b> to reconstruction | S : stage index: some datasets require a multi-stage generation, to make a clean and visible cut, can assign <b>S=a</b> to reconstruction | ||
O : for stages with several output streams, just number them - 0,1,2,3,4... | O : for stages with several output streams, just number them - 0,1,2,3,4... | ||
B : beam intensity : 0 - signal only, 1 : 1 batch mode, 2 : 2 batch mode , the rest -reserved for future | |||
B : beam intensity : 0 - signal only, 1 : 1 batch mode, 2 : 2 batch mode , the rest -reserved for future | |||
examples: | examples: | ||
| Line 33: | Line 31: | ||
|------------------------+---------------------------------------------------| | |------------------------+---------------------------------------------------| | ||
| beam | beam, trace everything | | | beam | beam, trace everything | | ||
| | | bmum | bmum : beam, trace mu-, but not e+,e-, gamma | | ||
| | | | | bmum1s10b0 : s1, 0=first output stream - into TS | | ||
| | | | | bmum1s20b0 : | | ||
| | | | | bmum1s30b0 : | | ||
| bpim | beam pi- tracing | | | bpim | beam pi- tracing | | ||
| mdio | DIO electrons, | | | mdio | DIO electrons, | | ||
| | examples: | | | examples: mdio0s10b0: leading order | | ||
| | | | | mdio1s10b1: leading log,+ 1 batch | | ||
| mumi | mu-, example : | | mumi | mu-, example : mgun0sr1b0 : muon particle gun | | ||
| mupl | mu+ | | | mupl | mu+ | | ||
| elec | e- (i.e. single particle gun) | | | elec | e- (i.e. single particle gun) | | ||
| Line 47: | Line 45: | ||
| pipl | pi+ | | | pipl | pi+ | | ||
| pimi | pi- | | | pimi | pi- | | ||
| pbar | pbars example: | | pbar | pbars example: pbar0s01b0 (reconstructed) | | ||
| rpce | RPC external | | | rpce | RPC external | | ||
| rpci | RPC internal | | | rpci | RPC internal | | ||
| Line 58: | Line 56: | ||
|------------------------+---------------------------------------------------| | |------------------------+---------------------------------------------------| | ||
</pre> | </pre> | ||
=== Dataset description on GitHub === | |||
* https://github.com/Mu2e/su2020/blob/master/doc/dataset_summary.org (Note: Mu2e/su2020 is a private repository, so you must be logged in to GitHub and be a member of the GitHub Mu2e organization in order to see it. Otherwise GitHub pretends the repository doesn't exist.) | |||
=== Links === | |||
* | |||
----- | |||
[[Category:Datasets]] [[Category:SU2020]] | |||
Latest revision as of 20:00, 2 March 2022
(work in progress)
Naming Conventions
Mu2e files are required to have 6 field-long names, see https://mu2ewiki.fnal.gov/wiki/FileNames for more details, example:
cnf.mu2e.dddddddddd.su2020.rrrrrr_ssssssss.art
- Let's use MC run number 1000 only for all datasets
- lets fix the 4-th field to su2020 (lowcased) - that would allow to find handily for all su2020 datasets in SAM catalog
- 1+2 fix 5 fields out of 6.
- It makes sense to treat the remaining, 3-rd, field as a 10 char long dataset ID. Having fixed length dataset ID is handy
- in many respects - we will need to propagate it through the whole analysis chain, from the MC files through the output
- of reconstruction to ntuples and histogram files.
- in addition to the dataset ID, a dataset has to have a long descriptive name, but it is the dsid which is supposed
- to be used for all practical purposes in the software. Ok, so
DDDDVsSObB (lowercased characters stay as is, uppercase - interpreted)
DDDD: 4-character-long name stub (it looks that 4 chars would allow us to name meaningfully all datasets we have so far dealt with
V : dataset version, i.e. 0,1,2 ... (in principle, could be anything and be used for any purpose) S : stage index: some datasets require a multi-stage generation, to make a clean and visible cut, can assign S=a to reconstruction O : for stages with several output streams, just number them - 0,1,2,3,4... B : beam intensity : 0 - signal only, 1 : 1 batch mode, 2 : 2 batch mode , the rest -reserved for future examples:
|------------------------+---------------------------------------------------| | 4 char dataset ID stub | comments, examples | |------------------------+---------------------------------------------------| | beam | beam, trace everything | | bmum | bmum : beam, trace mu-, but not e+,e-, gamma | | | bmum1s10b0 : s1, 0=first output stream - into TS | | | bmum1s20b0 : | | | bmum1s30b0 : | | bpim | beam pi- tracing | | mdio | DIO electrons, | | | examples: mdio0s10b0: leading order | | | mdio1s10b1: leading log,+ 1 batch | | mumi | mu-, example : mgun0sr1b0 : muon particle gun | | mupl | mu+ | | elec | e- (i.e. single particle gun) | | posi | e+ | | pipl | pi+ | | pimi | pi- | | pbar | pbars example: pbar0s01b0 (reconstructed) | | rpce | RPC external | | rpci | RPC internal | | rmce | RMC external | | rmci | RMC internal | | cosm | cosmics | | prot | ejected protons | | deut | ejected deutrons | | phot | ejected photons | |------------------------+---------------------------------------------------|
Dataset description on GitHub
- https://github.com/Mu2e/su2020/blob/master/doc/dataset_summary.org (Note: Mu2e/su2020 is a private repository, so you must be logged in to GitHub and be a member of the GitHub Mu2e organization in order to see it. Otherwise GitHub pretends the repository doesn't exist.)