fireworks.user_objects.queue_adapters package¶
Subpackages¶
Submodules¶
fireworks.user_objects.queue_adapters.common_adapter module¶
-
class
fireworks.user_objects.queue_adapters.common_adapter.
CommonAdapter
(q_type, q_name=None, template_file=None, **kwargs)¶ Bases:
fireworks.queue.queue_adapter.QueueAdapterBase
An adapter that works on most PBS (including derivatives such as TORQUE), SGE, and SLURM queues.
-
__init__
(q_type, q_name=None, template_file=None, **kwargs)¶ Parameters: - q_type – The type of queue. Right now it should be either PBS, SGE, SLURM, Cobalt or LoadLeveler.
- q_name – A name for the queue. Can be any string.
- template_file – The path to the template file. Leave it as None (the default) to use Fireworks’ built-in templates for PBS and SGE, which should work on most queues.
- **kwargs –
Series of keyword args for queue parameters.
-
default_q_commands
= {'PBS': {'submit_cmd': 'qsub', 'status_cmd': 'qstat'}, 'SGE': {'submit_cmd': 'qsub', 'status_cmd': 'qstat'}, 'Cobalt': {'submit_cmd': 'qsub', 'status_cmd': 'qstat'}, 'SLURM': {'submit_cmd': 'sbatch', 'status_cmd': 'squeue'}, 'LoadLeveler': {'submit_cmd': 'llsubmit', 'status_cmd': 'llq'}, 'LoadSharingFacility': {'submit_cmd': 'bsub', 'status_cmd': 'bjobs'}}¶
-
classmethod
from_dict
(m_dict)¶
-
get_njobs_in_queue
(username=None)¶ returns the number of jobs currently in the queu efor the user
Parameters: username – (str) the username of the jobs to count (default is to autodetect) Returns: (int) number of jobs in the queue
-
submit_to_queue
(script_file)¶ submits the job to the queue and returns the job id
Parameters: script_file – (str) name of the script file to use (String) Returns: (int) job_id
-
to_dict
(*args, **kwargs)¶
-
fireworks.user_objects.queue_adapters.pbs_newt_adapter module¶
-
class
fireworks.user_objects.queue_adapters.pbs_newt_adapter.
PBSAdapterNEWT
¶ Bases:
fireworks.queue.queue_adapter.QueueAdapterBase
A special PBS adapter that works via the NEWT interface (https://newt.nersc.gov) Only intended for job submission via the RESTful NEWT web interface.
-
defaults
= {}¶
-
get_njobs_in_queue
(username=None)¶
-
q_name
= 'pbs_newt'¶
-
resource
= 'carver'¶
-
submit_cmd
= ''¶
-
submit_to_queue
(script_file)¶
-
template_file
= '/Users/ajain/Documents/code_matgen/fireworks/fireworks/user_objects/queue_adapters/PBS_template.txt'¶
-