This module contains contracts for defining adapters to various queueing systems, e.g. PBS/SLURM/SGE.
Bases: string.Template
Bases: dict, fireworks.utilities.fw_serializers.FWSerializable
The QueueAdapter is responsible for all interactions with a specific queue management system. This includes handling all details of queue script format as well as queue submission and management.
A user should extend this class with implementations that work on specific queue systems.
returns the number of jobs in the queue, probably using subprocess or shutil to call a command like ‘qstat’. returns None when the number of jobs cannot be determined.
Parameters: | username – (str) the username of the jobs to count (default is to autodetect) |
---|
returns a (multi-line) String representing the queue script, e.g. PBS script. Uses the template_file along with internal parameters to create the script.
Parameters: | launch_dir – (str) The directory the job will be launched in |
---|
submits the job to the queue, probably using subprocess or shutil
Parameters: | script_file – (str) name of the script file to use (String) |
---|
This module is used to submit jobs to a queue on a cluster. It can submit a single job, or if used in “rapid-fire” mode, can submit multiple jobs within a directory structure. The details of job submission and queue communication are handled using Queueadapter, which specifies a QueueAdapter as well as desired properties of the submit script.
Submit a single job to the queue.
Parameters: |
|
---|
Submit many jobs to the queue.
Parameters: |
|
---|