lsst.ctrl.pool  13.0-6-gf96f8ec+28
 All Classes Namespaces Files Functions Variables Pages
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
 
def run
 
def read
 
def parseAndRun
 
def parseAndSubmit
 
def batchCommand
 Return command to run CmdLineTask. More...
 
def logOperation
 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

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

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

def lsst.ctrl.pool.test.demoTask.DemoTask.read (   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.

def lsst.ctrl.pool.test.demoTask.DemoTask.run (   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

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: