jarvis.tasks.queue_jobs
=======================

.. py:module:: jarvis.tasks.queue_jobs

.. autoapi-nested-parse::

   Modules for job submission.



Classes
-------

.. autoapisummary::

   jarvis.tasks.queue_jobs.Queue


Module Contents
---------------

.. py:class:: Queue(q_type='head_node', q_parameters={}, job_sub_cmd=None, job_check_cmd='', job_id='')

   Bases: :py:obj:`object`


   Construct HPC Job class.


   .. py:attribute:: q_type
      :value: 'head_node'



   .. py:attribute:: q_parameters


   .. py:attribute:: job_sub_cmd
      :value: None



   .. py:attribute:: job_check_cmd
      :value: ''



   .. py:attribute:: job_id
      :value: ''



   .. py:method:: head_node(submit_cmd=None)

      Select if run on the head node, not recommended.



   .. py:method:: to_dict()

      Convert class to a dictionary.



   .. py:method:: from_dict(d={})
      :classmethod:


      Load from a dictionary.



   .. py:method:: pbs(filename='submit_job', shell='#!/bin/bash', nnodes=1, cores=16, walltime=None, queue=None, account=None, group_name=None, jobname='myJob', jobout='job.out', joberr='job.err', memory=None, email=None, pre_job_lines=None, directory=None, env=None, job_line='echo I am here', post_job_lines=None, submit_cmd=None)
      :classmethod:


      Select if run using PBS script.



   .. py:method:: slurm(filename='submit_job', shell='#!/bin/bash', nnodes=1, cores=16, walltime=None, queue=None, account=None, group_name=None, jobname='myJob', jobout='job.out', joberr='job.err', memory=None, email=None, pre_job_lines=None, directory=None, env=None, job_line='echo I am here', post_job_lines=None, submit_cmd=None)
      :classmethod:


      Select if run using SLURM script.