Functions
def	gen_require_steering (gennames)

def	gen_known (genname)

def	gens_known (gennames)

def	gen_lhef (genname)

def	gens_lhef (gennames)

def	gen_testhepmc (genname)

def	gens_testhepmc (gennames)

def	gen_notune (genname)

def	gens_notune (gennames)

def	gen_sortkey (genname)

def	checkJOConsistency (jofile)

def	checkNEventsPerJob (sample)

def	checkKeywords (sample, evgenLog, officialJO)

def	checkCategories (sample, evgenLog, officialJO)

Variables
	evgenLog = logging.getLogger('GenConfigHelpers')

list	LHEFGenerators

list	MainGenerators = ["Herwig7"]

list	HIMainGenerators = ["AMPT","SuperChic","Starlight", "Hijing", "Hydjet"]

list	AfterburnerGenerators = ["Photospp", "TauolaPP", "EvtGen", "ParticleDecayer"]

list	KnownGenerators = LHEFGenerators + HIMainGenerators +MainGenerators + AfterburnerGenerators

list	NoTestHepMCGenerators

list	NoTuneGenerators = ["ParticleGun", "CosmicGenerator", "BeamHaloGenerator", "HepMCAscii"]

Function Documentation

◆ checkCategories()

def python.GenConfigHelpers.checkCategories	(	sample,
		evgenLog,
		officialJO
	)

Definition at line 178 of file GenConfigHelpers.py.

 def checkCategories(sample, evgenLog, officialJO):
     # Get file containing category names
     from AthenaCommon.Utils.unixtools import find_datafile
     lkwpath = find_datafile("CategoryList.txt")
     
     # Load the allowed categories names from the file
     allowed_cat = []
     if lkwpath:
         from ast import literal_eval
         with open(lkwpath, 'r') as catlist:
             for line in catlist:
                allowed_list = literal_eval(line)
                allowed_cat.append(allowed_list)
  
         # Check the JO categories against the allowed ones
         bad_cat =[]
         it = iter(sample.categories)
         for x in it:
            l1 = x
            l2 = next(it)
            if "L1:" in l2 and "L2:" in l1:
                l1, l2 = l2, l1
            print ("first",l1,"second",l2)
            bad_cat.extend([l1, l2])
            for a1,a2 in allowed_cat:
                if l1.strip().lower()==a1.strip().lower() and l2.strip().lower()==a2.strip().lower():
                  bad_cat=[]
            if bad_cat:
                msg = "categories contains non-standard category: %s. " % ", ".join(bad_cat)
                msg += "Please check the allowed categories list and fix."
                evgenLog.error(msg)
                if officialJO:
                    import sys
                    sys.exit(1)
     else:
         evgenLog.warning("Could not find CategoryList.txt file ", lkwpath, " in $DATAPATH")

◆ checkJOConsistency()

def python.GenConfigHelpers.checkJOConsistency ( jofile )

Definition at line 103 of file GenConfigHelpers.py.

 def checkJOConsistency(jofile):
     import os, sys, string
     officialJO = False
     joparts = (os.path.basename(jofile)).split(".")
     # Perform some consistency checks
     if joparts[0].startswith("mc") and all(c in string.digits for c in joparts[0][2:]):
         officialJO = True
         # Check that there are exactly 4 name parts separated by '.': MCxx, DSID, physicsShort, .py
         if len(joparts) != 3:
             evgenLog.error(jofile + " name format is wrong: must be of the form mc.<physicsShort>.py: please rename.")
             sys.exit(1)
         # Check the length limit on the physicsShort portion of the filename
         jo_physshortpart = joparts[1]
         if len(jo_physshortpart) > 50:
             evgenLog.error(jofile + " contains a physicsShort field of more than 60 characters: please rename.")
             sys.exit(1)
         # There must be at least 2 physicsShort sub-parts separated by '_': gens, (tune)+PDF, and process
         jo_physshortparts = jo_physshortpart.split("_")
         if len(jo_physshortparts) < 2:
             evgenLog.error(jofile + " has too few physicsShort fields separated by '_': should contain <generators>(_<tune+PDF_if_available>)_<process>. Please rename.")
             sys.exit(1)
         
         # NOTE: a further check on physicsShort consistency is done below, after fragment loading
         check_jofiles="/cvmfs/atlas.cern.ch/repo/sw/Generators/MC16JobOptions/scripts"
         sys.path.append(check_jofiles)
         from check_jo_consistency import check_naming       
         if os.path.exists(check_jofiles):
             check_naming(os.path.basename(jofile))
         else:
             evgenLog.error("check_jo_consistency.py not found")
             sys.exit(1)
     return officialJO
     

◆ checkKeywords()

def python.GenConfigHelpers.checkKeywords	(	sample,
		evgenLog,
		officialJO
	)

Definition at line 151 of file GenConfigHelpers.py.

 def checkKeywords(sample, evgenLog, officialJO):
     # Get file containing keywords
     from AthenaCommon.Utils.unixtools import find_datafile
     kwpath = find_datafile("evgenkeywords.txt")
     
     # Load the allowed keywords from the file
     allowed_keywords = []
     if kwpath: 
         evgenLog.info("evgenkeywords = %s", kwpath)
         kwf = open(kwpath, "r")
         for l in kwf:
             allowed_keywords += l.strip().lower().split()
         # Check the JO keywords against the allowed ones
         evil_keywords = []
         for k in sample.keywords:
             if k.lower() not in allowed_keywords:
                 evil_keywords.append(k)
         if evil_keywords:
             msg = "keywords contains non-standard keywords: %s. " % ", ".join(evil_keywords)
             msg += "Please check the allowed keywords list and fix."
             evgenLog.error(msg)
             if officialJO:
                 import sys
                 sys.exit(1)
     else:
         evgenLog.warning("evgenkeywords.txt not found ")
  

◆ checkNEventsPerJob()

def python.GenConfigHelpers.checkNEventsPerJob ( sample )

Definition at line 136 of file GenConfigHelpers.py.

 def checkNEventsPerJob(sample):
     if sample.nEventsPerJob < 1:
         raise RuntimeError("nEventsPerJob must be at least 1")
     elif sample.nEventsPerJob > 100000:
         raise RuntimeError("nEventsPerJob can be max. 100000")
     else:
         allowed_nEventsPerJob_lt1000 = [1, 2, 5, 10, 20, 25, 50, 100, 200, 500, 1000]
         if sample.nEventsPerJob >= 1000 and sample.nEventsPerJob <= 10000 and \
           (sample.nEventsPerJob % 1000 != 0 or 10000 % sample.nEventsPerJob != 0):
             raise RuntimeError("nEventsPerJob in range [1K, 10K] must be a multiple of 1K and a divisor of 10K")
         elif sample.nEventsPerJob > 10000  and sample.nEventsPerJob % 10000 != 0:
             raise RuntimeError("nEventsPerJob >10K must be a multiple of 10K")
         elif sample.nEventsPerJob < 1000 and sample.nEventsPerJob not in allowed_nEventsPerJob_lt1000:
             raise RuntimeError("nEventsPerJob in range <= 1000 must be one of %s" % allowed_nEventsPerJob_lt1000)
     

◆ gen_known()

def python.GenConfigHelpers.gen_known ( genname )

Return whether a generator name is known

Definition at line 57 of file GenConfigHelpers.py.

 def gen_known(genname):
     """Return whether a generator name is known"""
     return genname in KnownGenerators
  

◆ gen_lhef()

def python.GenConfigHelpers.gen_lhef ( genname )

Return whether a generator uses LHEF input files

Definition at line 65 of file GenConfigHelpers.py.

 def gen_lhef(genname):
     """Return whether a generator uses LHEF input files"""
     return genname in LHEFGenerators
  

◆ gen_notune()

def python.GenConfigHelpers.gen_notune ( genname )

Return whether a generator is allowed to not provide PDF and tune information

Definition at line 81 of file GenConfigHelpers.py.

 def gen_notune(genname):
     """Return whether a generator is allowed to not provide PDF and tune information"""
     return genname not in NoTuneGenerators
  

◆ gen_require_steering()

def python.GenConfigHelpers.gen_require_steering ( gennames )

Return a boolean of whether this set of generators requires the steering command line flag

Definition at line 50 of file GenConfigHelpers.py.

 def gen_require_steering(gennames):
     """Return a boolean of whether this set of generators requires the steering command line flag"""
     if "EvtGen" not in gennames: return False
     if any(("Pythia" in gen and "Pythia8" not in gen) for gen in gennames): return True
     if any(("Herwig" in gen and "Herwig7" not in gen) for gen in gennames): return True
     return False
  

◆ gen_sortkey()

def python.GenConfigHelpers.gen_sortkey ( genname )

Return a key suitable for sorting a generator name by stage, then alphabetically

Definition at line 89 of file GenConfigHelpers.py.

 def gen_sortkey(genname):
     """Return a key suitable for sorting a generator name by stage, then alphabetically"""
     
     # Sort mainly in order of generator stage
     genstage = None
     for istage, gens in enumerate([LHEFGenerators, HIMainGenerators, MainGenerators,AfterburnerGenerators]):
         if genname in gens:
             genstage = istage
             break
  
     # Return a tuple
     return (genstage,  genname)
  
 # Function to perform consistency check on jO

◆ gen_testhepmc()

def python.GenConfigHelpers.gen_testhepmc ( genname )

Return whether a generator should be sanity tested with TestHepMC

Definition at line 73 of file GenConfigHelpers.py.

 def gen_testhepmc(genname):
     """Return whether a generator should be sanity tested with TestHepMC"""
     return genname not in NoTestHepMCGenerators
  

◆ gens_known()

def python.GenConfigHelpers.gens_known ( gennames )

Return whether all generator names are known

Definition at line 61 of file GenConfigHelpers.py.

 def gens_known(gennames):
     """Return whether all generator names are known"""
     return all(gen_known(g) for g in gennames)
  

◆ gens_lhef()

def python.GenConfigHelpers.gens_lhef ( gennames )

Return whether any of the generators uses LHEF input files

Definition at line 69 of file GenConfigHelpers.py.

 def gens_lhef(gennames):
     """Return whether any of the generators uses LHEF input files"""
     return any(gen_lhef(g) for g in gennames)
  

◆ gens_notune()

def python.GenConfigHelpers.gens_notune ( gennames )

Return whether all of the generators are allowed to not provide PDF and tune information

Definition at line 85 of file GenConfigHelpers.py.

 def gens_notune(gennames):
     """Return whether all of the generators are allowed to not provide PDF and tune information"""
     return all(gen_notune(g) for g in gennames)
  

◆ gens_testhepmc()

def python.GenConfigHelpers.gens_testhepmc ( gennames )

Return whether all of the generators should be sanity tested with TestHepMC

Definition at line 77 of file GenConfigHelpers.py.

 def gens_testhepmc(gennames):
     """Return whether all of the generators should be sanity tested with TestHepMC"""
     return all(gen_testhepmc(g) for g in gennames)
  

Variable Documentation

◆ AfterburnerGenerators

list python.GenConfigHelpers.AfterburnerGenerators = ["Photospp", "TauolaPP", "EvtGen", "ParticleDecayer"]

Definition at line 36 of file GenConfigHelpers.py.

◆ evgenLog

python.GenConfigHelpers.evgenLog = logging.getLogger('GenConfigHelpers')

Definition at line 5 of file GenConfigHelpers.py.

◆ HIMainGenerators

list python.GenConfigHelpers.HIMainGenerators = ["AMPT","SuperChic","Starlight", "Hijing", "Hydjet"]

Definition at line 29 of file GenConfigHelpers.py.

◆ KnownGenerators

list python.GenConfigHelpers.KnownGenerators = LHEFGenerators + HIMainGenerators +MainGenerators + AfterburnerGenerators

Definition at line 40 of file GenConfigHelpers.py.

◆ LHEFGenerators

list python.GenConfigHelpers.LHEFGenerators

Initial value:

 =  ["Lhef", # generic name: prefer to use the names below
                   "aMcAtNlo", "McAtNlo", "Powheg",  "MadGraph", "CompHep", "Geneva",
                   "MCFM", "JHU", "MEtop", "BCVEGPY", "Dire4Pythia8", 
                   "BlackMax", "QBH", "gg2ww", "gg2zz", "gg2vv", "HvyN", 
                   "VBFNLO", "FPMC", "ProtosLHEF",
                   "BCVEGPY", "STRINGS", "Phantom"]

Definition at line 9 of file GenConfigHelpers.py.

◆ MainGenerators

list python.GenConfigHelpers.MainGenerators = ["Herwig7"]

Definition at line 18 of file GenConfigHelpers.py.

◆ NoTestHepMCGenerators

list python.GenConfigHelpers.NoTestHepMCGenerators