python.EventLoopCPRunScript.EventLoopCPRunScript Class Reference

Inheritance diagram for python.EventLoopCPRunScript.EventLoopCPRunScript:

Collaboration diagram for python.EventLoopCPRunScript.EventLoopCPRunScript:

Public Member Functions
def	__init__ (self)
def	addCustomArguments (self)
def	makeAlgSequence (self)
def	readSamples (self)
def	stripPath (self)
def	driverSubmit (self, driver)
def	run (self)

Public Attributes
	sampleHandler
	job

Detailed Description

Definition at line 5 of file EventLoopCPRunScript.py.

Constructor & Destructor Documentation

__init__()

def python.EventLoopCPRunScript.EventLoopCPRunScript.__init__

(

self

)

Definition at line 6 of file EventLoopCPRunScript.py.

    def __init__(self):
        super().__init__()
        self.logger.info("EventLoopCPRunScript initialized")
        self.addCustomArguments()
        # Avoid putting call to parse_args() here! Otherwise it is hard to retrieve the parser infos
 

Member Function Documentation

addCustomArguments()

def python.EventLoopCPRunScript.EventLoopCPRunScript.addCustomArguments

(

self

)

Definition at line 12 of file EventLoopCPRunScript.py.

    def addCustomArguments(self):
        # add arguments here
        derivedGroup = self.parser.add_argument_group('EventLoop specific arguments')
        derivedGroup.add_argument('--direct-driver', dest='direct_driver',
                                 action='store_true', help='Run the job with the direct driver')
        derivedGroup.add_argument('--strip', dest='strip', action='store_true', help='Move the analysis root file to the top level, and delete the work directory.'
                                  ' Mainly useful for standardizing the output with the Athena framework.')
        derivedGroup.add_argument('--work-dir', dest='work_dir', default='workDir', help='The work directory for the EL job')
        return
        

driverSubmit()

def python.EventLoopCPRunScript.EventLoopCPRunScript.driverSubmit	(		self,
			driver
	)

Important if you want to run code after submitting the job, with external driver e.g., ExecDriver.
Assistant function to call driver submit. Move the submission to a child process to avoid the main process being terminated.
Directly calling external driver submission will not return controls to the main process, the main thread will be terminated.

Definition at line 55 of file EventLoopCPRunScript.py.

    def driverSubmit(self, driver):
        '''
        Important if you want to run code after submitting the job, with external driver e.g., ExecDriver.
        Assistant function to call driver submit. Move the submission to a child process to avoid the main process being terminated.
        Directly calling external driver submission will not return controls to the main process, the main thread will be terminated.
        '''
        import os
        if (pid := os.fork()) == 0: # child process
            driver.submit(self.job, self.args.work_dir)
            exit(0)
        else:
            os.waitpid(pid, 0) # parent waits for child process to finish
            return
    

makeAlgSequence()

def python.EventLoopCPRunScript.EventLoopCPRunScript.makeAlgSequence

(

self

)

Definition at line 22 of file EventLoopCPRunScript.py.

    def makeAlgSequence(self):
        from AnaAlgorithm.AlgSequence import AlgSequence
        algSeq = AlgSequence()
        self.logger.info("Configuring algorithms based on YAML file")
        configSeq =  self.config.configure()
        self.logger.info("Configuring common services")
        configAccumulator = ConfigAccumulator(autoconfigFromFlags=self.flags,
                                              algSeq=algSeq,
                                              noSystematics=self.args.no_systematics)
        self.logger.info("Configuring algorithms")
        configSeq.fullConfigure(configAccumulator)
        return algSeq
    

readSamples()

def python.EventLoopCPRunScript.EventLoopCPRunScript.readSamples

(

self

)

Definition at line 35 of file EventLoopCPRunScript.py.

    def readSamples(self):
        import ROOT
        self.sampleHandler = ROOT.SH.SampleHandler()
        sampleFiles = ROOT.SH.SampleLocal(f"{self.args.output_name}")
        self.logger.info("Adding files to the sample handler")
        for file in self.inputList:
            sampleFiles.add(file)
        self.sampleHandler.add(sampleFiles)
        

run()

def python.EventLoopCPRunScript.EventLoopCPRunScript.run

(

self

)

Definition at line 69 of file EventLoopCPRunScript.py.

    def run(self):
        self.setup()
        # importing ROOT has a long upfront time, so we do it here
        import ROOT
        ROOT.xAOD.Init().ignore()
        self.readSamples()
        self.flags.lock()
        self.printFlags()
        
        self.job = ROOT.EL.Job()
        self.job.sampleHandler(self.sampleHandler)
        self.job.options().setDouble(ROOT.EL.Job.optMaxEvents, self.flags.Exec.MaxEvents)
        self.job.options().setString(ROOT.EL.Job.optSubmitDirMode, 'unique-link')
        for alg in self.makeAlgSequence():
            self.job.algsAdd(alg)
        self.job.outputAdd(ROOT.EL.OutputStream('ANALYSIS'))
        
        driver = ROOT.EL.DirectDriver() if self.args.direct_driver else ROOT.EL.ExecDriver()
        self.driverSubmit(driver)
        if self.args.strip: self.stripPath()

stripPath()

def python.EventLoopCPRunScript.EventLoopCPRunScript.stripPath

(

self

)

Definition at line 44 of file EventLoopCPRunScript.py.

    def stripPath(self):
        import os
        import shutil
        self.logger.info("Moving the analysis root file to the top level, and deleting the work directory. (--strip option)")
        workDir = os.path.realpath(self.args.work_dir)
        rootfilePath = os.path.realpath(os.path.join(workDir, 'data-ANALYSIS', f'{self.args.output_name}.root'))
        currentDir = os.getcwd()
        shutil.move(rootfilePath, os.path.join(currentDir, f"{self.args.output_name}.root"))
        shutil.rmtree(workDir)
        os.remove(os.path.join(currentDir, self.args.work_dir))
    

Member Data Documentation

job

python.EventLoopCPRunScript.EventLoopCPRunScript.job

Definition at line 78 of file EventLoopCPRunScript.py.

sampleHandler

python.EventLoopCPRunScript.EventLoopCPRunScript.sampleHandler

Definition at line 37 of file EventLoopCPRunScript.py.

---

The documentation for this class was generated from the following file:

• EventLoopCPRunScript.py