lsst.ctrl.pool  20.0.0+5c2e9f43b2
Public Member Functions | Static Public Attributes | List of all members
lsst.ctrl.pool.parallel.BatchParallelTask Class Reference
Inheritance diagram for lsst.ctrl.pool.parallel.BatchParallelTask:
lsst.ctrl.pool.parallel.BatchCmdLineTask

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...
 

Static Public Attributes

 RunnerClass = BatchTaskRunner
 

Detailed Description

Runs the BatchCmdLineTask in parallel

Use this subclass of BatchCmdLineTask if you don't need to use the Pool
directly, but just want to iterate over many objects (like a multi-node
version of the '-j' command-line argument).

Definition at line 595 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.BatchParallelTask.parseAndRun (   cls,
args,
**  kwargs 
)
Parse an argument list and run the command

This is the entry point when we run in earnest, so start the process pool
so that the worker nodes don't go any further.

Definition at line 615 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.

Member Data Documentation

◆ RunnerClass

lsst.ctrl.pool.parallel.BatchParallelTask.RunnerClass = BatchTaskRunner
static

Definition at line 602 of file parallel.py.


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