evgenTrfArgs.py

Go to the documentation of this file.

#  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
 
import PyJobTransforms.trfArgClasses as trfArgClasses
 
def addStdEvgenArgs(parser):
    parser.defineArgGroup("Evgen", "Event generator options")
 
    parser.add_argument("--ecmEnergy", "--EcmEnergy", group="Evgen",
                        default=trfArgClasses.argFloat(13600, runarg=True),
                        help="centre-of-mass energy parameter in GeV",
                        type=trfArgClasses.argFactory(trfArgClasses.argFloat, runarg=True))
 
    parser.add_argument("--firstEvent", "--FirstEvent", group="Evgen",
                        default=trfArgClasses.argInt(1, runarg=True),
                        help="the number of the first event in the output data file",
                        type=trfArgClasses.argFactory(trfArgClasses.argInt, runarg=True))
 
    parser.add_argument("--randomSeed", "--RandomSeed", "--seed", group="Evgen", nargs="+",
                        default=trfArgClasses.argSubstepInt("all:12345"),
                        help="a seed for the MC generator random number engines",
                        type=trfArgClasses.argFactory(trfArgClasses.argSubstepInt))
 
    parser.add_argument("--printEvts", group="Evgen",
                        default=trfArgClasses.argInt(5, runarg=True),
                        help="number of full event dumps to print out for debugging",
                        type=trfArgClasses.argFactory(trfArgClasses.argInt, runarg=True))
 
    parser.add_argument("--jobConfig", "--JobConfig", "--jo", group="Evgen", nargs="+",
                        help="a comma-separated list of job configuration script files",
                        type=trfArgClasses.argFactory(trfArgClasses.argSubstepList, runarg=True))
 
    # TODO: Add "--eventFile"?
    parser.add_argument("--inputGeneratorFile", "--inputGenEventFile", "--inputGenFile", "--InputGeneratorFile", group="Evgen",
                        help="optional parton-level events file to be processed",
                        type=trfArgClasses.argFactory(trfArgClasses.argString, runarg=True))
 
    parser.add_argument("--inputEVNTFile", group="Evgen",
                        help="input EVNT file (for use with e.g. Rivet)",
                        type=trfArgClasses.argFactory(trfArgClasses.argEVNTFile, io='input', runarg=True))
 
    parser.add_argument("--inputEVNT_PreFile", group="Evgen",
                        help="input evgen file for processing with afterburner, e.g. EvtGen",
                        type=trfArgClasses.argFactory(trfArgClasses.argEVNTFile, io='input', runarg=True))
 
    parser.add_argument("--evgenJobOpts", "--EvgenJobOpts", group="Evgen",
                        help="download and install the EvgenJobOpts tarball with the given name",
                        type=trfArgClasses.argFactory(trfArgClasses.argString, runarg=True))
 
    # TODO: make optional: by default auto-determine from the JO name. If NONE, don't write?
    parser.add_argument("--outputEVNTFile", "--OutputEVNTFile", group="Evgen",
                        help="POOL file into which generated events will be written",
                        type=trfArgClasses.argFactory(trfArgClasses.argEVNTFile, io='output', runarg=True))
 
    parser.add_argument("--outputEVNT_PreFile", "--OutputEVNT_PreFile", group="Evgen",
                        help="POOL file into which pre-afterburner generated events will be written",
                        type=trfArgClasses.argFactory(trfArgClasses.argEVNTFile, io='output', runarg=True))
 
    parser.add_argument('--outputNTUP_TRUTHFile',
                        type=trfArgClasses.argFactory(trfArgClasses.argNTUPFile, io='output', treeNames=['truth']),
                        help='Output NTUP_TRUTH file', group='Evgen')
 
    parser.add_argument("--outputYODAFile", group="Evgen",
                        help="Name of YODA file for Rivet histo output",
                        type=trfArgClasses.argFactory(trfArgClasses.argYODAFile, type='yoda', io='output', runarg=True))
 
    parser.add_argument("--outputHEPMCFile", group="Evgen",
                        help="Name of HepMC output file",
                        type=trfArgClasses.argFactory(trfArgClasses.argHepEvtAsciiFile, type='hepmc', io='output', runarg=True))
 
    parser.add_argument("--hepmcFormat", group="Evgen",
                        help="Format to use when writing HepMC files",
                        default=trfArgClasses.argString("hepmc2", runarg=True),
                        choices=[trfArgClasses.argString("hepmc2", runarg=True),
                                 trfArgClasses.argString("hepmc3", runarg=True)],
                        type=trfArgClasses.argFactory(trfArgClasses.argString, runarg=True))
 
    parser.add_argument("--hepmcUnits", group="Evgen",
                        help="Unitst to use when writing HepMC files",
                        default=trfArgClasses.argString("GEVMM", runarg=True),
                        choices=[trfArgClasses.argString("GEVCM", runarg=True),
                                 trfArgClasses.argString("MEVCM", runarg=True),
                                 trfArgClasses.argString("MEVMM", runarg=True)],
                        type=trfArgClasses.argFactory(trfArgClasses.argString, runarg=True))
 
    parser.add_argument("--extension", group="Evgen",
                        help="Extension to use when writing HepMC files",
                        default=trfArgClasses.argString("hepmc", runarg=True),
                        choices=[trfArgClasses.argString("hepmc", runarg=True),
                                 trfArgClasses.argString("events", runarg=True)],
                        type=trfArgClasses.argFactory(trfArgClasses.argString, runarg=True))
 
    parser.add_argument("--rivetAnas", group="Evgen",
                        help="a comma-separated list of Rivet analyses to run on the resulting events",
                        type=trfArgClasses.argFactory(trfArgClasses.argList, runarg=True))
 
    parser.add_argument("--outputTXTFile", group="Evgen",
                        help="optional output TXT file for LHEF events, default is None",
                        type=trfArgClasses.argFactory(trfArgClasses.argLHEFile, io='output', runarg=True))
 
    parser.add_argument("--generatorRunMode", group="Evgen",
                        help="Run mode to pass on to the event generator",
                        default=trfArgClasses.argString("run", runarg=True),
                        choices=[trfArgClasses.argString("read", runarg=True),
                                 trfArgClasses.argString("build", runarg=True),
                                 trfArgClasses.argString("integrate", runarg=True),
                                 trfArgClasses.argString("mergegrids", runarg=True),
                                 trfArgClasses.argString("run", runarg=True)],
                        type=trfArgClasses.argFactory(trfArgClasses.argString, runarg=True))
 
    parser.add_argument("--generatorJobNumber", group="Evgen",
                        help="Job number to pass on to the event generator",
                        default=trfArgClasses.argInt(0, runarg=True),
                        type=trfArgClasses.argFactory(trfArgClasses.argInt, runarg=True))
 
    parser.add_argument('--lheOnly', '--lheOnly', group='Evgen',
                        default=trfArgClasses.argInt(0, runarg=True),
                        type=trfArgClasses.argFactory(trfArgClasses.argInt, runarg=True),
                        help='Set to 1 if Evgen file should be removed')
 
    parser.add_argument("--localPath", group="Evgen",
                        help="Name of local path to JOs",
                        type=trfArgClasses.argFactory(trfArgClasses.argString, runarg=True))
 
    parser.add_argument('--saveList', '--saveList', group='Evgen',
                        help="a comma-separated list of files to be saved in output or a single digit if the whole output directory is to be saved",
                        type=trfArgClasses.argFactory(trfArgClasses.argSubstepList, runarg=True))
 
    parser.add_argument('--cleanOut', '--cleanOut', group='Evgen',
                        default=trfArgClasses.argInt(0, runarg=True),
                        type=trfArgClasses.argFactory(trfArgClasses.argInt, runarg=True),
                        help='Set to any digit !=0 if the output files should be cleaned up --saveList may help to save selected files')
 
    parser.add_argument('--VERBOSE', '--Verbose', '--Debug', '--DEBUG', group='Evgen',
                        help = 'set logging level to DEBUG',
                        type=trfArgClasses.argFactory(trfArgClasses.argBool, runarg=True),
                        default=trfArgClasses.argBool('False'))
 
    parser.add_argument('--ignoreBlackList', '--ignoreBlacklist', group='Evgen',
                        help = 'ignore Blacklist - allows to run a test in a blacklisted release',
                        type=trfArgClasses.argFactory(trfArgClasses.argBool, runarg=True),
                        default=trfArgClasses.argBool('False'))
 
    parser.add_argument('--allowOldFilter', '--allowOldFilter', group='Evgen',
                        help = 'useOldFilter - allows to use old (not xAOD based) filters',
                        type=trfArgClasses.argFactory(trfArgClasses.argBool, runarg=True),
                        default=trfArgClasses.argBool('False'))