queue_adapters Package

pbs_adapter Module

TODO: add docs!

class fireworks.user_objects.queue_adapters.pbs_adapter.PBSAdapterNERSC

Bases: fireworks.queue.queue_adapter.QueueAdapterBase

get_njobs_in_queue(rocket_params, username=None)

for documentation, see parent object

get_script_str(queue_params, launch_dir)

Create a NERSC-style PBS script. For more documentation, see parent object.

Supported QueueParams.params are:
  • mppwidth: number of cores (for queues that specify ncores as mppwidth)
  • nnodes: number of nodes (if you are not specifying mppwidth)
  • ppnode: processors per node (if you are not specifying mppwidth)
  • walltime: looks like “hh:mm:ss”
  • queue: the queue to run on
  • account: the account to charge
  • pbs_options: a dict that sets the PBS -l key-value pairs
  • pbs_tags: a list of PBS tags
  • job_name: the name of the job to run
  • modules: a list of modules to load
  • exe: the executable to run, after moving to the launch_dir
submit_to_queue(rocket_params, script_file)

for documentation, see parent object

slurm_adapter Module

TODO: add docs!

class fireworks.user_objects.queue_adapters.slurm_adapter.SLURMAdapterUCL

Bases: fireworks.queue.queue_adapter.QueueAdapterBase

get_njobs_in_queue(queue_params, username=None)

for documentation, see parent object

get_script_str(queue_params, launch_dir)

Create a UCL-style SLURM script. For more documentation, see parent object.

Supported QueueParams.params are:
  • ntasks: number of tasks (default : 1)
  • ntasks_per_node: maximum number of tasks to be invoked for each node
  • cpus_per_task: number of cpus per task (default : 1)
  • walltime: looks like “hh:mm:ss”
  • queue: the queue to run on
  • account: the account to charge
  • slurm_options: a dict that sets the SLURM -l key-value pairs
  • slurm_tags: a list of SLURM tags
  • job_name: the name of the job to run
  • modules: a list of modules to load
  • exe: the executable to run, after moving to the launch_dir
submit_to_queue(queue_params, script_file)

for documentation, see parent object

Table Of Contents

This Page