Python API: sam v8_1_5 sam.runJob()
|  |
This is the python interface to the command 'sam run job'.
Command Description:
This command is equivalent to "sam submit --interactive".
Python Usage:
from Sam import sam
result = sam.runJob(...)
Return value: <none>
Arguments are passed as keyword-value pairs, as in:
myfunc(arg1='myarg', arg2='anotherarg', d=1)
Argument Keyword Description:
(*) indicates that this keyword is required
>>> indicates that either the API object or the CLI equivalent (<<<) is required
====================================================================================================================================
KEYWORD DATA TYPE DESCRIPTION
------------------------------------------------------------------------------------------------------------------------------------
batchSystem string name of the batch system to use if not the station default
batchSystemFlags string additional batch-specific flags to be passed to the batch system
bundleFiles string comma separated list of files to send with the job to a remote batch system
c SamBoolean automatically close all servants after each method call
corbaCallTimeout int time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
cpuPerEvent TimeInterval estimated amount of CPU required per event
d SamBoolean debug mode
defname string project definition name
detached SamBoolean run pmaster detached from the station in the current session
envVar string user environmental variables to be set when the job executes
fileCut int limit the number of files to this number
group string work group that should be charged for project resources
interactive SamBoolean do NOT submit the job; instead, run interactively
jdf string job description file
jobErrorFile string job error file (use __default__ for the defaul error file)
jobInfoFile string job information file
jobOutputFile string job output file (use __default__ for the default output file)
keepBatchScript SamBoolean do not remove temporary batch wrapper script after execution
nconsumers int number of consumer processes to run in this job
project string name of the project
queue string batch queue to which the job should be submitted
restart SamBoolean flag that this project should be restarted
retryInterval int retry interval base in seconds; will multiply this base times retryCount (default: 5)
retryJitter int retry jitter, random jitter added to base retry interval times retryCount (default: 5)
retryMaxCount int number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
rtfile string file in which to return "start project" results; default=stdout
s SamBoolean retrySilently mode (do not issue messages to stderr on proxy retries)
script string script containing the processing commands you wish to execute
scriptParams string parameters to be passed to the script
snapshot string name of the already-existing snapshot to be used as the project file list
(*) station string station where the job should run
submitInfoFile string file into which submission information is written
t SamBoolean time-it mode (print additional info on timings)
useForcedStop SamBoolean project will be stopped if job count reaches zero, regardless of whether all consumers are finished or not
v SamBoolean verbose mode
workDir string working directory for process
wrapperScriptDir string directory in which to write the batch wrapper script (default: $HOME)
====================================================================================================================================
Must have at least one of:
(defname, snapshot)
Mutually exclusive keywords:
(defname || snapshot)
Environment Defaults:
c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
project = os.environ['SAM_PROJECT']
retryInterval = os.environ['SAM_PYAPI_RETRY_INTERVAL']
retryJitter = os.environ['SAM_PYAPI_RETRY_JITTER']
retryMaxCount = os.environ['SAM_PYAPI_RETRY_MAX_COUNT']
s = os.environ['SAM_PYAPI_RETRY_SILENTLY']
station = os.environ['SAM_STATION']
See Also: