.. automodule:: controller :no-undoc-members:
See :doc:`example<overview>` for usage.
The JobController should be constructed after registering applications to a Registry:
jobctl = JobController(registry = registry)
or if using Balsam:
jobctr = BalsamJobController(registry = registry)
.. autoclass:: JobController :member-order: bysource :members: __init__, launch, poll, manager_poll, kill, set_kill_mode
.. autoclass:: BalsamJobController :show-inheritance: :member-order: bysource
Jobs are created and returned though the job_controller launch function. Jobs can be passed as arguments to the job_controller poll and kill functions. Job information can be queired through the job attributes below and the query functions. Note that the job attributes are only updated when they are polled (or though other job controller functions).
.. autoclass:: Job :member-order: bysource :members: workdir_exists, file_exists_in_workdir, read_file_in_workdir, stdout_exists, read_stdout, stderr_exists, read_stderr
.. autoclass:: BalsamJob :show-inheritance: :member-order: bysource
Following is a list of job status and configuration attributes that can be retrieved from a job.
| NOTE: | These should not be set directly. Jobs are launched by the job controller and job information can be queired through the job attributes below and the query functions. |
|---|
Job Status attributes include:
| job.state: | (string) The job status. One of: ('UNKNOWN'|'CREATED'|'WAITING'|'RUNNING'|'FINISHED'|'USER_KILLED'|'FAILED') |
|---|---|
| job.process: | (process obj) The process object used by the underlying process manager (e.g. return value of subprocess.Popen) |
| job.errcode: | (int) The errorcode/return code used by the underlying process manager |
| job.finished: | (Boolean) True means job has finished running - not whether was successful |
| job.success: | (Boolean) Did job complete succesfully (e.g. returncode is zero) |
Run configuration attributes - Some will be auto-generated:
| job.workdir: | (string) Work directory for the job |
|---|---|
| job.name: | (string) Name of job - auto-generated |
| job.app: | (app obj) Use application/executable, registered using registry.register_calc |
| job.app_args: | (string) Application arguments as a string |
| job.num_procs: | (int) Total number of processors for job |
| job.num_nodes: | (int) Number of nodes for job |
| job.ranks_per_node: | (int) Ranks per node for job |
| job.machinefile: | (string) Name of machinefile is provided if one has been created. |
| job.hostlist: | (string) List of nodes for job is provided if one has been created. |
| job.stdout: | (string) Name of file where the standard output of the job is written (in job.workdir) |
A list of job_controller and job functions can be found under the Job Controller Module.