Warning, /epic-prod/docs/_documentation/input_preprocessing.md is written in an unsupported language. File is not indexed.
0001 ---
0002 title: Input Preprocessing
0003 description: Input Preprocessing
0004 name: inputpreprocessing
0005 layout: default
0006 ---
0007
0008 {% include layouts/title.md %}
0009
0010 ### Dataset Acceptance Requirements
0011 To be included in production, all datasets need to be provided in hepmc3.tree.root format and need to meet generator source code and steering files version tracking requirements. The generator source code and scripts, steering files, meta data relevant to reproducing that dataset should be tracked in a repository maintained by the EIC, Jefferson Lab or BNL github organisation.
0012 - www.github.com/eic
0013 - www.github.com/JeffersonLab
0014 - https://github.com/BNLNPPS
0015
0016
0017 ### Dataset Files Nomenclature and Generator Version Tracking Requirements
0018
0019 Input files provided for production running should follow the following nomenclature:
0020
0021 ```
0022 <generator repository release tag>_<physics processes>_<electron momentum>x<proton momentum>_q2_<minimum q2>to<maximum q2>_run<index>.hepmc3.tree.root
0023 ```
0024
0025 The `<generator repository release tag>` should correspond to the release tag of the generator and steering file source repository. Repositories should use a release versioning scheme that makes it clearly identifiable which generator was used and which scripts/steering files were used.
0026
0027 **Case 1**: You control both generator source code and scripts/steering files. Consider the following scheme: `Major.Minor.Patch`
0028 - Major: Changes that invalidate previously generated hepmc3.tree.root files.
0029 - Minor: Changes that make previously generated hepmc3.tree.root files less ideal to use.
0030 - Patch: Changes that don’t modify the generated hepmc3.tree.root files in any statistically relevant way.
0031 For example, the first release for such a repository can be tagged 1.0.0 and incremented accordingly.
0032
0033 **Case 2**: You don’t control the generator source code but only the scripts/steering files.Consider a two part scheme: `Part1-Part2`
0034 - Part1: Semantic version of the generator that was used to create the dataset
0035 - Part2: Major.Minor for your steering files.
0036 For example, if you used Pythia6.428 and some steering files to create the dataset, the first release should be tagged Pythia6.428-1.0
0037
0038
0039 ### Conversion to hepmc3.tree.root
0040
0041 Use the [hepmc3 to root converter](https://github.com/eic/hepmc3ascii2root) to preprocess all hepmc files into a root file with hepmc3.tree.root suffix.
0042
0043 ### Subdirectory Structure
0044
0045 If placing the hepmc3.tree.root on S3 or JLab xrootd, follow appropriate subdirectory structure.
0046
0047 ```
0048 <physics processes>/<generator repository release tag>/<electron momentum>x<proton momentum>/q2_<minimum q2>to<maximum q2>/<file name>
0049 ```
0050
0051 If applicable, place subprocesses in their own subdirectory under processes.
0052
0053 Example:
0054 ```
0055 DIS/NC/pythia6.428-1.0/10x100/q2_10to100/pythia6.428-1.0_DIS-NC_10x100_q2_10to100_run001.hepmc3.tree.root
0056 ```
0057
0058
