|
lsst.ctrl.pool
21.0.0-2-ga326454+0fb7b44f27
|
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 | |
Base class for batch submission
Definition at line 68 of file parallel.py.
| 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.
@param outputDir: output directory, or None
@param numNodes: number of nodes
@param numProcsPerNode: number of processors per node
@param numCores: number of cores (Slurm, SMP only)
@param queue: name of queue, or None
@param jobName: name of job, or None
@param walltime: maximum wall clock time for job
@param dryrun: Dry run (only print actions that would be taken)?
@param doExec: exec the script instead of submitting to batch system?
@param mpiexec: options for mpiexec
@param submit: command-line options for batch submission (e.g., for qsub, sbatch)
@param options: options to append to script header (e.g., #PBS or #SBATCH)
@param verbose: produce verbose output?
Definition at line 71 of file parallel.py.
| def lsst.ctrl.pool.parallel.Batch.createScript | ( | self, | |
| command, | |||
walltime = None |
|||
| ) |
Create script to be submitted.
@param command: command to run
@param walltime: maximum wall clock time, overrides value to constructor
@return name of script on filesystem
Definition at line 138 of file parallel.py.
| 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.
| 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.
| 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
@param command: command to run
@param walltime: maximum wall clock time, overrides value to constructor
@return name of script on filesystem
Definition at line 164 of file parallel.py.
| def lsst.ctrl.pool.parallel.Batch.shebang | ( | self | ) |
Definition at line 107 of file parallel.py.
| def lsst.ctrl.pool.parallel.Batch.submitCommand | ( | self, | |
| scriptName | |||
| ) |
Return command to submit script.
@param scriptName: name of script on filesystem
Reimplemented in lsst.ctrl.pool.parallel.SmpBatch, lsst.ctrl.pool.parallel.SlurmBatch, and lsst.ctrl.pool.parallel.PbsBatch.
Definition at line 157 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.doExec |
Definition at line 101 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.dryrun |
Definition at line 100 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.jobName |
Definition at line 98 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.mpiexec |
Definition at line 102 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.numCores |
Definition at line 96 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.numNodes |
Definition at line 94 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.numProcsPerNode |
Definition at line 95 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.options |
Definition at line 104 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.outputDir |
Definition at line 93 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.queue |
Definition at line 97 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.submit |
Definition at line 103 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.verbose |
Definition at line 105 of file parallel.py.
| lsst.ctrl.pool.parallel.Batch.walltime |
Definition at line 99 of file parallel.py.