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

Public Member Functions

def batchWallTime (cls, time, parsedCmd, numCores)
 
def runDataRef (self, visitRef)
 
def run (self, cache, dataId, butler=None)
 
def parseAndRun (cls, *args, **kwargs)
 
def parseAndSubmit (cls, args=None, **kwargs)
 
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

 ConfigClass = Config
 

Detailed Description

Task for demonstrating the BatchPoolTask functionality

Definition at line 12 of file demoTask.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.test.demoTask.DemoTask.batchWallTime (   cls,
  time,
  parsedCmd,
  numCores 
)
Return walltime request for batch job

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

@param time: Requested time per iteration
@param parsedCmd: Results of argument parsing
@param numCores: Number of cores

Reimplemented from lsst.ctrl.pool.parallel.BatchCmdLineTask.

Definition at line 26 of file demoTask.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 
)
inherited
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.

◆ run()

def lsst.ctrl.pool.test.demoTask.DemoTask.run (   self,
  cache,
  dataId,
  butler = None 
)
Read image and return number of pixels

Only the slave nodes run this method.

Definition at line 58 of file demoTask.py.

◆ runDataRef()

def lsst.ctrl.pool.test.demoTask.DemoTask.runDataRef (   self,
  visitRef 
)
Main entry-point

Only the master node runs this method.  It will dispatch jobs to the
slave nodes.

Definition at line 40 of file demoTask.py.

Member Data Documentation

◆ ConfigClass

lsst.ctrl.pool.test.demoTask.DemoTask.ConfigClass = Config
static

Definition at line 14 of file demoTask.py.


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