File naming convention
The file name consists of a number of elements separated by ".". Each element consists of one key character and a description string. The description string should not contain ".". The last element represents file type, "stdhep" or "slcio" for example. In the case of generator file, the element one before the last is the file sequence number; 2 to 4 digit number with no key character. Definition of key character is shown in the following table.
|key||meaning||Example||Generator meta key name|
|E||CMS energy in GeV and machine parameter separated by "-"||E500-TDR_ws||CM_energy_in_GeV, machine_configuration|
|P||Generator process name||P4f_ww_h||process_name|
|G||Generator name and version||Gwhizard-1_95||program_name_version|
|e||Beam electron polarization or photon nature (note 1)||eL, eL80||beam_particle1, polarization1|
|p||Beam positron polarization or photon nature (note 1)||pL, pL30||beam_particle2, polarization2|
|I||Generator process ID (note 2)||I108717||process_id|
|n||File sequence number. Optionally file split number is postfixed, with "_" as a separator||n002_003|
|s||ILDConfig versin used for simulation||sv01-19-05|
|r||ILDConfig version used for reconstruction||rv01-19-05-p01|
|d||Data type, productionID and jobNumber separated by "_"||d_rec_00009250_714|
Following keys are used internally by a program to define directory name. They should not be used for the other purpose
|Key||Meaning||Example||Generator meta key name|
|C||Event class (note 3)||process_type(note 3)|
|T||Directory name for the production ID|
|J||Sub directory name ( Job number / 1000 )|
|B||Base directory name|
|w||Energy for meta value|
|o||Machine parameter such as "TDR_ws"|
|D||Upper case Data type|
- Beam polarization is given by a sign character, L for negative and R for plus, and a absolute polarization value by 2 digit % value, which is omitted if 100% polarization. If beam particle is photon, it's nature is given by B for beam-strahlung photon or W for Weizacker-Williams photon. For example,
- eR.pL : electron +100% and positron -100% polarization
- eL80.pR30 : electron -80% and positron +30% polarization
- eB.pR : beam strahlung photon from electron beam side and positron +100% polarization
- Following range of generator IDs are used for common samples depending on where sample is produced.
- 0 < ID < 100000 : produced at SLAC
- 100000 < ID < 200000 : produced at KEK
- 200000 < ID < 300000 : produced at DESY
- 300000 < ID < 400000 : produced at CERN
- In the case of generator data, the first element of process_type when splitted by "_" is used for the sub-directory name. In other data type such as sim, rec, dst-merged, etc, process_type is used for the sub-directory name with some exceptions such as "np" samples where the same directory name as the generator directory is used. (Updated:2018-07-27)
Directory naming convention
Samples produced by ILCDIRAC has following directory structure.
|Sub-directory name||DIRAC directory meta key||Typical value|
|<mctype>||not defined||mc-dbd, mc-dbd.log, mc-opt-2, mc-opt.dsk|
|<Energy>||Energy||500, 350, 250,91, 1|
|<MachineParams>||MachineParams||TDR_ws, nobeam, calib|
|<EvtType>||EvtType ( EvtClass for generator data||6f_ttbar, higgs_ffh|
|<ProdID>||ProdID||00009368 ( 8 digit )|
|<jobdirectory>||not define||000 ( 3digit )|
In ILD MC production by ILCDIRAC, file names and directory names are interpreted and constructed by a format define in FilenameEncoder class of ILCDIRAC/Core/Utilities/FilenameEncoder.py except a few exceptions.
Additional information about generator files will be found in https://ild.ngt.ndu.ac.jp/mc-prod/files2017/genmeta/
Process name of single particle samples
The file names in the ILCDirac file catalog has t be less than 127 characters. In order to fit REC and DST files produced by ILCDirac production system to this limitation, following naming rule has been applied for the single particle samples since the 3rd test production in April 2018.
The process name, namely the P key word in the file name, consistes of following information separated by "_".
- "s" : means single particles
- particles PDG : it is prefixed with "pm", if positive and negative charges are generated in the case of charged particles.
- p<value> : <value> is the particle momentum in GeV with 3 digit. In order to avoid "." here, use "p" instead of ".". <value> is "rnd" if randoml distributed momentum is used. For example "p0p5" for 0.5GeV/c, and "p010" for 10GeV/c, "prnd" for random momentum distribution.
- t<value> : If specified, particle polar angle is fixed to <value>. Or "a-b" for random distribution from "a" degree to "b" degree and "180-b" to "180-a" degree
The comment field information in https://ild.ngt.ndu.ac.jp/mc-prod/files2017/genmeta/ would include a supplemental information.