pulsar.managers package¶
Subpackages¶
- pulsar.managers.base package
- pulsar.managers.staging package
- pulsar.managers.util package
- Subpackages
- Submodules
- pulsar.managers.util.aws_batch module
- pulsar.managers.util.env module
- pulsar.managers.util.external module
- pulsar.managers.util.kill module
- pulsar.managers.util.process_groups module
- pulsar.managers.util.pykube_util module
- pulsar.managers.util.retry module
- pulsar.managers.util.sudo module
- pulsar.managers.util.tes module
- Module contents
Submodules¶
pulsar.managers.queued module¶
-
class
pulsar.managers.queued.
QueueManager
(name, app, **kwds)[source]¶ Bases:
pulsar.managers.unqueued.Manager
A job manager that queues up jobs directly (i.e. does not use an external queuing software such PBS, SGE, etc…).
-
launch
(job_id, command_line, submit_params=None, dependencies_description=None, env=[], setup_params=None)[source]¶ Called to indicate that the client is ready for this job with specified job id and command line to be executed (i.e. run or queue this job depending on implementation).
-
manager_type
= 'queued_python'¶
-
pulsar.managers.queued_cli module¶
Pulsar job manager that uses a CLI interface to a job queue (e.g. Torque’s qsub, qstat, etc…).
-
class
pulsar.managers.queued_cli.
CliQueueManager
(name, app, **kwds)[source]¶ Bases:
pulsar.managers.base.external.ExternalBaseManager
-
launch
(job_id, command_line, submit_params={}, dependencies_description=None, env=[], setup_params=None)[source]¶ Called to indicate that the client is ready for this job with specified job id and command line to be executed (i.e. run or queue this job depending on implementation).
-
manager_type
= 'queued_cli'¶
-
pulsar.managers.queued_condor module¶
-
class
pulsar.managers.queued_condor.
CondorQueueManager
(name, app, **kwds)[source]¶ Bases:
pulsar.managers.base.external.ExternalBaseManager
Job manager backend that plugs into Condor.
-
get_status
(job_id)[source]¶ Return status of job as string, currently supported statuses include ‘cancelled’, ‘running’, ‘queued’, and ‘complete’.
-
launch
(job_id, command_line, submit_params={}, dependencies_description=None, env=[], setup_params=None)[source]¶ Called to indicate that the client is ready for this job with specified job id and command line to be executed (i.e. run or queue this job depending on implementation).
-
manager_type
= 'queued_condor'¶
-
pulsar.managers.queued_drmaa module¶
-
class
pulsar.managers.queued_drmaa.
DrmaaQueueManager
(name, app, **kwds)[source]¶ Bases:
pulsar.managers.base.base_drmaa.BaseDrmaaManager
DRMAA backed queue manager.
-
launch
(job_id, command_line, submit_params={}, dependencies_description=None, env=[], setup_params=None)[source]¶ Called to indicate that the client is ready for this job with specified job id and command line to be executed (i.e. run or queue this job depending on implementation).
-
manager_type
= 'queued_drmaa'¶
-
pulsar.managers.queued_drmaa_xsede module¶
-
class
pulsar.managers.queued_drmaa_xsede.
XsedeDrmaaQueueManager
(name, app, **kwds)[source]¶ Bases:
pulsar.managers.queued_drmaa.DrmaaQueueManager
DRMAA backed queue manager for XSEDE (to run the XSEDE job/user reporting script after submission).
TODO: A generalized callback framework for executing things at various points in the job lifecycle.
-
launch
(job_id, command_line, submit_params={}, dependencies_description=None, env=[], setup_params=None)[source]¶ Called to indicate that the client is ready for this job with specified job id and command line to be executed (i.e. run or queue this job depending on implementation).
-
manager_type
= 'queued_drmaa_xsede'¶
-
pulsar.managers.queued_external_drmaa module¶
-
class
pulsar.managers.queued_external_drmaa.
ExternalDrmaaQueueManager
(name, app, **kwds)[source]¶ Bases:
pulsar.managers.base.base_drmaa.BaseDrmaaManager
DRMAA backed queue manager.
-
get_status
(job_id)[source]¶ Return status of job as string, currently supported statuses include ‘cancelled’, ‘running’, ‘queued’, and ‘complete’.
-
launch
(job_id, command_line, submit_params={}, dependencies_description=None, env=[], setup_params=None)[source]¶ Called to indicate that the client is ready for this job with specified job id and command line to be executed (i.e. run or queue this job depending on implementation).
-
manager_type
= 'queued_external_drmaa'¶
-
pulsar.managers.queued_pbs module¶
-
class
pulsar.managers.queued_pbs.
PbsQueueManager
(name, app, **kwds)[source]¶ Bases:
pulsar.managers.base.BaseManager
Placeholder for PBS-python backed queue manager. Not yet implemented, for many situations this would be used the DRMAA or CLI+Torque managers may be better choices or at least stop gaps.
-
manager_type
= 'queued_pbs'¶
-
pulsar.managers.stateful module¶
pulsar.managers.status module¶
pulsar.managers.unqueued module¶
-
class
pulsar.managers.unqueued.
Manager
(name, app, **kwds)[source]¶ Bases:
pulsar.managers.unqueued.BaseUnqueuedManager
A simple job manager that just directly runs jobs as given (no queueing). Preserved for compatibilty with older versions of Pulsar client code where Galaxy is used to maintain queue (like Galaxy’s local job runner).
-
get_status
(job_id)[source]¶ Return status of job as string, currently supported statuses include ‘cancelled’, ‘running’, ‘queued’, and ‘complete’.
-
launch
(job_id, command_line, submit_params={}, dependencies_description=None, env=[], setup_params=None)[source]¶ Called to indicate that the client is ready for this job with specified job id and command line to be executed (i.e. run or queue this job depending on implementation).
-
manager_type
= 'unqueued'¶
-
Module contents¶
-
class
pulsar.managers.
ManagerInterface
[source]¶ Bases:
object
Defines the interface to various job managers.
-
clean
(job_id)[source]¶ Delete job directory and clean up resources associated with job with id job_id.
-
get_status
(job_id)[source]¶ Return status of job as string, currently supported statuses include ‘cancelled’, ‘running’, ‘queued’, and ‘complete’.
-
job_directory
(job_id)[source]¶ Return a JobDirectory abstraction describing the state of the job working directory.
-
job_stderr_contents
(job_id)[source]¶ After completion, return contents of stderr of the job as produced by the job runner.
-
job_stdout_contents
(job_id)[source]¶ After completion, return contents of stdout of the job as produced by the job runner.
-
launch
(job_id, command_line, submit_params={}, dependencies_description=None, env=[], setup_params=None)[source]¶ Called to indicate that the client is ready for this job with specified job id and command line to be executed (i.e. run or queue this job depending on implementation).
-
return_code
(job_id)[source]¶ Return integer indicating return code of specified execution or PULSAR_UNKNOWN_RETURN_CODE.
-