ConfigBuilder.py

Go to the documentation of this file.

#! /usr/bin/env python3

__version__ = "$Revision: 1.19 $"
__source__ = "$Source: /local/reps/CMSSW/CMSSW/Configuration/Applications/python/ConfigBuilder.py,v $"

import FWCore.ParameterSet.Config as cms
from FWCore.ParameterSet.Modules import _Module
# The following import is provided for backward compatibility reasons.
# The function used to be defined in this file.
from FWCore.ParameterSet.MassReplace import massReplaceInputTag as MassReplaceInputTag

import hashlib
import sys
import re
import collections
from subprocess import Popen,PIPE
import FWCore.ParameterSet.DictTypes as DictTypes
from FWCore.ParameterSet.OrderedSet import OrderedSet
class Options:
    pass

# the canonical defaults
defaultOptions = Options()
defaultOptions.datamix = 'DataOnSim'
defaultOptions.isMC=False
defaultOptions.isData=True
defaultOptions.step=''
defaultOptions.pileup='NoPileUp'
defaultOptions.pileup_input = None
defaultOptions.pileup_dasoption = ''
defaultOptions.geometry = 'SimDB'
defaultOptions.geometryExtendedOptions = ['ExtendedGFlash','Extended','NoCastor']
defaultOptions.magField = ''
defaultOptions.conditions = None
defaultOptions.scenarioOptions=['pp','cosmics','nocoll','HeavyIons']
defaultOptions.harvesting= 'AtRunEnd'
defaultOptions.gflash = False
defaultOptions.number = -1
defaultOptions.number_out = None
defaultOptions.arguments = ""
defaultOptions.name = "NO NAME GIVEN"
defaultOptions.evt_type = ""
defaultOptions.filein = ""
defaultOptions.dasquery=""
defaultOptions.dasoption=""
defaultOptions.secondfilein = ""
defaultOptions.customisation_file = []
defaultOptions.customisation_file_unsch = []
defaultOptions.customise_commands = ""
defaultOptions.inline_custom=False
defaultOptions.particleTable = 'pythiapdt'
defaultOptions.particleTableList = ['pythiapdt','pdt']
defaultOptions.dirin = ''
defaultOptions.dirout = ''
defaultOptions.filetype = 'EDM'
defaultOptions.fileout = 'output.root'
defaultOptions.filtername = ''
defaultOptions.lazy_download = False
defaultOptions.custom_conditions = ''
defaultOptions.hltProcess = ''
defaultOptions.eventcontent = None
defaultOptions.datatier = None
defaultOptions.inlineEventContent = True
defaultOptions.inlineObjects =''
defaultOptions.hideGen=False
from Configuration.StandardSequences.VtxSmeared import VtxSmearedDefaultKey,VtxSmearedHIDefaultKey
defaultOptions.beamspot=None
defaultOptions.outputDefinition =''
defaultOptions.inputCommands = None
defaultOptions.outputCommands = None
defaultOptions.inputEventContent = ''
defaultOptions.dropDescendant = False
defaultOptions.relval = None
defaultOptions.profile = None
defaultOptions.heap_profile = None
defaultOptions.isRepacked = False
defaultOptions.restoreRNDSeeds = False
defaultOptions.donotDropOnInput = ''
defaultOptions.python_filename =''
defaultOptions.io=None
defaultOptions.lumiToProcess=None
defaultOptions.fast=False
defaultOptions.runsAndWeightsForMC = None
defaultOptions.runsScenarioForMC = None
defaultOptions.runsAndWeightsForMCIntegerWeights = None
defaultOptions.runsScenarioForMCIntegerWeights = None
defaultOptions.runUnscheduled = False
defaultOptions.timeoutOutput = False
defaultOptions.nThreads = 1
defaultOptions.nStreams = 0
defaultOptions.nConcurrentLumis = 0
defaultOptions.nConcurrentIOVs = 0
defaultOptions.accelerators = None

# some helper routines
def dumpPython(process,name):
    theObject = getattr(process,name)
    if isinstance(theObject,cms.Path) or isinstance(theObject,cms.EndPath) or isinstance(theObject,cms.Sequence):
        return "process."+name+" = " + theObject.dumpPython()
    elif isinstance(theObject,_Module) or isinstance(theObject,cms.ESProducer):
        return "process."+name+" = " + theObject.dumpPython()+"\n"
    else:
        return "process."+name+" = " + theObject.dumpPython()+"\n"
def filesFromList(fileName,s=None):
    import os
    import FWCore.ParameterSet.Config as cms
    prim=[]
    sec=[]
    for line in open(fileName,'r'):
        if line.count(".root")>=2:
            #two files solution...
            entries=line.replace("\n","").split()
            prim.append(entries[0])
            sec.append(entries[1])
        elif (line.find(".root")!=-1):
            entry=line.replace("\n","")
            prim.append(entry)
    # remove any duplicates but keep the order
    file_seen = set()
    prim = [f for f in prim if not (f in file_seen or file_seen.add(f))]
    file_seen = set()
    sec = [f for f in sec if not (f in file_seen or file_seen.add(f))]
    if s:
        if not hasattr(s,"fileNames"):
            s.fileNames=cms.untracked.vstring(prim)
        else:
            s.fileNames.extend(prim)
        if len(sec)!=0:
            if not hasattr(s,"secondaryFileNames"):
                s.secondaryFileNames=cms.untracked.vstring(sec)
            else:
                s.secondaryFileNames.extend(sec)
    print("found files: ",prim)
    if len(prim)==0:
        raise Exception("There are not files in input from the file list")
    if len(sec)!=0:
        print("found parent files:",sec)
    return (prim,sec)

def filesFromDASQuery(query,option="",s=None):
    import os,time
    import FWCore.ParameterSet.Config as cms
    prim=[]
    sec=[]
    print("the query is",query)
    eC=5
    count=0
    while eC!=0 and count<3:
        if count!=0:
            print('Sleeping, then retrying DAS')
            time.sleep(100)
        p = Popen('dasgoclient %s --query "%s"'%(option,query), stdout=PIPE,shell=True, universal_newlines=True)
        pipe=p.stdout.read()
        tupleP = os.waitpid(p.pid, 0)
        eC=tupleP[1]
        count=count+1
    if eC==0:
        print("DAS succeeded after",count,"attempts",eC)
    else:
        print("DAS failed 3 times- I give up")
    for line in pipe.split('\n'):
        if line.count(".root")>=2:
            #two files solution...
            entries=line.replace("\n","").split()
            prim.append(entries[0])
            sec.append(entries[1])
        elif (line.find(".root")!=-1):
            entry=line.replace("\n","")
            prim.append(entry)
    # remove any duplicates
    prim = sorted(list(set(prim)))
    sec = sorted(list(set(sec)))
    if s:
        if not hasattr(s,"fileNames"):
            s.fileNames=cms.untracked.vstring(prim)
        else:
            s.fileNames.extend(prim)
        if len(sec)!=0:
            if not hasattr(s,"secondaryFileNames"):
                s.secondaryFileNames=cms.untracked.vstring(sec)
            else:
                s.secondaryFileNames.extend(sec)
    print("found files: ",prim)
    if len(sec)!=0:
        print("found parent files:",sec)
    return (prim,sec)

def anyOf(listOfKeys,dict,opt=None):
    for k in listOfKeys:
        if k in dict:
            toReturn=dict[k]
            dict.pop(k)
            return toReturn
    if opt!=None:
        return opt
    else:
        raise Exception("any of "+','.join(listOfKeys)+" are mandatory entries of --output options")

class ConfigBuilder(object):
    """The main building routines """

    def __init__(self, options, process = None, with_output = False, with_input = False ):
        """options taken from old cmsDriver and optparse """

        options.outfile_name = options.dirout+options.fileout

        self._options = options

        if self._options.isData and options.isMC:
            raise Exception("ERROR: You may specify only --data or --mc, not both")
        #if not self._options.conditions:
        #        raise Exception("ERROR: No conditions given!\nPlease specify conditions. E.g. via --conditions=IDEAL_30X::All")

        # check that MEtoEDMConverter (running in ENDJOB) and DQMIO don't run in the same job
        if 'ENDJOB' in self._options.step:
            if  (hasattr(self._options,"outputDefinition") and \
                self._options.outputDefinition != '' and \
                any(anyOf(['t','tier','dataTier'],outdic) == 'DQMIO' for outdic in eval(self._options.outputDefinition))) or \
                (hasattr(self._options,"datatier") and \
                self._options.datatier and \
                'DQMIO' in self._options.datatier):
                print("removing ENDJOB from steps since not compatible with DQMIO dataTier")
                self._options.step=self._options.step.replace(',ENDJOB','')



        # what steps are provided by this class?
        stepList = [re.sub(r'^prepare_', '', methodName) for methodName in ConfigBuilder.__dict__ if methodName.startswith('prepare_')]
        self.stepMap={}
        self.stepKeys=[]
        for step in self._options.step.split(","):
            if step=='': continue
            stepParts = step.split(":")
            stepName = stepParts[0]
            if stepName not in stepList and not stepName.startswith('re'):
                raise ValueError("Step {} unknown. Available are {}".format( stepName , sorted(stepList)))
            if len(stepParts)==1:
                self.stepMap[stepName]=""
            elif len(stepParts)==2:
                self.stepMap[stepName]=stepParts[1].split('+')
            elif len(stepParts)==3:
                self.stepMap[stepName]=(stepParts[2].split('+'),stepParts[1])
            else:
                raise ValueError(f"Step definition {step} invalid")
            self.stepKeys.append(stepName)

        #print(f"map of steps is: {self.stepMap}")

        self.with_output = with_output
        self.process=process

        if hasattr(self._options,"no_output_flag") and self._options.no_output_flag:
            self.with_output = False
        self.with_input = with_input
        self.imports = []
        self.create_process()
        self.define_Configs()
        self.schedule = list()
        self.scheduleIndexOfFirstHLTPath = None

        # we are doing three things here:
        # creating a process to catch errors
        # building the code to re-create the process

        self.additionalCommands = []
        # TODO: maybe a list of to be dumped objects would help as well
        self.blacklist_paths = []
        self.addedObjects = []
        self.additionalOutputs = {}

        self.productionFilterSequence = None
        self.labelsToAssociate=[]
        self.nextScheduleIsConditional=False
        self.conditionalPaths=[]
        self.excludedPaths=[]

    def profileOptions(self):
        """
        addIgProfService
        Function to add the igprof profile service so that you can dump in the middle
        of the run.
        """
        profileOpts = self._options.profile.split(':')
        profilerStart = 1
        profilerInterval = 100
        profilerFormat = None
        profilerJobFormat = None

        if len(profileOpts):
            #type, given as first argument is unused here
            profileOpts.pop(0)
        if len(profileOpts):
            startEvent = profileOpts.pop(0)
            if not startEvent.isdigit():
                raise Exception("%s is not a number" % startEvent)
            profilerStart = int(startEvent)
        if len(profileOpts):
            eventInterval = profileOpts.pop(0)
            if not eventInterval.isdigit():
                raise Exception("%s is not a number" % eventInterval)
            profilerInterval = int(eventInterval)
        if len(profileOpts):
            profilerFormat = profileOpts.pop(0)


        if not profilerFormat:
            profilerFormat = "%s___%s___%%I.gz" % (
                self._options.evt_type.replace("_cfi", ""),
                hashlib.md5(
                    (str(self._options.step) + str(self._options.pileup) + str(self._options.conditions) +
                    str(self._options.datatier) + str(self._options.profileTypeLabel)).encode('utf-8')
                ).hexdigest()
            )
        if not profilerJobFormat and profilerFormat.endswith(".gz"):
            profilerJobFormat = profilerFormat.replace(".gz", "_EndOfJob.gz")
        elif not profilerJobFormat:
            profilerJobFormat = profilerFormat + "_EndOfJob.gz"

        return (profilerStart,profilerInterval,profilerFormat,profilerJobFormat)

    def heapProfileOptions(self):
        """
        addJeProfService
        Function to add the jemalloc heap  profile service so that you can dump in the middle
        of the run.
        """
        profileOpts = self._options.profile.split(':')
        profilerStart = 1
        profilerInterval = 100
        profilerFormat = None
        profilerJobFormat = None

        if len(profileOpts):
            #type, given as first argument is unused here
            profileOpts.pop(0)
        if len(profileOpts):
            startEvent = profileOpts.pop(0)
            if not startEvent.isdigit():
                raise Exception("%s is not a number" % startEvent)
            profilerStart = int(startEvent)
        if len(profileOpts):
            eventInterval = profileOpts.pop(0)
            if not eventInterval.isdigit():
                raise Exception("%s is not a number" % eventInterval)
            profilerInterval = int(eventInterval)
        if len(profileOpts):
            profilerFormat = profileOpts.pop(0)


        if not profilerFormat:
            profilerFormat = "%s___%s___%%I.heap" % (
                self._options.evt_type.replace("_cfi", ""),
                hashlib.md5(
                    (str(self._options.step) + str(self._options.pileup) + str(self._options.conditions) +
                    str(self._options.datatier) + str(self._options.profileTypeLabel)).encode('utf-8')
                ).hexdigest()
            )
        if not profilerJobFormat and profilerFormat.endswith(".heap"):
            profilerJobFormat = profilerFormat.replace(".heap", "_EndOfJob.heap")
        elif not profilerJobFormat:
            profilerJobFormat = profilerFormat + "_EndOfJob.heap"

        return (profilerStart,profilerInterval,profilerFormat,profilerJobFormat)

    def load(self,includeFile):
        includeFile = includeFile.replace('/','.')
        self.process.load(includeFile)
        return sys.modules[includeFile]

    def loadAndRemember(self, includeFile):
        """helper routine to load am memorize imports"""
        # we could make the imports a on-the-fly data method of the process instance itself
        # not sure if the latter is a good idea
        includeFile = includeFile.replace('/','.')
        self.imports.append(includeFile)
        self.process.load(includeFile)
        return sys.modules[includeFile]

    def executeAndRemember(self, command):
        """helper routine to remember replace statements"""
        self.additionalCommands.append(command)
        if not command.strip().startswith("#"):
        # substitute: process.foo = process.bar -> self.process.foo = self.process.bar
            import re
            exec(re.sub(r"([^a-zA-Z_0-9]|^)(process)([^a-zA-Z_0-9])",r"\1self.process\3",command))
            #exec(command.replace("process.","self.process."))

    def addCommon(self):
        if 'HARVESTING' in self.stepMap.keys() or 'ALCAHARVEST' in self.stepMap.keys():
            self.process.options.Rethrow = ['ProductNotFound']
            self.process.options.fileMode = 'FULLMERGE'

        self.addedObjects.append(("","options"))

        if self._options.lazy_download:
            self.process.AdaptorConfig = cms.Service("AdaptorConfig",
                                                     stats = cms.untracked.bool(True),
                                                     enable = cms.untracked.bool(True),
                                                     cacheHint = cms.untracked.string("lazy-download"),
                                                     readHint = cms.untracked.string("read-ahead-buffered")
                                                     )
            self.addedObjects.append(("Setup lazy download","AdaptorConfig"))

        #self.process.cmsDriverCommand = cms.untracked.PSet( command=cms.untracked.string('cmsDriver.py '+self._options.arguments) )
        #self.addedObjects.append(("what cmsDriver command was used","cmsDriverCommand"))

        if self._options.profile:
            (start, interval, eventFormat, jobFormat)=self.profileOptions()
            self.process.IgProfService = cms.Service("IgProfService",
                                                     reportFirstEvent            = cms.untracked.int32(start),
                                                     reportEventInterval         = cms.untracked.int32(interval),
                                                     reportToFileAtPostEvent     = cms.untracked.string("| gzip -c > %s"%(eventFormat)),
                                                     reportToFileAtPostEndJob    = cms.untracked.string("| gzip -c > %s"%(jobFormat)))
            self.addedObjects.append(("Setup IGProf Service for profiling","IgProfService"))

        if self._options.heap_profile:
            (start, interval, eventFormat, jobFormat)=self.heapProfileOptions()
            self.process.JeProfService = cms.Service("JeProfService",
                                                     reportFirstEvent            = cms.untracked.int32(start),
                                                     reportEventInterval         = cms.untracked.int32(interval),
                                                     reportToFileAtPostEvent     = cms.untracked.string("%s"%(eventFormat)),
                                                     reportToFileAtPostEndJob    = cms.untracked.string("%s"%(jobFormat)))
            self.addedObjects.append(("Setup JeProf Service for heap profiling","JeProfService"))

    def addMaxEvents(self):
        """Here we decide how many evts will be processed"""
        self.process.maxEvents.input = self._options.number
        if self._options.number_out:
            self.process.maxEvents.output = self._options.number_out
        self.addedObjects.append(("","maxEvents"))

    def addSource(self):
        """Here the source is built. Priority: file, generator"""
        self.addedObjects.append(("Input source","source"))

        def filesFromOption(self):
            for entry in self._options.filein.split(','):
                print("entry",entry)
                if entry.startswith("filelist:"):
                    filesFromList(entry[9:],self.process.source)
                elif entry.startswith("dbs:") or entry.startswith("das:"):
                    filesFromDASQuery('file dataset = %s'%(entry[4:]),self._options.dasoption,self.process.source)
                else:
                    self.process.source.fileNames.append(self._options.dirin+entry)
            if self._options.secondfilein:
                if not hasattr(self.process.source,"secondaryFileNames"):
                    raise Exception("--secondfilein not compatible with "+self._options.filetype+"input type")
                for entry in self._options.secondfilein.split(','):
                    print("entry",entry)
                    if entry.startswith("filelist:"):
                        self.process.source.secondaryFileNames.extend((filesFromList(entry[9:]))[0])
                    elif entry.startswith("dbs:") or entry.startswith("das:"):
                        self.process.source.secondaryFileNames.extend((filesFromDASQuery('file dataset = %s'%(entry[4:]),self._options.dasoption))[0])
                    else:
                        self.process.source.secondaryFileNames.append(self._options.dirin+entry)

        if self._options.filein or self._options.dasquery:
            if self._options.filetype == "EDM":
                self.process.source=cms.Source("PoolSource",
                                               fileNames = cms.untracked.vstring(),
                                               secondaryFileNames= cms.untracked.vstring())
                filesFromOption(self)
            elif self._options.filetype == "DAT":
                self.process.source=cms.Source("NewEventStreamFileReader",fileNames = cms.untracked.vstring())
                filesFromOption(self)
            elif self._options.filetype == "LHE":
                self.process.source=cms.Source("LHESource", fileNames = cms.untracked.vstring())
                if self._options.filein.startswith("lhe:"):
                    #list the article directory automatically
                    args=self._options.filein.split(':')
                    article=args[1]
                    print('LHE input from article ',article)
                    location='/store/lhe/'
                    import os
                    textOfFiles=os.popen('cmsLHEtoEOSManager.py -l '+article)
                    for line in textOfFiles:
                        for fileName in [x for x in line.split() if '.lhe' in x]:
                            self.process.source.fileNames.append(location+article+'/'+fileName)
                    #check first if list of LHE files is loaded (not empty)
                    if len(line)<2:
                        print('Issue to load LHE files, please check and try again.')
                        sys.exit(-1)
                    #Additional check to protect empty fileNames in process.source
                    if len(self.process.source.fileNames)==0:
                        print('Issue with empty filename, but can pass line check')
                        sys.exit(-1)
                    if len(args)>2:
                        self.process.source.skipEvents = cms.untracked.uint32(int(args[2]))
                else:
                    filesFromOption(self)

            elif self._options.filetype == "DQM":
                self.process.source=cms.Source("DQMRootSource",
                                               fileNames = cms.untracked.vstring())
                filesFromOption(self)

            elif self._options.filetype == "DQMDAQ":
                # FIXME: how to configure it if there are no input files specified?
                self.process.source=cms.Source("DQMStreamerReader")


            if ('HARVESTING' in self.stepMap.keys() or 'ALCAHARVEST' in self.stepMap.keys()) and (not self._options.filetype == "DQM"):
                self.process.source.processingMode = cms.untracked.string("RunsAndLumis")

        if self._options.dasquery!='':
            self.process.source=cms.Source("PoolSource", fileNames = cms.untracked.vstring(),secondaryFileNames = cms.untracked.vstring())
            filesFromDASQuery(self._options.dasquery,self._options.dasoption,self.process.source)

            if ('HARVESTING' in self.stepMap.keys() or 'ALCAHARVEST' in self.stepMap.keys()) and (not self._options.filetype == "DQM"):
                self.process.source.processingMode = cms.untracked.string("RunsAndLumis")

        
        if 'GEN' in self.stepMap.keys() and not self._options.filetype == "LHE":
            if self._options.inputCommands:
                self._options.inputCommands+=',drop LHEXMLStringProduct_*_*_*,'
            else:
                self._options.inputCommands='keep *, drop LHEXMLStringProduct_*_*_*,'

        if self.process.source and self._options.inputCommands and not self._options.filetype == "LHE":
            if not hasattr(self.process.source,'inputCommands'): self.process.source.inputCommands=cms.untracked.vstring()
            for command in self._options.inputCommands.split(','):
                # remove whitespace around the keep/drop statements
                command = command.strip()
                if command=='': continue
                self.process.source.inputCommands.append(command)
            if not self._options.dropDescendant:
                self.process.source.dropDescendantsOfDroppedBranches = cms.untracked.bool(False)

        if self._options.lumiToProcess:
            import FWCore.PythonUtilities.LumiList as LumiList
            self.process.source.lumisToProcess = cms.untracked.VLuminosityBlockRange( LumiList.LumiList(self._options.lumiToProcess).getCMSSWString().split(',') )

        if 'GEN' in self.stepMap.keys() or 'LHE' in self.stepMap or (not self._options.filein and hasattr(self._options, "evt_type")):
            if self.process.source is None:
                self.process.source=cms.Source("EmptySource")

        # modify source in case of run-dependent MC
        self.runsAndWeights=None
        if self._options.runsAndWeightsForMC or self._options.runsScenarioForMC :
            if not self._options.isMC :
                raise Exception("options --runsAndWeightsForMC and --runsScenarioForMC are only valid for MC")
            if self._options.runsAndWeightsForMC:
                self.runsAndWeights = eval(self._options.runsAndWeightsForMC)
            else:
                from Configuration.StandardSequences.RunsAndWeights import RunsAndWeights
                if isinstance(RunsAndWeights[self._options.runsScenarioForMC], str):
                    __import__(RunsAndWeights[self._options.runsScenarioForMC])
                    self.runsAndWeights = sys.modules[RunsAndWeights[self._options.runsScenarioForMC]].runProbabilityDistribution
                else:
                    self.runsAndWeights = RunsAndWeights[self._options.runsScenarioForMC]

        if self.runsAndWeights:
            import SimGeneral.Configuration.ThrowAndSetRandomRun as ThrowAndSetRandomRun
            ThrowAndSetRandomRun.throwAndSetRandomRun(self.process.source,self.runsAndWeights)
            self.additionalCommands.append('import SimGeneral.Configuration.ThrowAndSetRandomRun as ThrowAndSetRandomRun')
            self.additionalCommands.append('ThrowAndSetRandomRun.throwAndSetRandomRun(process.source,%s)'%(self.runsAndWeights))

        # modify source in case of run-dependent MC (Run-3 method)
        self.runsAndWeightsInt=None
        if self._options.runsAndWeightsForMCIntegerWeights or self._options.runsScenarioForMCIntegerWeights:
            if not self._options.isMC :
                raise Exception("options --runsAndWeightsForMCIntegerWeights and --runsScenarioForMCIntegerWeights are only valid for MC")
            if self._options.runsAndWeightsForMCIntegerWeights:
                self.runsAndWeightsInt = eval(self._options.runsAndWeightsForMCIntegerWeights)
            else:
                from Configuration.StandardSequences.RunsAndWeights import RunsAndWeights
                if isinstance(RunsAndWeights[self._options.runsScenarioForMCIntegerWeights], str):
                    __import__(RunsAndWeights[self._options.runsScenarioForMCIntegerWeights])
                    self.runsAndWeightsInt = sys.modules[RunsAndWeights[self._options.runsScenarioForMCIntegerWeights]].runProbabilityDistribution
                else:
                    self.runsAndWeightsInt = RunsAndWeights[self._options.runsScenarioForMCIntegerWeights]

        if self.runsAndWeightsInt:
            if not self._options.relval:
                raise Exception("--relval option required when using --runsAndWeightsInt")
            if 'DATAMIX' in self._options.step:
                from SimGeneral.Configuration.LumiToRun import lumi_to_run
                total_events, events_per_job  = self._options.relval.split(',')
                lumi_to_run_mapping = lumi_to_run(self.runsAndWeightsInt, int(total_events), int(events_per_job))
                self.additionalCommands.append("process.source.firstLuminosityBlockForEachRun = cms.untracked.VLuminosityBlockID(*[cms.LuminosityBlockID(x,y) for x,y in " + str(lumi_to_run_mapping) + "])")

        return

    def addOutput(self):
        """ Add output module to the process """
        result=""
        if self._options.outputDefinition:
            if self._options.datatier:
                print("--datatier & --eventcontent options ignored")

            #new output convention with a list of dict
            outList = eval(self._options.outputDefinition)
            for (id,outDefDict) in enumerate(outList):
                outDefDictStr=outDefDict.__str__()
                if not isinstance(outDefDict,dict):
                    raise Exception("--output needs to be passed a list of dict"+self._options.outputDefinition+" is invalid")
                #requires option: tier
                theTier=anyOf(['t','tier','dataTier'],outDefDict)
                #optional option: eventcontent, filtername, selectEvents, moduleLabel, filename
                
                theStreamType=anyOf(['e','ec','eventContent','streamType'],outDefDict,theTier)
                theFilterName=anyOf(['f','ftN','filterName'],outDefDict,'')
                theSelectEvent=anyOf(['s','sE','selectEvents'],outDefDict,'')
                theModuleLabel=anyOf(['l','mL','moduleLabel'],outDefDict,'')
                theExtraOutputCommands=anyOf(['o','oC','outputCommands'],outDefDict,'')
                # module label has a particular role
                if not theModuleLabel:
                    tryNames=[theStreamType.replace(theTier.replace('-',''),'')+theTier.replace('-','')+'output',
                              theStreamType.replace(theTier.replace('-',''),'')+theTier.replace('-','')+theFilterName+'output',
                              theStreamType.replace(theTier.replace('-',''),'')+theTier.replace('-','')+theFilterName+theSelectEvent.split(',')[0].replace(':','for').replace(' ','')+'output'
                              ]
                    for name in tryNames:
                        if not hasattr(self.process,name):
                            theModuleLabel=name
                            break
                if not theModuleLabel:
                    raise Exception("cannot find a module label for specification: "+outDefDictStr)
                if id==0:
                    defaultFileName=self._options.outfile_name
                else:
                    defaultFileName=self._options.outfile_name.replace('.root','_in'+theTier+'.root')

                theFileName=self._options.dirout+anyOf(['fn','fileName'],outDefDict,defaultFileName)
                if not theFileName.endswith('.root'):
                    theFileName+='.root'

                if len(outDefDict):
                    raise Exception("unused keys from --output options: "+','.join(outDefDict.keys()))
                if theStreamType=='DQMIO': theStreamType='DQM'
                if theStreamType=='ALL':
                    theEventContent = cms.PSet(outputCommands = cms.untracked.vstring('keep *'))
                else:
                    theEventContent = getattr(self.process, theStreamType+"EventContent")


                addAlCaSelects=False
                if theStreamType=='ALCARECO' and not theFilterName:
                    theFilterName='StreamALCACombined'
                    addAlCaSelects=True

                CppType='PoolOutputModule'
                if self._options.timeoutOutput:
                    CppType='TimeoutPoolOutputModule'
                if theStreamType=='DQM' and theTier=='DQMIO': CppType='DQMRootOutputModule'
                output = cms.OutputModule(CppType,
                                          theEventContent.clone(),
                                          fileName = cms.untracked.string(theFileName),
                                          dataset = cms.untracked.PSet(
                                             dataTier = cms.untracked.string(theTier),
                                             filterName = cms.untracked.string(theFilterName))
                                          )
                if not theSelectEvent and hasattr(self.process,'generation_step') and theStreamType!='LHE':
                    output.SelectEvents = cms.untracked.PSet(SelectEvents = cms.vstring('generation_step'))
                if not theSelectEvent and hasattr(self.process,'filtering_step'):
                    output.SelectEvents = cms.untracked.PSet(SelectEvents = cms.vstring('filtering_step'))
                if theSelectEvent:
                    output.SelectEvents =cms.untracked.PSet(SelectEvents = cms.vstring(theSelectEvent))

                if addAlCaSelects:
                    if not hasattr(output,'SelectEvents'):
                        output.SelectEvents=cms.untracked.PSet(SelectEvents=cms.vstring())
                    for alca in self.AlCaPaths:
                        output.SelectEvents.SelectEvents.extend(getattr(self.process,'OutALCARECO'+alca).SelectEvents.SelectEvents)


                if hasattr(self.process,theModuleLabel):
                    raise Exception("the current process already has a module "+theModuleLabel+" defined")
                #print "creating output module ",theModuleLabel
                setattr(self.process,theModuleLabel,output)
                outputModule=getattr(self.process,theModuleLabel)
                setattr(self.process,theModuleLabel+'_step',cms.EndPath(outputModule))
                path=getattr(self.process,theModuleLabel+'_step')
                self.schedule.append(path)

                if not self._options.inlineEventContent and hasattr(self.process,theStreamType+"EventContent"):
                    def doNotInlineEventContent(instance,label = "cms.untracked.vstring(process."+theStreamType+"EventContent.outputCommands)"):                        return label
                    outputModule.outputCommands.__dict__["dumpPython"] = doNotInlineEventContent
                if theExtraOutputCommands:
                    if not isinstance(theExtraOutputCommands,list):
                        raise Exception("extra ouput command in --option must be a list of strings")
                    if hasattr(self.process,theStreamType+"EventContent"):
                        self.executeAndRemember('process.%s.outputCommands.extend(%s)'%(theModuleLabel,theExtraOutputCommands))
                    else:
                        outputModule.outputCommands.extend(theExtraOutputCommands)

                result+="\nprocess."+theModuleLabel+" = "+outputModule.dumpPython()

            
            return result

        streamTypes=self._options.eventcontent.split(',')
        tiers=self._options.datatier.split(',')
        if not self._options.outputDefinition and len(streamTypes)!=len(tiers):
            raise Exception("number of event content arguments does not match number of datatier arguments")

        # if the only step is alca we don't need to put in an output
        if self._options.step.split(',')[0].split(':')[0] == 'ALCA':
            return "\n"

        for i,(streamType,tier) in enumerate(zip(streamTypes,tiers)):
            if streamType=='': continue
            if streamType == 'ALCARECO' and not 'ALCAPRODUCER' in self._options.step: continue
            if streamType=='DQMIO': streamType='DQM'
            eventContent=streamType
            
            if streamType == "NANOEDMAOD" :
                eventContent = "NANOAOD"
            elif streamType == "NANOEDMAODSIM" :
                eventContent = "NANOAODSIM"
            theEventContent = getattr(self.process, eventContent+"EventContent")
            if i==0:
                theFileName=self._options.outfile_name
                theFilterName=self._options.filtername
            else:
                theFileName=self._options.outfile_name.replace('.root','_in'+streamType+'.root')
                theFilterName=self._options.filtername
            CppType='PoolOutputModule'
            if self._options.timeoutOutput:
                CppType='TimeoutPoolOutputModule'
            if streamType=='DQM' and tier=='DQMIO': CppType='DQMRootOutputModule'
            if "NANOAOD" in streamType : CppType='NanoAODOutputModule'
            output = cms.OutputModule(CppType,
                                      theEventContent,
                                      fileName = cms.untracked.string(theFileName),
                                      dataset = cms.untracked.PSet(dataTier = cms.untracked.string(tier),
                                                                   filterName = cms.untracked.string(theFilterName)
                                                                   )
                                      )
            if hasattr(self.process,"generation_step") and streamType!='LHE':
                output.SelectEvents = cms.untracked.PSet(SelectEvents = cms.vstring('generation_step'))
            if hasattr(self.process,"filtering_step"):
                output.SelectEvents = cms.untracked.PSet(SelectEvents = cms.vstring('filtering_step'))

            if streamType=='ALCARECO':
                output.dataset.filterName = cms.untracked.string('StreamALCACombined')

            if "MINIAOD" in streamType:
                from PhysicsTools.PatAlgos.slimming.miniAOD_tools import miniAOD_customizeOutput
                miniAOD_customizeOutput(output)

            outputModuleName=streamType+'output'
            setattr(self.process,outputModuleName,output)
            outputModule=getattr(self.process,outputModuleName)
            setattr(self.process,outputModuleName+'_step',cms.EndPath(outputModule))
            path=getattr(self.process,outputModuleName+'_step')
            self.schedule.append(path)

            if self._options.outputCommands and streamType!='DQM':
                for evct in self._options.outputCommands.split(','):
                    if not evct: continue
                    self.executeAndRemember("process.%s.outputCommands.append('%s')"%(outputModuleName,evct.strip()))

            if not self._options.inlineEventContent:
                tmpstreamType=streamType
                if "NANOEDM" in tmpstreamType :
                    tmpstreamType=tmpstreamType.replace("NANOEDM","NANO")
                def doNotInlineEventContent(instance,label = "process."+tmpstreamType+"EventContent.outputCommands"):
                    return label
                outputModule.outputCommands.__dict__["dumpPython"] = doNotInlineEventContent

            result+="\nprocess."+outputModuleName+" = "+outputModule.dumpPython()

        return result

    def addStandardSequences(self):
        """
        Add selected standard sequences to the process
        """
        # load the pile up file
        if self._options.pileup:
            pileupSpec=self._options.pileup.split(',')[0]

            #make sure there is a set of pileup files specified when needed
            pileups_without_input=[defaultOptions.pileup,"Cosmics","default","HiMixNoPU",None]
            if self._options.pileup not in pileups_without_input and self._options.pileup_input==None:
                message = "Pileup scenerio requires input files. Please add an appropriate --pileup_input option"
                raise Exception(message)

            # Does the requested pile-up scenario exist?
            from Configuration.StandardSequences.Mixing import Mixing,defineMixing
            if not pileupSpec in Mixing and '.' not in pileupSpec and 'file:' not in pileupSpec:
                message = pileupSpec+' is not a know mixing scenario:\n available are: '+'\n'.join(Mixing.keys())
                raise Exception(message)

            # Put mixing parameters in a dictionary
            if '.' in pileupSpec:
                mixingDict={'file':pileupSpec}
            elif pileupSpec.startswith('file:'):
                mixingDict={'file':pileupSpec[5:]}
            else:
                import copy
                mixingDict=copy.copy(Mixing[pileupSpec])
            if len(self._options.pileup.split(','))>1:
                mixingDict.update(eval(self._options.pileup[self._options.pileup.find(',')+1:]))

            # Load the pu cfg file corresponding to the requested pu scenario
            if 'file:' in pileupSpec:
                #the file is local
                self.process.load(mixingDict['file'])
                print("inlining mixing module configuration")
                self._options.inlineObjects+=',mix'
            else:
                self.loadAndRemember(mixingDict['file'])

            mixingDict.pop('file')
            if not "DATAMIX" in self.stepMap.keys(): # when DATAMIX is present, pileup_input refers to pre-mixed GEN-RAW
                if self._options.pileup_input:
                    if self._options.pileup_input.startswith('dbs:') or self._options.pileup_input.startswith('das:'):
                        mixingDict['F']=filesFromDASQuery('file dataset = %s'%(self._options.pileup_input[4:],),self._options.pileup_dasoption)[0]
                    elif self._options.pileup_input.startswith("filelist:"):
                        mixingDict['F']=(filesFromList(self._options.pileup_input[9:]))[0]
                    else:
                        mixingDict['F']=self._options.pileup_input.split(',')
                specialization=defineMixing(mixingDict)
                for command in specialization:
                    self.executeAndRemember(command)
                if len(mixingDict)!=0:
                    raise Exception('unused mixing specification: '+mixingDict.keys().__str__())


        # load the geometry file
        try:
            if len(self.stepMap):
                self.loadAndRemember(self.GeometryCFF)
                if ('SIM' in self.stepMap or 'reSIM' in self.stepMap) and not self._options.fast:
                    self.loadAndRemember(self.SimGeometryCFF)
                    if self.geometryDBLabel:
                        self.executeAndRemember('if hasattr(process, "XMLFromDBSource"): process.XMLFromDBSource.label="%s"'%(self.geometryDBLabel))
                        self.executeAndRemember('if hasattr(process, "DDDetectorESProducerFromDB"): process.DDDetectorESProducerFromDB.label="%s"'%(self.geometryDBLabel))

        except ImportError:
            print("Geometry option",self._options.geometry,"unknown.")
            raise

        if len(self.stepMap):
            self.loadAndRemember(self.magFieldCFF)

        for stepName in self.stepKeys:
            stepSpec = self.stepMap[stepName]
            print("Step:", stepName,"Spec:",stepSpec)
            if stepName.startswith('re'):
                
                if stepName[2:] not in self._options.donotDropOnInput:
                    self._options.inputEventContent='%s,%s'%(stepName.upper(),self._options.inputEventContent)
                stepName=stepName[2:]
            if stepSpec=="":
                getattr(self,"prepare_"+stepName)(stepSpec = getattr(self,stepName+"DefaultSeq"))
            elif isinstance(stepSpec, list):
                getattr(self,"prepare_"+stepName)(stepSpec = '+'.join(stepSpec))
            elif isinstance(stepSpec, tuple):
                getattr(self,"prepare_"+stepName)(stepSpec = ','.join([stepSpec[1],'+'.join(stepSpec[0])]))
            else:
                raise ValueError("Invalid step definition")

        if self._options.restoreRNDSeeds!=False:
            #it is either True, or a process name
            if self._options.restoreRNDSeeds==True:
                self.executeAndRemember('process.RandomNumberGeneratorService.restoreStateLabel=cms.untracked.string("randomEngineStateProducer")')
            else:
                self.executeAndRemember('process.RandomNumberGeneratorService.restoreStateTag=cms.untracked.InputTag("randomEngineStateProducer","","%s")'%(self._options.restoreRNDSeeds))
            if self._options.inputEventContent or self._options.inputCommands:
                if self._options.inputCommands:
                    self._options.inputCommands+='keep *_randomEngineStateProducer_*_*,'
                else:
                    self._options.inputCommands='keep *_randomEngineStateProducer_*_*,'


    def completeInputCommand(self):
        if self._options.inputEventContent:
            import copy
            def dropSecondDropStar(iec):
                #drop occurence of 'drop *' in the list
                count=0
                for item in iec:
                    if item=='drop *':
                        if count!=0:
                            iec.remove(item)
                        count+=1

            
            if not hasattr(self.process.source,'inputCommands'): self.process.source.inputCommands=cms.untracked.vstring()
            for evct in self._options.inputEventContent.split(','):
                if evct=='': continue
                theEventContent = getattr(self.process, evct+"EventContent")
                if hasattr(theEventContent,'outputCommands'):
                    self.process.source.inputCommands.extend(copy.copy(theEventContent.outputCommands))
                if hasattr(theEventContent,'inputCommands'):
                    self.process.source.inputCommands.extend(copy.copy(theEventContent.inputCommands))

            dropSecondDropStar(self.process.source.inputCommands)

            if not self._options.dropDescendant:
                self.process.source.dropDescendantsOfDroppedBranches = cms.untracked.bool(False)


        return

    def addConditions(self):
        """Add conditions to the process"""
        if not self._options.conditions: return

        if 'FrontierConditions_GlobalTag' in self._options.conditions:
            print('using FrontierConditions_GlobalTag in --conditions is not necessary anymore and will be deprecated soon. please update your command line')
            self._options.conditions = self._options.conditions.replace("FrontierConditions_GlobalTag,",'')

        self.loadAndRemember(self.ConditionsDefaultCFF)
        from Configuration.AlCa.GlobalTag import GlobalTag
        self.process.GlobalTag = GlobalTag(self.process.GlobalTag, self._options.conditions, self._options.custom_conditions)
        self.additionalCommands.append('from Configuration.AlCa.GlobalTag import GlobalTag')
        self.additionalCommands.append('process.GlobalTag = GlobalTag(process.GlobalTag, %s, %s)' % (repr(self._options.conditions), repr(self._options.custom_conditions)))


    def addCustomise(self,unsch=0):
        """Include the customise code """

        custOpt=[]
        if unsch==0:
            for c in self._options.customisation_file:
                custOpt.extend(c.split(","))
        else:
            for c in self._options.customisation_file_unsch:
                custOpt.extend(c.split(","))

        custMap=DictTypes.SortedKeysDict()
        for opt in custOpt:
            if opt=='': continue
            if opt.count('.')>1:
                raise Exception("more than . in the specification:"+opt)
            fileName=opt.split('.')[0]
            if opt.count('.')==0: rest='customise'
            else:
                rest=opt.split('.')[1]
                if rest=='py': rest='customise' #catch the case of --customise file.py

            if fileName in custMap:
                custMap[fileName].extend(rest.split('+'))
            else:
                custMap[fileName]=rest.split('+')

        if len(custMap)==0:
            final_snippet='\n'
        else:
            final_snippet='\n# customisation of the process.\n'

        allFcn=[]
        for opt in custMap:
            allFcn.extend(custMap[opt])
        for fcn in allFcn:
            if allFcn.count(fcn)!=1:
                raise Exception("cannot specify twice "+fcn+" as a customisation method")

        for f in custMap:
            # let python search for that package and do syntax checking at the same time
            packageName = f.replace(".py","").replace("/",".")
            __import__(packageName)
            package = sys.modules[packageName]

            # now ask the package for its definition and pick .py instead of .pyc
            customiseFile = re.sub(r'\.pyc$', '.py', package.__file__)

            final_snippet+='\n# Automatic addition of the customisation function from '+packageName+'\n'
            if self._options.inline_custom:
                for line in file(customiseFile,'r'):
                    if "import FWCore.ParameterSet.Config" in line:
                        continue
                    final_snippet += line
            else:
                final_snippet += 'from %s import %s \n'%(packageName,','.join(custMap[f]))
            for fcn in custMap[f]:
                print("customising the process with",fcn,"from",f)
                if not hasattr(package,fcn):
                    #bound to fail at run time
                    raise Exception("config "+f+" has no function "+fcn)
                #execute the command
                self.process=getattr(package,fcn)(self.process)
                #and print it in the configuration
                final_snippet += "\n#call to customisation function "+fcn+" imported from "+packageName
                final_snippet += "\nprocess = %s(process)\n"%(fcn,)

        if len(custMap)!=0:
            final_snippet += '\n# End of customisation functions\n'

        
        return final_snippet

    def addCustomiseCmdLine(self):
        final_snippet='\n# Customisation from command line\n'
        if self._options.customise_commands:
            import string
            for com in self._options.customise_commands.split('\\n'):
                com=com.lstrip()
                self.executeAndRemember(com)
                final_snippet +='\n'+com

        return final_snippet

    #----------------------------------------------------------------------------
    # here the methods to define the python includes for each step or
    # conditions
    #----------------------------------------------------------------------------
    def define_Configs(self):
        if len(self.stepMap):
            self.loadAndRemember('Configuration/StandardSequences/Services_cff')
        if self._options.particleTable not in defaultOptions.particleTableList:
            print('Invalid particle table provided. Options are:')
            print(defaultOptions.particleTable)
            sys.exit(-1)
        else:
            if len(self.stepMap):
                self.loadAndRemember('SimGeneral.HepPDTESSource.'+self._options.particleTable+'_cfi')

        self.loadAndRemember('FWCore/MessageService/MessageLogger_cfi')

        self.ALCADefaultCFF="Configuration/StandardSequences/AlCaRecoStreams_cff"
        self.GENDefaultCFF="Configuration/StandardSequences/Generator_cff"
        self.SIMDefaultCFF="Configuration/StandardSequences/Sim_cff"
        self.DIGIDefaultCFF="Configuration/StandardSequences/Digi_cff"
        self.DIGI2RAWDefaultCFF="Configuration/StandardSequences/DigiToRaw_cff"
        self.L1EMDefaultCFF='Configuration/StandardSequences/SimL1Emulator_cff'
        self.L1P2GTDefaultCFF = 'Configuration/StandardSequences/SimPhase2L1GlobalTriggerEmulator_cff'
        self.L1MENUDefaultCFF="Configuration/StandardSequences/L1TriggerDefaultMenu_cff"
        self.HLTDefaultCFF="Configuration/StandardSequences/HLTtable_cff"
        self.RAW2DIGIDefaultCFF="Configuration/StandardSequences/RawToDigi_Data_cff"
        if self._options.isRepacked: self.RAW2DIGIDefaultCFF="Configuration/StandardSequences/RawToDigi_DataMapper_cff"
        self.L1RecoDefaultCFF="Configuration/StandardSequences/L1Reco_cff"
        self.L1TrackTriggerDefaultCFF="Configuration/StandardSequences/L1TrackTrigger_cff"
        self.RECODefaultCFF="Configuration/StandardSequences/Reconstruction_Data_cff"
        self.RECOSIMDefaultCFF="Configuration/StandardSequences/RecoSim_cff"
        self.PATDefaultCFF="Configuration/StandardSequences/PAT_cff"
        self.NANODefaultCFF="PhysicsTools/NanoAOD/nano_cff"
        self.NANOGENDefaultCFF="PhysicsTools/NanoAOD/nanogen_cff"
        self.SKIMDefaultCFF="Configuration/StandardSequences/Skims_cff"
        self.POSTRECODefaultCFF="Configuration/StandardSequences/PostRecoGenerator_cff"
        self.VALIDATIONDefaultCFF="Configuration/StandardSequences/Validation_cff"
        self.L1HwValDefaultCFF = "Configuration/StandardSequences/L1HwVal_cff"
        self.DQMOFFLINEDefaultCFF="DQMOffline/Configuration/DQMOffline_cff"
        self.HARVESTINGDefaultCFF="Configuration/StandardSequences/Harvesting_cff"
        self.ALCAHARVESTDefaultCFF="Configuration/StandardSequences/AlCaHarvesting_cff"
        self.ENDJOBDefaultCFF="Configuration/StandardSequences/EndOfProcess_cff"
        self.ConditionsDefaultCFF = "Configuration/StandardSequences/FrontierConditions_GlobalTag_cff"
        self.CFWRITERDefaultCFF = "Configuration/StandardSequences/CrossingFrameWriter_cff"
        self.REPACKDefaultCFF="Configuration/StandardSequences/DigiToRaw_Repack_cff"

        if "DATAMIX" in self.stepMap.keys():
            self.DATAMIXDefaultCFF="Configuration/StandardSequences/DataMixer"+self._options.datamix+"_cff"
            self.DIGIDefaultCFF="Configuration/StandardSequences/DigiDM_cff"
            self.DIGI2RAWDefaultCFF="Configuration/StandardSequences/DigiToRawDM_cff"
            self.L1EMDefaultCFF='Configuration/StandardSequences/SimL1EmulatorDM_cff'

        self.ALCADefaultSeq=None
        self.LHEDefaultSeq='externalLHEProducer'
        self.GENDefaultSeq='pgen'
        self.SIMDefaultSeq='psim'
        self.DIGIDefaultSeq='pdigi'
        self.DATAMIXDefaultSeq=None
        self.DIGI2RAWDefaultSeq='DigiToRaw'
        self.HLTDefaultSeq='GRun'
        self.L1DefaultSeq=None
        self.L1P2GTDefaultSeq=None
        self.L1REPACKDefaultSeq='GT'
        self.HARVESTINGDefaultSeq=None
        self.ALCAHARVESTDefaultSeq=None
        self.CFWRITERDefaultSeq=None
        self.RAW2DIGIDefaultSeq='RawToDigi'
        self.L1RecoDefaultSeq='L1Reco'
        self.L1TrackTriggerDefaultSeq='L1TrackTrigger'
        if self._options.fast or ('RAW2DIGI' in self.stepMap and 'RECO' in self.stepMap):
            self.RECODefaultSeq='reconstruction'
        else:
            self.RECODefaultSeq='reconstruction_fromRECO'
        self.RECOSIMDefaultSeq='recosim'
        self.POSTRECODefaultSeq=None
        self.L1HwValDefaultSeq='L1HwVal'
        self.DQMDefaultSeq='DQMOffline'
        self.VALIDATIONDefaultSeq=''
        self.ENDJOBDefaultSeq='endOfProcess'
        self.REPACKDefaultSeq='DigiToRawRepack'
        self.PATDefaultSeq='miniAOD'
        self.PATGENDefaultSeq='miniGEN'
        #TODO: Check based of file input
        self.NANOGENDefaultSeq='nanogenSequence'
        self.NANODefaultSeq='nanoSequence'
        self.NANODefaultCustom='nanoAOD_customizeCommon'

        self.EVTCONTDefaultCFF="Configuration/EventContent/EventContent_cff"

        if not self._options.beamspot:
            self._options.beamspot=VtxSmearedDefaultKey

        # if its MC then change the raw2digi
        if self._options.isMC==True:
            self.RAW2DIGIDefaultCFF="Configuration/StandardSequences/RawToDigi_cff"
            self.RECODefaultCFF="Configuration/StandardSequences/Reconstruction_cff"
            self.PATDefaultCFF="Configuration/StandardSequences/PATMC_cff"
            self.PATGENDefaultCFF="Configuration/StandardSequences/PATGEN_cff"
            self.DQMOFFLINEDefaultCFF="DQMOffline/Configuration/DQMOfflineMC_cff"
            self.ALCADefaultCFF="Configuration/StandardSequences/AlCaRecoStreamsMC_cff"
            self.NANODefaultSeq='nanoSequenceMC'
        else:
            self._options.beamspot = None

        #patch for gen, due to backward incompatibility
        if 'reGEN' in self.stepMap:
            self.GENDefaultSeq='fixGenInfo'

        if self._options.scenario=='cosmics':
            self._options.pileup='Cosmics'
            self.DIGIDefaultCFF="Configuration/StandardSequences/DigiCosmics_cff"
            self.RECODefaultCFF="Configuration/StandardSequences/ReconstructionCosmics_cff"
            self.SKIMDefaultCFF="Configuration/StandardSequences/SkimsCosmics_cff"
            self.EVTCONTDefaultCFF="Configuration/EventContent/EventContentCosmics_cff"
            self.VALIDATIONDefaultCFF="Configuration/StandardSequences/ValidationCosmics_cff"
            self.DQMOFFLINEDefaultCFF="DQMOffline/Configuration/DQMOfflineCosmics_cff"
            if self._options.isMC==True:
                self.DQMOFFLINEDefaultCFF="DQMOffline/Configuration/DQMOfflineCosmicsMC_cff"
            self.HARVESTINGDefaultCFF="Configuration/StandardSequences/HarvestingCosmics_cff"
            self.RECODefaultSeq='reconstructionCosmics'
            self.DQMDefaultSeq='DQMOfflineCosmics'

        if self._options.scenario=='HeavyIons':
            if not self._options.beamspot:
                self._options.beamspot=VtxSmearedHIDefaultKey
            self.HLTDefaultSeq = 'HIon'
            self.VALIDATIONDefaultCFF="Configuration/StandardSequences/ValidationHeavyIons_cff"
            self.VALIDATIONDefaultSeq=''
            self.EVTCONTDefaultCFF="Configuration/EventContent/EventContentHeavyIons_cff"
            self.RECODefaultCFF="Configuration/StandardSequences/ReconstructionHeavyIons_cff"
            self.RECODefaultSeq='reconstructionHeavyIons'
            self.ALCADefaultCFF = "Configuration/StandardSequences/AlCaRecoStreamsHeavyIons_cff"
            self.DQMOFFLINEDefaultCFF="DQMOffline/Configuration/DQMOfflineHeavyIons_cff"
            self.DQMDefaultSeq='DQMOfflineHeavyIons'
            self.SKIMDefaultCFF="Configuration/StandardSequences/SkimsHeavyIons_cff"
            self.HARVESTINGDefaultCFF="Configuration/StandardSequences/HarvestingHeavyIons_cff"
            if self._options.isMC==True:
                self.DQMOFFLINEDefaultCFF="DQMOffline/Configuration/DQMOfflineHeavyIonsMC_cff"


        self.RAW2RECODefaultSeq=','.join([self.RAW2DIGIDefaultSeq,self.RECODefaultSeq])

        self.USERDefaultSeq='user'
        self.USERDefaultCFF=None

        # the magnetic field
        self.magFieldCFF = 'Configuration/StandardSequences/MagneticField_'+self._options.magField.replace('.','')+'_cff'
        self.magFieldCFF = self.magFieldCFF.replace("__",'_')

        # the geometry
        self.GeometryCFF='Configuration/StandardSequences/GeometryRecoDB_cff'
        self.geometryDBLabel=None
        simGeometry=''
        if self._options.fast:
            if 'start' in self._options.conditions.lower():
                self.GeometryCFF='FastSimulation/Configuration/Geometries_START_cff'
            else:
                self.GeometryCFF='FastSimulation/Configuration/Geometries_MC_cff'
        else:
            def inGeometryKeys(opt):
                from Configuration.StandardSequences.GeometryConf import GeometryConf
                if opt in GeometryConf:
                    return GeometryConf[opt]
                else:
                    return opt

            geoms=self._options.geometry.split(',')
            if len(geoms)==1: geoms=inGeometryKeys(geoms[0]).split(',')
            if len(geoms)==2:
                #may specify the reco geometry
                if '/' in geoms[1] or '_cff' in geoms[1]:
                    self.GeometryCFF=geoms[1]
                else:
                    self.GeometryCFF='Configuration/Geometry/Geometry'+geoms[1]+'_cff'

            if (geoms[0].startswith('DB:')):
                self.SimGeometryCFF='Configuration/StandardSequences/GeometrySimDB_cff'
                self.geometryDBLabel=geoms[0][3:]
                print("with DB:")
            else:
                if '/' in geoms[0] or '_cff' in geoms[0]:
                    self.SimGeometryCFF=geoms[0]
                else:
                    simGeometry=geoms[0]
                    if self._options.gflash==True:
                        self.SimGeometryCFF='Configuration/Geometry/Geometry'+geoms[0]+'GFlash_cff'
                    else:
                        self.SimGeometryCFF='Configuration/Geometry/Geometry'+geoms[0]+'_cff'

        # synchronize the geometry configuration and the FullSimulation sequence to be used
        if simGeometry not in defaultOptions.geometryExtendedOptions:
            self.SIMDefaultCFF="Configuration/StandardSequences/SimIdeal_cff"

        if self._options.scenario=='nocoll' or self._options.scenario=='cosmics':
            self.SIMDefaultCFF="Configuration/StandardSequences/SimNOBEAM_cff"
            self._options.beamspot='NoSmear'

        # fastsim requires some changes to the default cff files and sequences
        if self._options.fast:
            self.SIMDefaultCFF = 'FastSimulation.Configuration.SimIdeal_cff'
            self.RECODefaultCFF= 'FastSimulation.Configuration.Reconstruction_AftMix_cff'
            self.RECOBEFMIXDefaultCFF = 'FastSimulation.Configuration.Reconstruction_BefMix_cff'
            self.RECOBEFMIXDefaultSeq = 'reconstruction_befmix'
            self.NANODefaultSeq = 'nanoSequenceFS'
            self.DQMOFFLINEDefaultCFF="DQMOffline.Configuration.DQMOfflineFS_cff"

        # Mixing
        if self._options.pileup=='default':
            from Configuration.StandardSequences.Mixing import MixingDefaultKey
            self._options.pileup=MixingDefaultKey


        #not driven by a default cff anymore
        if self._options.isData:
            self._options.pileup=None


        self.REDIGIDefaultSeq=self.DIGIDefaultSeq

    # for alca, skims, etc
    def addExtraStream(self, name, stream, workflow='full'):
            # define output module and go from there
        output = cms.OutputModule("PoolOutputModule")
        if stream.selectEvents.parameters_().__len__()!=0:
            output.SelectEvents = stream.selectEvents
        else:
            output.SelectEvents = cms.untracked.PSet()
            output.SelectEvents.SelectEvents=cms.vstring()
            if isinstance(stream.paths,tuple):
                for path in stream.paths:
                    output.SelectEvents.SelectEvents.append(path.label())
            else:
                output.SelectEvents.SelectEvents.append(stream.paths.label())



        if isinstance(stream.content,str):
            evtPset=getattr(self.process,stream.content)
            for p in evtPset.parameters_():
                setattr(output,p,getattr(evtPset,p))
            if not self._options.inlineEventContent:
                def doNotInlineEventContent(instance,label = "process."+stream.content+".outputCommands"):
                    return label
                output.outputCommands.__dict__["dumpPython"] = doNotInlineEventContent
        else:
            output.outputCommands = stream.content


        output.fileName = cms.untracked.string(self._options.dirout+stream.name+'.root')

        output.dataset  = cms.untracked.PSet( dataTier = stream.dataTier,
                                              filterName = cms.untracked.string(stream.name))

        if self._options.filtername:
            output.dataset.filterName= cms.untracked.string(self._options.filtername+"_"+stream.name)

        #add an automatic flushing to limit memory consumption
        output.eventAutoFlushCompressedSize=cms.untracked.int32(5*1024*1024)

        if workflow in ("producers,full"):
            if isinstance(stream.paths,tuple):
                for path in stream.paths:
                    self.schedule.append(path)
            else:
                self.schedule.append(stream.paths)


        # in case of relvals we don't want to have additional outputs
        if (not self._options.relval) and workflow in ("full","output"):
            self.additionalOutputs[name] = output
            setattr(self.process,name,output)

        if workflow == 'output':
            # adjust the select events to the proper trigger results from previous process
            filterList = output.SelectEvents.SelectEvents
            for i, filter in enumerate(filterList):
                filterList[i] = filter+":"+self._options.triggerResultsProcess

        return output

    #----------------------------------------------------------------------------
    # here the methods to create the steps. Of course we are doing magic here ;)
    # prepare_STEPNAME modifies self.process and what else's needed.
    #----------------------------------------------------------------------------

    def loadDefaultOrSpecifiedCFF(self, stepSpec, defaultCFF, defaultSEQ=''):
        _dotsplit = stepSpec.split('.')
        if ( len(_dotsplit)==1 ):
            if '/' in _dotsplit[0]:
                _sequence = defaultSEQ if defaultSEQ else stepSpec 
                _cff = _dotsplit[0]
            else:
                _sequence = stepSpec
                _cff = defaultCFF
        elif ( len(_dotsplit)==2 ):
            _cff,_sequence  = _dotsplit
        else:
            print("sub sequence configuration must be of the form dir/subdir/cff.a+b+c or cff.a")
            print(stepSpec,"not recognized")
            raise
        l=self.loadAndRemember(_cff)
        return l,_sequence,_cff

    def scheduleSequence(self,seq,prefix,what='Path'):
        if '*' in seq:
            #create only one path with all sequences in it
            for i,s in enumerate(seq.split('*')):
                if i==0:
                    setattr(self.process,prefix,getattr(cms,what)( getattr(self.process, s) ))
                else:
                    p=getattr(self.process,prefix)
                    tmp = getattr(self.process, s)
                    if isinstance(tmp, cms.Task):
                        p.associate(tmp)
                    else:
                        p+=tmp
            self.schedule.append(getattr(self.process,prefix))
            return
        else:
            #create as many path as many sequences
            if not '+' in seq:
                if self.nextScheduleIsConditional:
                    self.conditionalPaths.append(prefix)
                setattr(self.process,prefix,getattr(cms,what)( getattr(self.process, seq) ))
                self.schedule.append(getattr(self.process,prefix))
            else:
                for i,s in enumerate(seq.split('+')):
                    sn=prefix+'%d'%(i)
                    setattr(self.process,sn,getattr(cms,what)( getattr(self.process, s) ))
                    self.schedule.append(getattr(self.process,sn))
            return

    def scheduleSequenceAtEnd(self,seq,prefix):
        self.scheduleSequence(seq,prefix,what='EndPath')
        return

    def prepare_ALCAPRODUCER(self, stepSpec = None):
        self.prepare_ALCA(stepSpec, workflow = "producers")

    def prepare_ALCAOUTPUT(self, stepSpec = None):
        self.prepare_ALCA(stepSpec, workflow = "output")

    def prepare_ALCA(self, stepSpec = None, workflow = 'full'):
        """ Enrich the process with alca streams """
        alcaConfig,sequence,_=self.loadDefaultOrSpecifiedCFF(stepSpec,self.ALCADefaultCFF)

        MAXLEN=31 #the alca producer name should be shorter than 31 chars as per https://cms-talk.web.cern.ch/t/alcaprompt-datasets-not-loaded-in-dbs/11146/2
        # decide which ALCA paths to use
        alcaList = sequence.split("+")
        for alca in alcaList:
            if (len(alca)>MAXLEN):
                raise Exception("The following alca "+str(alca)+" name (with length "+str(len(alca))+" chars) cannot be accepted because it exceeds the DBS constraints on the length of the name of the ALCARECOs producers ("+str(MAXLEN)+")!")

        maxLevel=0
        from Configuration.AlCa.autoAlca import autoAlca, AlCaNoConcurrentLumis
        # support @X from autoAlca.py, and recursion support: i.e T0:@Mu+@EG+...
        self.expandMapping(alcaList,autoAlca)
        self.AlCaPaths=[]
        for name in alcaConfig.__dict__:
            alcastream = getattr(alcaConfig,name)
            shortName = name.replace('ALCARECOStream','')
            if shortName in alcaList and isinstance(alcastream,cms.FilteredStream):
                if shortName in AlCaNoConcurrentLumis:
                    print("Setting numberOfConcurrentLuminosityBlocks=1 because of AlCa sequence {}".format(shortName))
                    self._options.nConcurrentLumis = 1
                    self._options.nConcurrentIOVs = 1
                output = self.addExtraStream(name,alcastream, workflow = workflow)
                self.executeAndRemember('process.ALCARECOEventContent.outputCommands.extend(process.OutALCARECO'+shortName+'_noDrop.outputCommands)')
                self.AlCaPaths.append(shortName)
                if 'DQM' in alcaList:
                    if not self._options.inlineEventContent and hasattr(self.process,name):
                        self.executeAndRemember('process.' + name + '.outputCommands.append("keep *_MEtoEDMConverter_*_*")')
                    else:
                        output.outputCommands.append("keep *_MEtoEDMConverter_*_*")

                #rename the HLT process name in the alca modules
                if self._options.hltProcess or 'HLT' in self.stepMap:
                    if isinstance(alcastream.paths,tuple):
                        for path in alcastream.paths:
                            self.renameHLTprocessInSequence(path.label())
                    else:
                        self.renameHLTprocessInSequence(alcastream.paths.label())

                for i in range(alcaList.count(shortName)):
                    alcaList.remove(shortName)

            # DQM needs a special handling
            elif name == 'pathALCARECODQM' and 'DQM' in alcaList:
                path = getattr(alcaConfig,name)
                self.schedule.append(path)
                alcaList.remove('DQM')

            if isinstance(alcastream,cms.Path):
                #black list the alca path so that they do not appear in the cfg
                self.blacklist_paths.append(alcastream)


        if len(alcaList) != 0:
            available=[]
            for name in alcaConfig.__dict__:
                alcastream = getattr(alcaConfig,name)
                if isinstance(alcastream,cms.FilteredStream):
                    available.append(name.replace('ALCARECOStream',''))
            print("The following alcas could not be found "+str(alcaList))
            print("available ",available)
            #print "verify your configuration, ignoring for now"
            raise Exception("The following alcas could not be found "+str(alcaList))

    def prepare_LHE(self, stepSpec = None):
            #load the fragment
            
        loadFragment = self._options.evt_type.replace('.py','',).replace('.','_').replace('python/','').replace('/','.')
        print("Loading lhe fragment from",loadFragment)
        __import__(loadFragment)
        self.process.load(loadFragment)
        
        self._options.inlineObjects+=','+stepSpec

        getattr(self.process,stepSpec).nEvents = self._options.number

        #schedule it
        self.process.lhe_step = cms.Path( getattr( self.process,stepSpec)  )
        self.excludedPaths.append("lhe_step")
        self.schedule.append( self.process.lhe_step )

    def prepare_GEN(self, stepSpec = None):
        """ load the fragment of generator configuration """
        loadFailure=False
        #remove trailing .py
        #support old style .cfi by changing into something.cfi into something_cfi
        #remove python/ from the name
        loadFragment = self._options.evt_type.replace('.py','',).replace('.','_').replace('python/','')
        #standard location of fragments
        if not '/' in loadFragment:
            loadFragment='Configuration.Generator.'+loadFragment
        else:
            loadFragment=loadFragment.replace('/','.')
        try:
            print("Loading generator fragment from",loadFragment)
            __import__(loadFragment)
        except:
            loadFailure=True
            #if self.process.source and self.process.source.type_()=='EmptySource':
            if not (self._options.filein or self._options.dasquery):
                raise Exception("Neither gen fragment of input files provided: this is an inconsistent GEN step configuration")

        if not loadFailure:
            from Configuration.Generator.concurrentLumisDisable import noConcurrentLumiGenerators

            generatorModule=sys.modules[loadFragment]
            genModules=generatorModule.__dict__
            #remove lhe producer module since this should have been
            #imported instead in the LHE step
            if self.LHEDefaultSeq in genModules:
                del genModules[self.LHEDefaultSeq]

            if self._options.hideGen:
                self.loadAndRemember(loadFragment)
            else:
                self.process.load(loadFragment)
                # expose the objects from that fragment to the configuration
                import FWCore.ParameterSet.Modules as cmstypes
                for name in genModules:
                    theObject = getattr(generatorModule,name)
                    if isinstance(theObject, cmstypes._Module):
                        self._options.inlineObjects=name+','+self._options.inlineObjects
                        if theObject.type_() in noConcurrentLumiGenerators:
                            print("Setting numberOfConcurrentLuminosityBlocks=1 because of generator {}".format(theObject.type_()))
                            self._options.nConcurrentLumis = 1
                            self._options.nConcurrentIOVs = 1
                    elif isinstance(theObject, cms.Sequence) or isinstance(theObject, cmstypes.ESProducer):
                        self._options.inlineObjects+=','+name

            if stepSpec == self.GENDefaultSeq or stepSpec == 'pgen_genonly':
                if 'ProductionFilterSequence' in genModules and ('generator' in genModules):
                    self.productionFilterSequence = 'ProductionFilterSequence'
                elif 'generator' in genModules:
                    self.productionFilterSequence = 'generator'

        """ Enrich the schedule with the rest of the generation step """
        _,_genSeqName,_=self.loadDefaultOrSpecifiedCFF(stepSpec,self.GENDefaultCFF)

        if True:
            try:
                from Configuration.StandardSequences.VtxSmeared import VtxSmeared
                cffToBeLoaded=VtxSmeared[self._options.beamspot]
                self.loadAndRemember(cffToBeLoaded)
            except ImportError:
                raise Exception("VertexSmearing type or beamspot "+self._options.beamspot+" unknown.")

            if self._options.scenario == 'HeavyIons':
                if self._options.pileup=='HiMixGEN':
                    self.loadAndRemember("Configuration/StandardSequences/GeneratorMix_cff")
                elif self._options.pileup=='HiMixEmbGEN':
                    self.loadAndRemember("Configuration/StandardSequences/GeneratorEmbMix_cff")
                else:
                    self.loadAndRemember("Configuration/StandardSequences/GeneratorHI_cff")

        self.process.generation_step = cms.Path( getattr(self.process,_genSeqName) )
        self.schedule.append(self.process.generation_step)

        #register to the genstepfilter the name of the path (static right now, but might evolve)
        self.executeAndRemember('process.genstepfilter.triggerConditions=cms.vstring("generation_step")')

        if 'reGEN' in self.stepMap or stepSpec == 'pgen_smear':
            #stop here
            return

        """ Enrich the schedule with the summary of the filter step """
        #the gen filter in the endpath
        self.loadAndRemember("GeneratorInterface/Core/genFilterSummary_cff")
        self.scheduleSequenceAtEnd('genFilterSummary','genfiltersummary_step')
        return

    def prepare_SIM(self, stepSpec = None):
        """ Enrich the schedule with the simulation step"""
        _,_simSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.SIMDefaultCFF)
        if not self._options.fast:
            if self._options.gflash==True:
                self.loadAndRemember("Configuration/StandardSequences/GFlashSIM_cff")

            if self._options.magField=='0T':
                self.executeAndRemember("process.g4SimHits.UseMagneticField = cms.bool(False)")
        else:
            if self._options.magField=='0T':
                self.executeAndRemember("process.fastSimProducer.detectorDefinition.magneticFieldZ = cms.untracked.double(0.)")

        self.scheduleSequence(_simSeq,'simulation_step')
        return

    def prepare_DIGI(self, stepSpec = None):
        """ Enrich the schedule with the digitisation step"""
        _,_digiSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.DIGIDefaultCFF)

        if self._options.gflash==True:
            self.loadAndRemember("Configuration/StandardSequences/GFlashDIGI_cff")

        if _digiSeq == 'pdigi_valid' or _digiSeq == 'pdigi_hi':
            self.executeAndRemember("process.mix.digitizers = cms.PSet(process.theDigitizersValid)")

        if _digiSeq != 'pdigi_nogen' and _digiSeq != 'pdigi_valid_nogen' and _digiSeq != 'pdigi_hi_nogen' and not self.process.source.type_()=='EmptySource' and not self._options.filetype == "LHE":
            if self._options.inputEventContent=='':
                self._options.inputEventContent='REGEN'
            else:
                self._options.inputEventContent=self._options.inputEventContent+',REGEN'


        self.scheduleSequence(_digiSeq,'digitisation_step')
        return

    def prepare_CFWRITER(self, stepSpec = None):
        """ Enrich the schedule with the crossing frame writer step"""
        self.loadAndRemember(self.CFWRITERDefaultCFF)
        self.scheduleSequence('pcfw','cfwriter_step')
        return

    def prepare_DATAMIX(self, stepSpec = None):
        """ Enrich the schedule with the digitisation step"""
        self.loadAndRemember(self.DATAMIXDefaultCFF)
        self.scheduleSequence('pdatamix','datamixing_step')

        if self._options.pileup_input:
            theFiles=''
            if self._options.pileup_input.startswith('dbs:') or self._options.pileup_input.startswith('das:'):
                theFiles=filesFromDASQuery('file dataset = %s'%(self._options.pileup_input[4:],),self._options.pileup_dasoption)[0]
            elif self._options.pileup_input.startswith("filelist:"):
                theFiles= (filesFromList(self._options.pileup_input[9:]))[0]
            else:
                theFiles=self._options.pileup_input.split(',')
            #print theFiles
            self.executeAndRemember( "process.mixData.input.fileNames = cms.untracked.vstring(%s)"%(  theFiles ) )

        return

    def prepare_DIGI2RAW(self, stepSpec = None):
        _,_digi2rawSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.DIGI2RAWDefaultCFF)
        self.scheduleSequence(_digi2rawSeq,'digi2raw_step')
        return

    def prepare_REPACK(self, stepSpec = None):
        _,_repackSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.REPACKDefaultCFF)
        self.scheduleSequence(_repackSeq,'digi2repack_step')
        return

    def loadPhase2GTMenu(self, menuFile: str):
        import importlib
        menuPath = f'L1Trigger.Configuration.Phase2GTMenus.{menuFile}'
        menuModule = importlib.import_module(menuPath)
        
        theMenu = menuModule.menu
        triggerPaths = [] #we get a list of paths in each of these files to schedule

        for triggerPathFile in theMenu:
            self.loadAndRemember(triggerPathFile) #this load and remember will set the algo variable of the algoblock later

            triggerPathModule = importlib.import_module(triggerPathFile)
            for objName in dir(triggerPathModule):
                obj = getattr(triggerPathModule, objName)
                objType = type(obj)
                if objType == cms.Path:
                    triggerPaths.append(objName)
        
        triggerScheduleList = [getattr(self.process, name) for name in triggerPaths] #get the actual paths to put in the schedule
        self.schedule.extend(triggerScheduleList) #put them in the schedule for later
    
    # create the L1 GT step
    # We abuse the stepSpec a bit as a way to specify a menu
    def prepare_L1P2GT(self, stepSpec=None):
        """ Run the GT emulation sequence on top of the L1 emulation step """
        self.loadAndRemember(self.L1P2GTDefaultCFF)
        self.scheduleSequence('l1tGTProducerSequence', 'Phase2L1GTProducer')
        self.scheduleSequence('l1tGTAlgoBlockProducerSequence', 'Phase2L1GTAlgoBlockProducer')
        if stepSpec == None:
            defaultMenuFile = "prototype_2023_v1_0_0"
            self.loadPhase2GTMenu(menuFile = defaultMenuFile)
        else:
            self.loadPhase2GTMenu(menuFile = stepSpec)

    def prepare_L1(self, stepSpec = None):
        """ Enrich the schedule with the L1 simulation step"""
        assert(stepSpec == None)
        self.loadAndRemember(self.L1EMDefaultCFF)
        self.scheduleSequence('SimL1Emulator','L1simulation_step')
        return

    def prepare_L1REPACK(self, stepSpec = None):
        """ Enrich the schedule with the L1 simulation step, running the L1 emulator on data unpacked from the RAW collection, and repacking the result in a new RAW collection"""
        supported = ['GT','GT1','GT2','GCTGT','Full','FullSimTP','FullMC','Full2015Data','uGT','CalouGT']
        if stepSpec in supported:
            self.loadAndRemember('Configuration/StandardSequences/SimL1EmulatorRepack_%s_cff'% stepSpec)
            if self._options.scenario == 'HeavyIons':
                self.renameInputTagsInSequence("SimL1Emulator","rawDataCollector","rawDataRepacker")
            self.scheduleSequence('SimL1Emulator','L1RePack_step')
        else:
            print("L1REPACK with '",stepSpec,"' is not supported! Supported choices are: ",supported)
            raise Exception('unsupported feature')

    def prepare_HLT(self, stepSpec = None):
        """ Enrich the schedule with the HLT simulation step"""
        if not stepSpec:
            print("no specification of the hlt menu has been given, should never happen")
            raise  Exception('no HLT specifications provided')

        if '@' in stepSpec:
            # case where HLT:@something was provided
            from Configuration.HLT.autoHLT import autoHLT
            key = stepSpec[1:]
            if key in autoHLT:
                stepSpec = autoHLT[key]
            else:
                raise ValueError('no HLT mapping key "%s" found in autoHLT' % key)

        if ',' in stepSpec:
            #case where HLT:something:something was provided
            self.executeAndRemember('import HLTrigger.Configuration.Utilities')
            optionsForHLT = {}
            if self._options.scenario == 'HeavyIons':
                optionsForHLT['type'] = 'HIon'
            else:
                optionsForHLT['type'] = 'GRun'
            optionsForHLTConfig = ', '.join('%s=%s' % (key, repr(val)) for (key, val) in optionsForHLT.items())
            if stepSpec == 'run,fromSource':
                if hasattr(self.process.source,'firstRun'):
                    self.executeAndRemember('process.loadHltConfiguration("run:%%d"%%(process.source.firstRun.value()),%s)'%(optionsForHLTConfig))
                elif hasattr(self.process.source,'setRunNumber'):
                    self.executeAndRemember('process.loadHltConfiguration("run:%%d"%%(process.source.setRunNumber.value()),%s)'%(optionsForHLTConfig))
                else:
                    raise Exception(f'Cannot replace menu to load {stepSpec}')
            else:
                self.executeAndRemember('process.loadHltConfiguration("%s",%s)'%(stepSpec.replace(',',':'),optionsForHLTConfig))
        else:
            self.loadAndRemember('HLTrigger/Configuration/HLT_%s_cff' % stepSpec)

        if self._options.isMC:
            self._options.customisation_file.append("HLTrigger/Configuration/customizeHLTforMC.customizeHLTforMC")

        if self._options.name != 'HLT':
            self.additionalCommands.append('from HLTrigger.Configuration.CustomConfigs import ProcessName')
            self.additionalCommands.append('process = ProcessName(process)')
            self.additionalCommands.append('')
            from HLTrigger.Configuration.CustomConfigs import ProcessName
            self.process = ProcessName(self.process)

        if self.process.schedule == None:
            raise Exception('the HLT step did not attach a valid schedule to the process')

        self.scheduleIndexOfFirstHLTPath = len(self.schedule)
        [self.blacklist_paths.append(path) for path in self.process.schedule if isinstance(path,(cms.Path,cms.EndPath))]

        # this is a fake, to be removed with fastim migration and HLT menu dump
        if self._options.fast:
            if not hasattr(self.process,'HLTEndSequence'):
                self.executeAndRemember("process.HLTEndSequence = cms.Sequence( process.dummyModule )")


    def prepare_RAW2RECO(self, stepSpec = None):
        if ','in stepSpec:
            seqReco,seqDigi=stepSpec.spli(',')
        else:
            print(f"RAW2RECO requires two specifications {stepSpec} insufficient")

        self.prepare_RAW2DIGI(seqDigi)
        self.prepare_RECO(seqReco)
        return

    def prepare_RAW2DIGI(self, stepSpec = "RawToDigi"):
        _,_raw2digiSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.RAW2DIGIDefaultCFF)
        self.scheduleSequence(_raw2digiSeq,'raw2digi_step')
        return

    def prepare_PATFILTER(self, stepSpec = None):
        self.loadAndRemember("PhysicsTools/PatAlgos/slimming/metFilterPaths_cff")
        from PhysicsTools.PatAlgos.slimming.metFilterPaths_cff import allMetFilterPaths
        for filt in allMetFilterPaths:
            self.schedule.append(getattr(self.process,'Flag_'+filt))

    def prepare_L1HwVal(self, stepSpec = 'L1HwVal'):
        ''' Enrich the schedule with L1 HW validation '''
        self.loadDefaultOrSpecifiedCFF(stepSpec,self.L1HwValDefaultCFF)
        print('\n\n\n DEPRECATED this has no action \n\n\n')
        return

    def prepare_L1Reco(self, stepSpec = "L1Reco"):
        ''' Enrich the schedule with L1 reconstruction '''
        _,_l1recoSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.L1RecoDefaultCFF)
        self.scheduleSequence(_l1recoSeq,'L1Reco_step')
        return

    def prepare_L1TrackTrigger(self, stepSpec = "L1TrackTrigger"):
        ''' Enrich the schedule with L1 reconstruction '''
        _,_l1tracktriggerSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.L1TrackTriggerDefaultCFF)
        self.scheduleSequence(_l1tracktriggerSeq,'L1TrackTrigger_step')
        return

    def prepare_FILTER(self, stepSpec = None):
        ''' Enrich the schedule with a user defined filter sequence '''
        
        filterConfig,filterSeq = stepSpec.split('.')
        filterConfig=self.load(filterConfig)
        
        class PrintAllModules(object):
            def __init__(self):
                self.inliner=''
                pass
            def enter(self,visitee):
                try:
                    label=visitee.label()
                    
                    self.inliner=label+','+self.inliner
                except:
                    pass
            def leave(self,v): pass

        expander=PrintAllModules()
        getattr(self.process,filterSeq).visit( expander )
        self._options.inlineObjects+=','+expander.inliner
        self._options.inlineObjects+=','+filterSeq

        
        self.scheduleSequence(filterSeq,'filtering_step')
        self.nextScheduleIsConditional=True
        
        self.productionFilterSequence = filterSeq

        return

    def prepare_RECO(self, stepSpec = "reconstruction"):
        ''' Enrich the schedule with reconstruction '''
        _,_recoSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.RECODefaultCFF)
        self.scheduleSequence(_recoSeq,'reconstruction_step')
        return

    def prepare_RECOSIM(self, stepSpec = "recosim"):
        ''' Enrich the schedule with reconstruction '''
        _,_recosimSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.RECOSIMDefaultCFF)
        self.scheduleSequence(_recosimSeq,'recosim_step')
        return

    def prepare_RECOBEFMIX(self, stepSpec = "reconstruction"):
        ''' Enrich the schedule with the part of reconstruction that is done before mixing in FastSim'''
        if not self._options.fast:
            print("ERROR: this step is only implemented for FastSim")
            sys.exit()
        _,_recobefmixSeq,_ = self.loadDefaultOrSpecifiedCFF(self.RECOBEFMIXDefaultSeq,self.RECOBEFMIXDefaultCFF)
        self.scheduleSequence(_recobefmixSeq,'reconstruction_befmix_step')
        return

    def prepare_PAT(self, stepSpec = "miniAOD"):
        ''' Enrich the schedule with PAT '''
        self.prepare_PATFILTER(self)
        self.loadDefaultOrSpecifiedCFF(stepSpec,self.PATDefaultCFF)
        self.labelsToAssociate.append('patTask')
        if self._options.isData:
            self._options.customisation_file_unsch.insert(0,"PhysicsTools/PatAlgos/slimming/miniAOD_tools.miniAOD_customizeAllData")
        else:
            if self._options.fast:
                self._options.customisation_file_unsch.insert(0,"PhysicsTools/PatAlgos/slimming/miniAOD_tools.miniAOD_customizeAllMCFastSim")
            else:
                self._options.customisation_file_unsch.insert(0,"PhysicsTools/PatAlgos/slimming/miniAOD_tools.miniAOD_customizeAllMC")

        if self._options.hltProcess:
            if len(self._options.customise_commands) > 1:
                self._options.customise_commands = self._options.customise_commands + " \n"
            self._options.customise_commands = self._options.customise_commands + "process.patTrigger.processName = \""+self._options.hltProcess+"\"\n"
            self._options.customise_commands = self._options.customise_commands + "process.slimmedPatTrigger.triggerResults= cms.InputTag( 'TriggerResults::"+self._options.hltProcess+"' )\n"
            self._options.customise_commands = self._options.customise_commands + "process.patMuons.triggerResults= cms.InputTag( 'TriggerResults::"+self._options.hltProcess+"' )\n"

#            self.renameHLTprocessInSequence(sequence)

        return

    def prepare_PATGEN(self, stepSpec = "miniGEN"):
        ''' Enrich the schedule with PATGEN '''
        self.loadDefaultOrSpecifiedCFF(stepSpec,self.PATGENDefaultCFF) #this is unscheduled
        self.labelsToAssociate.append('patGENTask')
        if self._options.isData:
            raise Exception("PATGEN step can only run on MC")
        return

    def prepare_NANO(self, stepSpec = '' ):
        print(f"in prepare_nano {stepSpec}")
        ''' Enrich the schedule with NANO '''
        _,_nanoSeq,_nanoCff = self.loadDefaultOrSpecifiedCFF(stepSpec,self.NANODefaultCFF,self.NANODefaultSeq)
        
        # create full specified sequence using autoNANO 
        from PhysicsTools.NanoAOD.autoNANO import autoNANO, expandNanoMapping
        # if not a autoNANO mapping, load an empty customization, which later will be converted into the default.
        _nanoCustoms = _nanoSeq.split('+') if '@' in stepSpec else [''] 
        _nanoSeq = _nanoSeq.split('+')
        expandNanoMapping(_nanoSeq, autoNANO, 'sequence')
        expandNanoMapping(_nanoCustoms, autoNANO, 'customize')
        # make sure there are no duplicates while preserving the ordering
        _nanoSeq = list(sorted(set(_nanoSeq), key=_nanoSeq.index))
        _nanoCustoms = list(sorted(set(_nanoCustoms), key=_nanoCustoms.index))
        # replace empty sequence with default
        _nanoSeq = [seq if seq!='' else self.NANODefaultSeq for seq in _nanoSeq]    
        _nanoCustoms = [cust if cust!='' else self.NANODefaultCustom for cust in _nanoCustoms]   
        # build and inject the sequence
        if len(_nanoSeq) < 1 and '@' in stepSpec:
            raise Exception(f'The specified mapping: {stepSpec} generates an empty NANO sequence. Please provide a valid mappign')
        _seqToSchedule = []
        for _subSeq in _nanoSeq:
            if '.' in _subSeq:
                _cff,_seq = _subSeq.split('.')
                self.loadAndRemember(_cff)
                _seqToSchedule.append(_seq)
            elif '/' in _subSeq:
                self.loadAndRemember(_subSeq)
                _seqToSchedule.append(self.NANODefaultSeq)
            else:
                _seqToSchedule.append(_subSeq)
        self.scheduleSequence('+'.join(_seqToSchedule), 'nanoAOD_step')
        
        # add the customisations
        for custom in _nanoCustoms:
            custom_path = custom if '.' in custom else '.'.join([_nanoCff,custom]) 
            # customization order can be important for NANO, here later specified customise take precedence
            self._options.customisation_file.append(custom_path)
        if self._options.hltProcess:
            if len(self._options.customise_commands) > 1:
                self._options.customise_commands = self._options.customise_commands + " \n"
            self._options.customise_commands = self._options.customise_commands + "process.unpackedPatTrigger.triggerResults= cms.InputTag( 'TriggerResults::"+self._options.hltProcess+"' )\n"

    def prepare_NANOGEN(self, stepSpec = "nanoAOD"):
        ''' Enrich the schedule with NANOGEN '''
        # TODO: Need to modify this based on the input file type
        fromGen = any([x in self.stepMap for x in ['LHE', 'GEN', 'AOD']])
        _,_nanogenSeq,_nanogenCff = self.loadDefaultOrSpecifiedCFF(stepSpec,self.NANOGENDefaultCFF)
        self.scheduleSequence(_nanogenSeq,'nanoAOD_step')
        custom = "customizeNanoGEN" if fromGen else "customizeNanoGENFromMini"
        if self._options.runUnscheduled:
            self._options.customisation_file_unsch.insert(0, '.'.join([_nanogenCff, custom]))
        else:
            self._options.customisation_file.insert(0, '.'.join([_nanogenCff, custom]))

    def prepare_SKIM(self, stepSpec = "all"):
        ''' Enrich the schedule with skimming fragments'''
        skimConfig,sequence,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.SKIMDefaultCFF)

        stdHLTProcName = 'HLT'
        newHLTProcName = self._options.hltProcess
        customiseForReHLT = (newHLTProcName or (stdHLTProcName in self.stepMap)) and (newHLTProcName != stdHLTProcName)
        if customiseForReHLT:
            print("replacing %s process name - step SKIM:%s will use '%s'" % (stdHLTProcName, sequence, newHLTProcName))

        
        from Configuration.Skimming.autoSkim import autoSkim
        skimlist = sequence.split('+')
        self.expandMapping(skimlist,autoSkim)

        #print("dictionary for skims:", skimConfig.__dict__)
        for skim in skimConfig.__dict__:
            skimstream = getattr(skimConfig, skim)

            # blacklist AlCa paths so that they do not appear in the cfg
            if isinstance(skimstream, cms.Path):
                self.blacklist_paths.append(skimstream)
            # if enabled, apply "hltProcess" renaming to Sequences
            elif isinstance(skimstream, cms.Sequence):
                if customiseForReHLT:
                    self.renameHLTprocessInSequence(skim, proc = newHLTProcName, HLTprocess = stdHLTProcName, verbosityLevel = 0)

            if not isinstance(skimstream, cms.FilteredStream):
                continue

            shortname = skim.replace('SKIMStream','')
            if (sequence=="all"):
                self.addExtraStream(skim,skimstream)
            elif (shortname in skimlist):
                self.addExtraStream(skim,skimstream)
                #add a DQM eventcontent for this guy
                if self._options.datatier=='DQM':
                    self.process.load(self.EVTCONTDefaultCFF)
                    skimstreamDQM = cms.FilteredStream(
                            responsible = skimstream.responsible,
                            name = skimstream.name+'DQM',
                            paths = skimstream.paths,
                            selectEvents = skimstream.selectEvents,
                            content = self._options.datatier+'EventContent',
                            dataTier = cms.untracked.string(self._options.datatier)
                            )
                    self.addExtraStream(skim+'DQM',skimstreamDQM)
                for i in range(skimlist.count(shortname)):
                    skimlist.remove(shortname)

        if (skimlist.__len__()!=0 and sequence!="all"):
            print('WARNING, possible typo with SKIM:'+'+'.join(skimlist))
            raise Exception('WARNING, possible typo with SKIM:'+'+'.join(skimlist))


    def prepare_USER(self, stepSpec = None):
        ''' Enrich the schedule with a user defined sequence '''
        _,_userSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.USERDefaultCFF)
        self.scheduleSequence(_userSeq,'user_step')
        return

    def prepare_POSTRECO(self, stepSpec = None):
        """ Enrich the schedule with the postreco step """
        self.loadAndRemember(self.POSTRECODefaultCFF)
        self.scheduleSequence('postreco_generator','postreco_step')
        return


    def prepare_VALIDATION(self, stepSpec = 'validation'):
        print(f"{stepSpec} in preparing validation")
        _,sequence,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.VALIDATIONDefaultCFF)
        from Validation.Configuration.autoValidation import autoValidation
        #in case VALIDATION:something:somethingelse -> something,somethingelse
        if sequence.find(',')!=-1:
            prevalSeqName=sequence.split(',')[0].split('+')
            valSeqName=sequence.split(',')[1].split('+')
            self.expandMapping(prevalSeqName,autoValidation,index=0)
            self.expandMapping(valSeqName,autoValidation,index=1)
        else:
            if '@' in sequence:
                prevalSeqName=sequence.split('+')
                valSeqName=sequence.split('+')
                self.expandMapping(prevalSeqName,autoValidation,index=0)
                self.expandMapping(valSeqName,autoValidation,index=1)
            else:
                postfix=''
                if sequence:
                    postfix='_'+sequence
                prevalSeqName=['prevalidation'+postfix]
                valSeqName=['validation'+postfix]
                if not hasattr(self.process,valSeqName[0]):
                    prevalSeqName=['']
                    valSeqName=[sequence]

        def NFI(index):
            
            if index==0:
                return ''
            else:
                return '%s'%index


        #rename the HLT process in validation steps
        if ('HLT' in self.stepMap and not self._options.fast) or self._options.hltProcess:
            for s in valSeqName+prevalSeqName:
                if s:
                    self.renameHLTprocessInSequence(s)
        for (i,s) in enumerate(prevalSeqName):
            if s:
                setattr(self.process,'prevalidation_step%s'%NFI(i),  cms.Path( getattr(self.process, s)) )
                self.schedule.append(getattr(self.process,'prevalidation_step%s'%NFI(i)))

        for (i,s) in enumerate(valSeqName):
            setattr(self.process,'validation_step%s'%NFI(i), cms.EndPath( getattr(self.process, s)))
            self.schedule.append(getattr(self.process,'validation_step%s'%NFI(i)))

        #needed in case the miniAODValidation sequence is run starting from AODSIM
        if 'PAT' in self.stepMap and not 'RECO' in self.stepMap:
            return

        if not 'DIGI' in self.stepMap and not self._options.fast and not any(map( lambda s : s.startswith('genvalid'), valSeqName)):
            if self._options.restoreRNDSeeds==False and not self._options.restoreRNDSeeds==True:
                self._options.restoreRNDSeeds=True

        if not 'DIGI' in self.stepMap and not self._options.isData and not self._options.fast:
            self.executeAndRemember("process.mix.playback = True")
            self.executeAndRemember("process.mix.digitizers = cms.PSet()")
            self.executeAndRemember("for a in process.aliases: delattr(process, a)")
            self._options.customisation_file.append("SimGeneral/MixingModule/fullMixCustomize_cff.setCrossingFrameOn")

        if hasattr(self.process,"genstepfilter") and len(self.process.genstepfilter.triggerConditions):
            #will get in the schedule, smoothly
            for (i,s) in enumerate(valSeqName):
                getattr(self.process,'validation_step%s'%NFI(i)).insert(0, self.process.genstepfilter)

        return


    class MassSearchReplaceProcessNameVisitor(object):
        """Visitor that travels within a cms.Sequence, looks for a parameter and replace its value
        It will climb down within PSets, VPSets and VInputTags to find its target"""
        def __init__(self, paramSearch, paramReplace, verbose=False, whitelist=()):
            self._paramReplace = paramReplace
            self._paramSearch = paramSearch
            self._verbose = verbose
            self._whitelist = whitelist

        def doIt(self, pset, base):
            if isinstance(pset, cms._Parameterizable):
                for name in pset.parameters_().keys():
                    # skip whitelisted parameters
                    if name in self._whitelist:
                        continue
                    # if I use pset.parameters_().items() I get copies of the parameter values
                    # so I can't modify the nested pset
                    value = getattr(pset, name)
                    valueType = type(value)
                    if valueType in [cms.PSet, cms.untracked.PSet, cms.EDProducer]:
                        self.doIt(value,base+"."+name)
                    elif valueType in [cms.VPSet, cms.untracked.VPSet]:
                        for (i,ps) in enumerate(value): self.doIt(ps, "%s.%s[%d]"%(base,name,i) )
                    elif valueType in [cms.string, cms.untracked.string]:
                        if value.value() == self._paramSearch:
                            if self._verbose: print("set string process name %s.%s %s ==> %s"% (base, name, value, self._paramReplace))
                            setattr(pset, name,self._paramReplace)
                    elif valueType in [cms.VInputTag, cms.untracked.VInputTag]:
                        for (i,n) in enumerate(value):
                            if not isinstance(n, cms.InputTag):
                                n=cms.InputTag(n)
                            if n.processName == self._paramSearch:
                                # VInputTag can be declared as a list of strings, so ensure that n is formatted correctly
                                if self._verbose:print("set process name %s.%s[%d] %s ==> %s " % (base, name, i, n, self._paramReplace))
                                setattr(n,"processName",self._paramReplace)
                                value[i]=n
                    elif valueType in [cms.vstring, cms.untracked.vstring]:
                        for (i,n) in enumerate(value):
                            if n==self._paramSearch:
                                getattr(pset,name)[i]=self._paramReplace
                    elif valueType in [cms.InputTag, cms.untracked.InputTag]:
                        if value.processName == self._paramSearch:
                            if self._verbose: print("set process name %s.%s %s ==> %s " % (base, name, value, self._paramReplace))
                            setattr(getattr(pset, name),"processName",self._paramReplace)

        def enter(self,visitee):
            label = ''
            try:
                label = visitee.label()
            except AttributeError:
                label = '<Module not in a Process>'
            except:
                label = 'other execption'
            self.doIt(visitee, label)

        def leave(self,visitee):
            pass

    #visit a sequence to repalce all input tags
    def renameInputTagsInSequence(self,sequence,oldT="rawDataCollector",newT="rawDataRepacker"):
        print("Replacing all InputTag %s => %s"%(oldT,newT))
        from PhysicsTools.PatAlgos.tools.helpers import massSearchReplaceAnyInputTag
        massSearchReplaceAnyInputTag(getattr(self.process,sequence),oldT,newT)
        loadMe='from PhysicsTools.PatAlgos.tools.helpers import massSearchReplaceAnyInputTag'
        if not loadMe in self.additionalCommands:
            self.additionalCommands.append(loadMe)
        self.additionalCommands.append('massSearchReplaceAnyInputTag(process.%s,"%s","%s",False,True)'%(sequence,oldT,newT))

    #change the process name used to address HLT results in any sequence
    def renameHLTprocessInSequence(self, sequence, proc=None, HLTprocess='HLT', verbosityLevel=1):
        if proc == None:
            proc = self._options.hltProcess if self._options.hltProcess else self.process.name_()
        if proc == HLTprocess:
            return
        # look up all module in sequence
        if verbosityLevel > 0:
            print("replacing %s process name - sequence %s will use '%s'" % (HLTprocess, sequence, proc))
        verboseVisit = (verbosityLevel > 1)
        getattr(self.process,sequence).visit(
            ConfigBuilder.MassSearchReplaceProcessNameVisitor(HLTprocess, proc, whitelist = ("subSystemFolder",), verbose = verboseVisit))
        if 'from Configuration.Applications.ConfigBuilder import ConfigBuilder' not in self.additionalCommands:
            self.additionalCommands.append('from Configuration.Applications.ConfigBuilder import ConfigBuilder')
        self.additionalCommands.append(
            'process.%s.visit(ConfigBuilder.MassSearchReplaceProcessNameVisitor("%s", "%s", whitelist = ("subSystemFolder",), verbose = %s))'
            % (sequence, HLTprocess, proc, verboseVisit))

    def expandMapping(self,seqList,mapping,index=None):
        maxLevel=30
        level=0
        while '@' in repr(seqList) and level<maxLevel:
            level+=1
            for specifiedCommand in seqList:
                if specifiedCommand.startswith('@'):
                    location=specifiedCommand[1:]
                    if not location in mapping:
                        raise Exception("Impossible to map "+location+" from "+repr(mapping))
                    mappedTo=mapping[location]
                    if index!=None:
                        mappedTo=mappedTo[index]
                    seqList.remove(specifiedCommand)
                    seqList.extend(mappedTo.split('+'))
                    break;
        if level==maxLevel:
            raise Exception("Could not fully expand "+repr(seqList)+" from "+repr(mapping))

    def prepare_DQM(self, stepSpec = 'DQMOffline'):
        # this one needs replacement

        # any 'DQM' job should use DQMStore in non-legacy mode (but not HARVESTING)
        self.loadAndRemember("DQMServices/Core/DQMStoreNonLegacy_cff")
        _,_dqmSeq,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.DQMOFFLINEDefaultCFF)
        sequenceList=_dqmSeq.split('+')
        postSequenceList=_dqmSeq.split('+')
        from DQMOffline.Configuration.autoDQM import autoDQM
        self.expandMapping(sequenceList,autoDQM,index=0)
        self.expandMapping(postSequenceList,autoDQM,index=1)

        if len(set(sequenceList))!=len(sequenceList):
            sequenceList=list(OrderedSet(sequenceList))
            print("Duplicate entries for DQM:, using",sequenceList)

        pathName='dqmoffline_step'
        for (i,_sequence) in enumerate(sequenceList):
            if (i!=0):
                pathName='dqmoffline_%d_step'%(i)

            if 'HLT' in self.stepMap.keys() or self._options.hltProcess:
                self.renameHLTprocessInSequence(_sequence)

            setattr(self.process,pathName, cms.EndPath( getattr(self.process,_sequence ) ) )
            self.schedule.append(getattr(self.process,pathName))

            if hasattr(self.process,"genstepfilter") and len(self.process.genstepfilter.triggerConditions):
                #will get in the schedule, smoothly
                getattr(self.process,pathName).insert(0,self.process.genstepfilter)


        pathName='dqmofflineOnPAT_step'
        for (i,_sequence) in enumerate(postSequenceList):
            #Fix needed to avoid duplication of sequences not defined in autoDQM or without a PostDQM
            if (sequenceList[i]==postSequenceList[i]):
                      continue
            if (i!=0):
                pathName='dqmofflineOnPAT_%d_step'%(i)

            setattr(self.process,pathName, cms.EndPath( getattr(self.process, _sequence ) ) )
            self.schedule.append(getattr(self.process,pathName))

    def prepare_HARVESTING(self, stepSpec = None):
        """ Enrich the process with harvesting step """
        self.DQMSaverCFF='Configuration/StandardSequences/DQMSaver'+self._options.harvesting+'_cff'
        self.loadAndRemember(self.DQMSaverCFF)

        harvestingConfig,sequence,_ = self.loadDefaultOrSpecifiedCFF(stepSpec,self.HARVESTINGDefaultCFF)

        # decide which HARVESTING paths to use
        harvestingList = sequence.split("+")
        from DQMOffline.Configuration.autoDQM import autoDQM
        from Validation.Configuration.autoValidation import autoValidation
        import copy
        combined_mapping = copy.deepcopy( autoDQM )
        combined_mapping.update( autoValidation )
        self.expandMapping(harvestingList,combined_mapping,index=-1)

        if len(set(harvestingList))!=len(harvestingList):
            harvestingList=list(OrderedSet(harvestingList))
            print("Duplicate entries for HARVESTING, using",harvestingList)

        for name in harvestingList:
            if not name in harvestingConfig.__dict__:
                print(name,"is not a possible harvesting type. Available are",harvestingConfig.__dict__.keys())
                # trigger hard error, like for other sequence types
                getattr(self.process, name)
                continue
            harvestingstream = getattr(harvestingConfig,name)
            if isinstance(harvestingstream,cms.Path):
                self.schedule.append(harvestingstream)
                self.blacklist_paths.append(harvestingstream)
            if isinstance(harvestingstream,cms.Sequence):
                setattr(self.process,name+"_step",cms.Path(harvestingstream))
                self.schedule.append(getattr(self.process,name+"_step"))

        # # NOTE: the "hltProcess" option currently does nothing in the HARVEST step
        # if self._options.hltProcess or ('HLT' in self.stepMap):
        #     pass

        self.scheduleSequence('DQMSaver','dqmsave_step')
        return

    def prepare_ALCAHARVEST(self, stepSpec = None):
        """ Enrich the process with AlCaHarvesting step """
        harvestingConfig = self.loadAndRemember(self.ALCAHARVESTDefaultCFF)
        sequence=stepSpec.split(".")[-1]

        # decide which AlcaHARVESTING paths to use
        harvestingList = sequence.split("+")



        from Configuration.AlCa.autoPCL import autoPCL
        self.expandMapping(harvestingList,autoPCL)

        for name in harvestingConfig.__dict__:
            harvestingstream = getattr(harvestingConfig,name)
            if name in harvestingList and isinstance(harvestingstream,cms.Path):
                self.schedule.append(harvestingstream)
                if isinstance(getattr(harvestingConfig,"ALCAHARVEST" + name + "_dbOutput"), cms.VPSet) and \
                   isinstance(getattr(harvestingConfig,"ALCAHARVEST" + name + "_metadata"), cms.VPSet):
                    self.executeAndRemember("process.PoolDBOutputService.toPut.extend(process.ALCAHARVEST" + name + "_dbOutput)")
                    self.executeAndRemember("process.pclMetadataWriter.recordsToMap.extend(process.ALCAHARVEST" + name + "_metadata)")
                else:
                    self.executeAndRemember("process.PoolDBOutputService.toPut.append(process.ALCAHARVEST" + name + "_dbOutput)")
                    self.executeAndRemember("process.pclMetadataWriter.recordsToMap.append(process.ALCAHARVEST" + name + "_metadata)")
                harvestingList.remove(name)
        # append the common part at the end of the sequence
        lastStep = getattr(harvestingConfig,"ALCAHARVESTDQMSaveAndMetadataWriter")
        self.schedule.append(lastStep)

        if len(harvestingList) != 0 and 'dummyHarvesting' not in harvestingList :
            print("The following harvesting could not be found : ", harvestingList)
            raise Exception("The following harvesting could not be found : "+str(harvestingList))



    def prepare_ENDJOB(self, stepSpec = 'endOfProcess'):
        _,_endjobSeq,_=self.loadDefaultOrSpecifiedCFF(stepSpec,self.ENDJOBDefaultCFF)
        self.scheduleSequenceAtEnd(_endjobSeq,'endjob_step')
        return

    def finalizeFastSimHLT(self):
        self.process.reconstruction = cms.Path(self.process.reconstructionWithFamos)
        self.schedule.append(self.process.reconstruction)


    def build_production_info(self, evt_type, evtnumber):
        """ Add useful info for the production. """
        self.process.configurationMetadata=cms.untracked.PSet\
                                            (version=cms.untracked.string("$Revision: 1.19 $"),
                                             name=cms.untracked.string("Applications"),
                                             annotation=cms.untracked.string(evt_type+ " nevts:"+str(evtnumber))
                                             )

        self.addedObjects.append(("Production Info","configurationMetadata"))


    def create_process(self):
        self.pythonCfgCode =  "# Auto generated configuration file\n"
        self.pythonCfgCode += "# using: \n# "+__version__[1:-1]+"\n# "+__source__[1:-1]+'\n'
        self.pythonCfgCode += "# with command line options: "+self._options.arguments+'\n'
        self.pythonCfgCode += "import FWCore.ParameterSet.Config as cms\n\n"

        # now set up the modifies
        modifiers=[]
        modifierStrings=[]
        modifierImports=[]

        if hasattr(self._options,"era") and self._options.era :
        # Multiple eras can be specified in a comma seperated list
            from Configuration.StandardSequences.Eras import eras
            for requestedEra in self._options.era.split(",") :
                modifierStrings.append(requestedEra)
                modifierImports.append(eras.pythonCfgLines[requestedEra])
                modifiers.append(getattr(eras,requestedEra))


        if hasattr(self._options,"procModifiers") and self._options.procModifiers:
            import importlib
            thingsImported=[]
            for c in self._options.procModifiers:
                thingsImported.extend(c.split(","))
            for pm in thingsImported:
                modifierStrings.append(pm)
                modifierImports.append('from Configuration.ProcessModifiers.'+pm+'_cff import '+pm)
                modifiers.append(getattr(importlib.import_module('Configuration.ProcessModifiers.'+pm+'_cff'),pm))

        self.pythonCfgCode += '\n'.join(modifierImports)+'\n\n'
        self.pythonCfgCode += "process = cms.Process('"+self._options.name+"'" # Start of the line, finished after the loop


        if len(modifierStrings)>0:
            self.pythonCfgCode+= ','+','.join(modifierStrings)
        self.pythonCfgCode+=')\n\n'

        #yes, the cfg code gets out of sync here if a process is passed in. That could be fixed in the future
        #assuming there is some way for the fwk to get the list of modifiers (and their stringified name)
        if self.process == None:
            if len(modifiers)>0:
                self.process = cms.Process(self._options.name,*modifiers)
            else:
                self.process = cms.Process(self._options.name)




    def prepare(self, doChecking = False):
        """ Prepare the configuration string and add missing pieces."""

        self.loadAndRemember(self.EVTCONTDefaultCFF)  #load the event contents regardless
        self.addMaxEvents()
        if self.with_input:
            self.addSource()
        self.addStandardSequences()
        
        self.completeInputCommand()
        self.addConditions()


        outputModuleCfgCode=""
        if not 'HARVESTING' in self.stepMap.keys() and not 'ALCAHARVEST' in self.stepMap.keys() and not 'ALCAOUTPUT' in self.stepMap.keys() and self.with_output:
            outputModuleCfgCode=self.addOutput()

        self.addCommon()

        self.pythonCfgCode += "# import of standard configurations\n"
        for module in self.imports:
            self.pythonCfgCode += ("process.load('"+module+"')\n")

        # production info
        if not hasattr(self.process,"configurationMetadata"):
            self.build_production_info(self._options.evt_type, self._options.number)
        else:
            #the PSet was added via a load
            self.addedObjects.append(("Production Info","configurationMetadata"))

        self.pythonCfgCode +="\n"
        for comment,object in self.addedObjects:
            if comment!="":
                self.pythonCfgCode += "\n# "+comment+"\n"
            self.pythonCfgCode += dumpPython(self.process,object)

        # dump the output definition
        self.pythonCfgCode += "\n# Output definition\n"
        self.pythonCfgCode += outputModuleCfgCode

        # dump all additional outputs (e.g. alca or skim streams)
        self.pythonCfgCode += "\n# Additional output definition\n"
        #I do not understand why the keys are not normally ordered.
        nl=sorted(self.additionalOutputs.keys())
        for name in nl:
            output = self.additionalOutputs[name]
            self.pythonCfgCode += "process.%s = %s" %(name, output.dumpPython())
            tmpOut = cms.EndPath(output)
            setattr(self.process,name+'OutPath',tmpOut)
            self.schedule.append(tmpOut)

        # dump all additional commands
        self.pythonCfgCode += "\n# Other statements\n"
        for command in self.additionalCommands:
            self.pythonCfgCode += command + "\n"

        #comma separated list of objects that deserve to be inlined in the configuration (typically from a modified config deep down)
        for object in self._options.inlineObjects.split(','):
            if not object:
                continue
            if not hasattr(self.process,object):
                print('cannot inline -'+object+'- : not known')
            else:
                self.pythonCfgCode +='\n'
                self.pythonCfgCode +=dumpPython(self.process,object)

        if self._options.pileup=='HiMixEmbGEN':
            self.pythonCfgCode += "\nprocess.generator.embeddingMode=cms.int32(1)\n"

        # dump all paths
        self.pythonCfgCode += "\n# Path and EndPath definitions\n"
        for path in self.process.paths:
            if getattr(self.process,path) not in self.blacklist_paths:
                self.pythonCfgCode += dumpPython(self.process,path)

        for endpath in self.process.endpaths:
            if getattr(self.process,endpath) not in self.blacklist_paths:
                self.pythonCfgCode += dumpPython(self.process,endpath)

        # dump the schedule
        self.pythonCfgCode += "\n# Schedule definition\n"

        # handling of the schedule
        pathNames = ['process.'+p.label_() for p in self.schedule]
        if self.process.schedule == None:
            self.process.schedule = cms.Schedule()
            for item in self.schedule:
                self.process.schedule.append(item)
            result = 'process.schedule = cms.Schedule('+','.join(pathNames)+')\n'
        else:
            if not isinstance(self.scheduleIndexOfFirstHLTPath, int):
                raise Exception('the schedule was imported from a cff in HLTrigger.Configuration, but the final index of the first HLT path is undefined')

            for index, item in enumerate(self.schedule):
                if index < self.scheduleIndexOfFirstHLTPath:
                    self.process.schedule.insert(index, item)
                else:
                    self.process.schedule.append(item)

            result = "# process.schedule imported from cff in HLTrigger.Configuration\n"
            for index, item in enumerate(pathNames[:self.scheduleIndexOfFirstHLTPath]):
                result += 'process.schedule.insert('+str(index)+', '+item+')\n'
            if self.scheduleIndexOfFirstHLTPath < len(pathNames):
                result += 'process.schedule.extend(['+','.join(pathNames[self.scheduleIndexOfFirstHLTPath:])+'])\n'

        self.pythonCfgCode += result

        for labelToAssociate in self.labelsToAssociate:
            self.process.schedule.associate(getattr(self.process, labelToAssociate))
            self.pythonCfgCode += 'process.schedule.associate(process.' + labelToAssociate + ')\n'

        from PhysicsTools.PatAlgos.tools.helpers import associatePatAlgosToolsTask
        associatePatAlgosToolsTask(self.process)
        self.pythonCfgCode+="from PhysicsTools.PatAlgos.tools.helpers import associatePatAlgosToolsTask\n"
        self.pythonCfgCode+="associatePatAlgosToolsTask(process)\n"

        overrideThreads = (self._options.nThreads != 1)
        overrideConcurrentLumis = (self._options.nConcurrentLumis != defaultOptions.nConcurrentLumis)
        overrideConcurrentIOVs = (self._options.nConcurrentIOVs != defaultOptions.nConcurrentIOVs)

        if overrideThreads or overrideConcurrentLumis or overrideConcurrentIOVs:
            self.pythonCfgCode +="\n"
            self.pythonCfgCode +="#Setup FWK for multithreaded\n"
            if overrideThreads:
                self.pythonCfgCode +="process.options.numberOfThreads = {}\n".format(self._options.nThreads)
                self.pythonCfgCode +="process.options.numberOfStreams = {}\n".format(self._options.nStreams)
                self.process.options.numberOfThreads = self._options.nThreads
                self.process.options.numberOfStreams = self._options.nStreams
            if overrideConcurrentLumis:
                self.pythonCfgCode +="process.options.numberOfConcurrentLuminosityBlocks = {}\n".format(self._options.nConcurrentLumis)
                self.process.options.numberOfConcurrentLuminosityBlocks = self._options.nConcurrentLumis
            if overrideConcurrentIOVs:
                self.pythonCfgCode +="process.options.eventSetup.numberOfConcurrentIOVs = {}\n".format(self._options.nConcurrentIOVs)
                self.process.options.eventSetup.numberOfConcurrentIOVs = self._options.nConcurrentIOVs

        if self._options.accelerators is not None:
            accelerators = self._options.accelerators.split(',')
            self.pythonCfgCode += "\n"
            self.pythonCfgCode += "# Enable only these accelerator backends\n"
            self.pythonCfgCode += "process.load('Configuration.StandardSequences.Accelerators_cff')\n"
            self.pythonCfgCode += "process.options.accelerators = ['" + "', '".join(accelerators) + "']\n"
            self.process.load('Configuration.StandardSequences.Accelerators_cff')
            self.process.options.accelerators = accelerators

        #repacked version
        if self._options.isRepacked:
            self.pythonCfgCode +="\n"
            self.pythonCfgCode +="from Configuration.Applications.ConfigBuilder import MassReplaceInputTag\n"
            self.pythonCfgCode +="MassReplaceInputTag(process, new=\"rawDataMapperByLabel\", old=\"rawDataCollector\")\n"
            MassReplaceInputTag(self.process, new="rawDataMapperByLabel", old="rawDataCollector")

        # special treatment in case of production filter sequence 2/2
        if self.productionFilterSequence and not (self._options.pileup=='HiMixEmbGEN'):
            self.pythonCfgCode +='# filter all path with the production filter sequence\n'
            self.pythonCfgCode +='for path in process.paths:\n'
            if len(self.conditionalPaths):
                self.pythonCfgCode +='\tif not path in %s: continue\n'%str(self.conditionalPaths)
            if len(self.excludedPaths):
                self.pythonCfgCode +='\tif path in %s: continue\n'%str(self.excludedPaths)
            self.pythonCfgCode +='\tgetattr(process,path).insert(0, process.%s)\n'%(self.productionFilterSequence,)
            pfs = getattr(self.process,self.productionFilterSequence)
            for path in self.process.paths:
                if not path in self.conditionalPaths: continue
                if path in self.excludedPaths: continue
                getattr(self.process,path).insert(0, pfs)


        # dump customise fragment
        self.pythonCfgCode += self.addCustomise()

        if self._options.runUnscheduled:
            print("--runUnscheduled is deprecated and not necessary anymore, and will be removed soon. Please update your command line.")
        # Keep the "unscheduled customise functions" separate for now,
        # there are customize functions given by users (in our unit
        # tests) that need to be run before the "unscheduled customise
        # functions"
        self.pythonCfgCode += self.addCustomise(1)

        self.pythonCfgCode += self.addCustomiseCmdLine()

        if hasattr(self.process,"logErrorHarvester"):
            #configure logErrorHarvester to wait for same EDProducers to finish as the OutputModules
            self.pythonCfgCode +="\n#Have logErrorHarvester wait for the same EDProducers to finish as those providing data for the OutputModule\n"
            self.pythonCfgCode +="from FWCore.Modules.logErrorHarvester_cff import customiseLogErrorHarvesterUsingOutputCommands\n"
            self.pythonCfgCode +="process = customiseLogErrorHarvesterUsingOutputCommands(process)\n"
            from FWCore.Modules.logErrorHarvester_cff import customiseLogErrorHarvesterUsingOutputCommands
            self.process = customiseLogErrorHarvesterUsingOutputCommands(self.process)

        # Temporary hack to put the early delete customization after
        # everything else
        #
        # FIXME: remove when no longer needed
        self.pythonCfgCode += "\n# Add early deletion of temporary data products to reduce peak memory need\n"
        self.pythonCfgCode += "from Configuration.StandardSequences.earlyDeleteSettings_cff import customiseEarlyDelete\n"
        self.pythonCfgCode += "process = customiseEarlyDelete(process)\n"
        self.pythonCfgCode += "# End adding early deletion\n"
        from Configuration.StandardSequences.earlyDeleteSettings_cff import customiseEarlyDelete
        self.process = customiseEarlyDelete(self.process)

        imports = cms.specialImportRegistry.getSpecialImports()
        if len(imports) > 0:
            #need to inject this at the top
            index = self.pythonCfgCode.find("import FWCore.ParameterSet.Config")
            #now find the end of line
            index = self.pythonCfgCode.find("\n",index)
            self.pythonCfgCode = self.pythonCfgCode[:index]+ "\n" + "\n".join(imports)+"\n" +self.pythonCfgCode[index:]


        # make the .io file

        if self._options.io:
            #io=open(self._options.python_filename.replace('.py','.io'),'w')
            if not self._options.io.endswith('.io'): self._option.io+='.io'
            io=open(self._options.io,'w')
            ioJson={}
            if hasattr(self.process.source,"fileNames"):
                if len(self.process.source.fileNames.value()):
                    ioJson['primary']=self.process.source.fileNames.value()
            if hasattr(self.process.source,"secondaryFileNames"):
                if len(self.process.source.secondaryFileNames.value()):
                    ioJson['secondary']=self.process.source.secondaryFileNames.value()
            if self._options.pileup_input and (self._options.pileup_input.startswith('dbs:') or self._options.pileup_input.startswith('das:')):
                ioJson['pileup']=self._options.pileup_input[4:]
            for (o,om) in self.process.outputModules_().items():
                ioJson[o]=om.fileName.value()
            ioJson['GT']=self.process.GlobalTag.globaltag.value()
            if self.productionFilterSequence:
                ioJson['filter']=self.productionFilterSequence
            import json
            io.write(json.dumps(ioJson))
        return

---

Generated for CMSSW Reference Manual by  1.8.14