Schedulers
==========

.. contents:: Table of Contents

.. _schedulers:

Scheduler Module
----------------

Scheduler Plugin Class
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pavilion.schedulers.SchedulerPlugin
    :members:
    :show-inheritance:
    :undoc-members:
    :special-members:
    :private-members:

Scheduler Plugin Basic Class
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pavilion.schedulers.SchedulerPluginBasic
    :members:
    :show-inheritance:
    :undoc-members:
    :special-members:
    :private-members:

Scheduler Plugin Advanced Class
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pavilion.schedulers.SchedulerPluginAdvanced
    :members:
    :show-inheritance:
    :undoc-members:
    :special-members:
    :private-members:

Scheduler Variables
~~~~~~~~~~~~~~~~~~~

.. autoclass:: pavilion.schedulers.SchedulerVariables
    :members:
    :show-inheritance:
    :undoc-members:
    :special-members:
    :private-members:

Scheduler Plugins
-----------------

Slurm
~~~~~

Slurm Variables
^^^^^^^^^^^^^^^

.. autoclass:: pavilion.schedulers.plugins.slurm.SlurmVars
    :members:
    :show-inheritance:
    :undoc-members:

Slurm Scheduler Plugin
^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: pavilion.schedulers.plugins.slurm.SbatchHeader
    :members:
    :show-inheritance:
    :undoc-members:
    :special-members:
    :private-members:

.. autoclass:: pavilion.schedulers.plugins.slurm.Slurm
    :members:
    :show-inheritance:
    :undoc-members:
    :special-members:
    :private-members:

Raw
~~~

Raw Variables
^^^^^^^^^^^^^

The raw scheduler uses the base SchedulerVariables class.

Raw Scheduler
^^^^^^^^^^^^^

.. autoclass:: pavilion.schedulers.plugins.raw.Raw
    :members:
    :show-inheritance:
    :undoc-members:
    :special-members:
    :private-members: