lsst.ctrl.pool  20.0.0+12
Public Member Functions | List of all members
lsst.ctrl.pool.parallel.BatchPoolTask Class Reference
Inheritance diagram for lsst.ctrl.pool.parallel.BatchPoolTask:
lsst.ctrl.pool.parallel.BatchCmdLineTask lsst.ctrl.pool.test.demoTask.DemoTask

Public Member Functions

def parseAndRun (cls, *args, **kwargs)
 
def parseAndSubmit (cls, args=None, **kwargs)
 
def batchWallTime (cls, time, parsedCmd, numCores)
 Return walltime request for batch job. More...
 
def batchCommand (cls, args)
 Return command to run CmdLineTask. More...
 
def logOperation (self, operation, catch=False, trace=True)
 Provide a context manager for logging an operation. More...
 

Detailed Description

Starts a BatchCmdLineTask with an MPI process pool

Use this subclass of BatchCmdLineTask if you want to use the Pool directly.

Definition at line 527 of file parallel.py.

Member Function Documentation

◆ batchCommand()

def lsst.ctrl.pool.parallel.BatchCmdLineTask.batchCommand (   cls,
  args 
)
inherited

Return command to run CmdLineTask.

Parameters
clsClass
argsParsed batch job arguments (from BatchArgumentParser)

Definition at line 476 of file parallel.py.

◆ batchWallTime()

def lsst.ctrl.pool.parallel.BatchCmdLineTask.batchWallTime (   cls,
  time,
  parsedCmd,
  numCores 
)
inherited

Return walltime request for batch job.

Subclasses should override if the walltime should be calculated differently (e.g., addition of some serial time).

Parameters
clsClass
timeRequested time per iteration
parsedCmdResults of argument parsing
numCoresNumber of cores

Reimplemented in lsst.ctrl.pool.test.demoTask.DemoTask.

Definition at line 461 of file parallel.py.

◆ logOperation()

def lsst.ctrl.pool.parallel.BatchCmdLineTask.logOperation (   self,
  operation,
  catch = False,
  trace = True 
)
inherited

Provide a context manager for logging an operation.

Parameters
operationdescription of operation (string)
catchCatch all exceptions?
traceLog a traceback of caught exception?

Note that if 'catch' is True, all exceptions are swallowed, but there may be other side-effects such as undefined variables.

Definition at line 502 of file parallel.py.

◆ parseAndRun()

def lsst.ctrl.pool.parallel.BatchPoolTask.parseAndRun (   cls,
args,
**  kwargs 
)
Run with a MPI process pool

Definition at line 534 of file parallel.py.

◆ parseAndSubmit()

def lsst.ctrl.pool.parallel.BatchCmdLineTask.parseAndSubmit (   cls,
  args = None,
**  kwargs 
)
inherited

Definition at line 435 of file parallel.py.


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