### Navigation

- index
- modules |
- FireWorks 0.66 documentation »

# queue_adapters Package

## `common_adapter` Module

This module implements a CommonAdaptor that supports standard PBS and SGE queues.

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 or SGE. 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.

  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

  `supported_q_types` = ['PBS', 'SGE', 'SLURM']
  `to_dict`(*args, **kwargs)

## `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'

## Subpackages

- tests Package
  - `tests` Package
  - `test_common_adaptor` Module

### Navigation

- index
- modules |
- FireWorks 0.66 documentation »