lsst.ctrl.pool.parallel.Batch Class Reference

Inheritance diagram for lsst.ctrl.pool.parallel.Batch:

Public Member Functions
def	__init__ (self, outputDir=None, numNodes=0, numProcsPerNode=0, numCores=0, queue=None, jobName=None, walltime=0.0, dryrun=False, doExec=False, mpiexec="", submit=None, options=None, verbose=False)
	Constructor. More...
def	shebang (self)
def	preamble (self, command, walltime=None)
def	execution (self, command)
def	createScript (self, command, walltime=None)
	Create script to be submitted. More...
def	submitCommand (self, scriptName)
	Return command to submit script. More...
def	run (self, command, walltime=None)
	Run the batch system. More...

Public Attributes
	outputDir
	numNodes
	numProcsPerNode
	numCores
	queue
	jobName
	walltime
	dryrun
	doExec
	mpiexec
	submit
	options
	verbose

Detailed Description

Base class for batch submission

Definition at line 68 of file parallel.py.

Constructor & Destructor Documentation

__init__()

def lsst.ctrl.pool.parallel.Batch.__init__	(		self,
			outputDir = None,
			numNodes = 0,
			numProcsPerNode = 0,
			numCores = 0,
			queue = None,
			jobName = None,
			walltime = 0.0,
			dryrun = False,
			doExec = False,
			mpiexec = "",
			submit = None,
			options = None,
			verbose = False
	)

Constructor.

Parameters

outputDir	output directory, or None
numNodes	number of nodes
numProcsPerNode	number of processors per node
numCores	number of cores (Slurm, SMP only)
queue	name of queue, or None
jobName	name of job, or None
walltime	maximum wall clock time for job
dryrun	Dry run (only print actions that would be taken)?
doExec	exec the script instead of submitting to batch system?
mpiexec	options for mpiexec
submit	command-line options for batch submission (e.g., for qsub, sbatch)
options	options to append to script header (e.g., #PBS or #SBATCH)
verbose	produce verbose output?

Definition at line 73 of file parallel.py.

Member Function Documentation

createScript()

def lsst.ctrl.pool.parallel.Batch.createScript	(		self,
			command,
			walltime = None
	)

Create script to be submitted.

Parameters

command	command to run
walltime	maximum wall clock time, overrides value to constructor

Returns

name of script on filesystem

Definition at line 138 of file parallel.py.

execution()

def lsst.ctrl.pool.parallel.Batch.execution	(		self,
			command
	)

Return execution string for script to be submitted

Definition at line 117 of file parallel.py.

preamble()

def lsst.ctrl.pool.parallel.Batch.preamble	(		self,
			command,
			walltime = None
	)

Return preamble string for script to be submitted

Most batch systems allow you to embed submission options as comments here.

Definition at line 110 of file parallel.py.

run()

def lsst.ctrl.pool.parallel.Batch.run	(		self,
			command,
			walltime = None
	)

Run the batch system.

Creates and submits the script to execute the provided command

Parameters

command	command to run
walltime	maximum wall clock time, overrides value to constructor

Returns

name of script on filesystem

Definition at line 164 of file parallel.py.

shebang()

def lsst.ctrl.pool.parallel.Batch.shebang

(

self

)

Definition at line 107 of file parallel.py.

submitCommand()

def lsst.ctrl.pool.parallel.Batch.submitCommand	(		self,
			scriptName
	)

Return command to submit script.

Parameters

scriptName

name of script on filesystem

Definition at line 157 of file parallel.py.

Member Data Documentation

doExec

lsst.ctrl.pool.parallel.Batch.doExec

Definition at line 101 of file parallel.py.

dryrun

lsst.ctrl.pool.parallel.Batch.dryrun

Definition at line 100 of file parallel.py.

jobName

lsst.ctrl.pool.parallel.Batch.jobName

Definition at line 98 of file parallel.py.

mpiexec

lsst.ctrl.pool.parallel.Batch.mpiexec

Definition at line 102 of file parallel.py.

numCores

lsst.ctrl.pool.parallel.Batch.numCores

Definition at line 96 of file parallel.py.

numNodes

lsst.ctrl.pool.parallel.Batch.numNodes

Definition at line 94 of file parallel.py.

numProcsPerNode

lsst.ctrl.pool.parallel.Batch.numProcsPerNode

Definition at line 95 of file parallel.py.

options

lsst.ctrl.pool.parallel.Batch.options

Definition at line 104 of file parallel.py.

outputDir

lsst.ctrl.pool.parallel.Batch.outputDir

Definition at line 93 of file parallel.py.

queue

lsst.ctrl.pool.parallel.Batch.queue

Definition at line 97 of file parallel.py.

submit

lsst.ctrl.pool.parallel.Batch.submit

Definition at line 103 of file parallel.py.

verbose

lsst.ctrl.pool.parallel.Batch.verbose

Definition at line 105 of file parallel.py.

walltime

lsst.ctrl.pool.parallel.Batch.walltime

Definition at line 99 of file parallel.py.

---

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

• python/lsst/ctrl/pool/parallel.py