lsst.ctrl.pool  13.0-6-gf96f8ec+31
 All Classes Namespaces Files Functions Variables Pages
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
 
def parseAndSubmit
 
def batchWallTime
 Return walltime request for batch job. More...
 
def batchCommand
 Return command to run CmdLineTask. More...
 
def logOperation
 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 509 of file parallel.py.

Member Function Documentation

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

Return command to run CmdLineTask.

Parameters
cls,:Class
args,:Parsed batch job arguments (from BatchArgumentParser)

Definition at line 458 of file parallel.py.

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
cls,:Class
time,:Requested time per iteration
parsedCmd,:Results of argument parsing
numCores,:Number of cores

Definition at line 443 of file parallel.py.

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

Provide a context manager for logging an operation.

Parameters
operation,:description of operation (string)
catch,:Catch all exceptions?
trace,:Log 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 484 of file parallel.py.

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

Definition at line 516 of file parallel.py.

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

Definition at line 420 of file parallel.py.


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