JobScript.JobScriptBase Class Reference

Inheritance diagram for JobScript.JobScriptBase:

Public Member Functions
def	__init__ (self, conf)
def	create (self)
def	submit (self)
def	__init__ (self, conf)
def	create (self)
def	submit (self)

Public Attributes
	name
	job descriptors More...
	nppernode
	nnode
	walltime
	olog
	elog
	env
	submission descriptors More...
	basescript
	jobpath
	script
	command
	header

Detailed Description

Describes an HPC job script including
+ reading a configuration
+ generating the script
+ submitting the script

Each HPC job submission system (e.g., PBSPro on Cheyenne)
will have its own derived class that defines
the job header and submission command
generic config elements:
    required config parameter(s):
    basescript (required) - either a list of str's containing individual lines of the script
                            or a str giving the location of the script

    optional config parameter(s):
    env - linux environment of the script (e.g., csh, bash, sh, tcsh)
    name - job name
    nppernode - processors per node
    nnode - number of nodes
    walltime - walltime
    olog - output log name
    elog - error log name

Definition at line 7 of file JobScript.py.

Constructor & Destructor Documentation

__init__() [1/2]

def JobScript.JobScriptBase.__init__	(		self,
			conf
	)

Reimplemented in JobScript.SLURMCasper, JobScript.PBSProCheyenne, JobScript.SLURMCasper, and JobScript.PBSProCheyenne.

Definition at line 31 of file JobScript.py.

Here is the caller graph for this function:

__init__() [2/2]

def JobScript.JobScriptBase.__init__	(		self,
			conf
	)

Reimplemented in JobScript.SLURMCasper, JobScript.PBSProCheyenne, JobScript.SLURMCasper, and JobScript.PBSProCheyenne.

Definition at line 31 of file JobScript.py.

Here is the call graph for this function:

Member Function Documentation

create() [1/2]

def JobScript.JobScriptBase.create

(

self

)

Definition at line 51 of file JobScript.py.

Here is the caller graph for this function:

create() [2/2]

def JobScript.JobScriptBase.create

(

self

)

Definition at line 51 of file JobScript.py.

Here is the call graph for this function:

submit() [1/2]

def JobScript.JobScriptBase.submit

(

self

)

Definition at line 81 of file JobScript.py.

Here is the caller graph for this function:

submit() [2/2]

def JobScript.JobScriptBase.submit

(

self

)

Definition at line 81 of file JobScript.py.

Here is the call graph for this function:

Member Data Documentation

basescript

JobScript.JobScriptBase.basescript

Definition at line 42 of file JobScript.py.

command

JobScript.JobScriptBase.command

Definition at line 48 of file JobScript.py.

elog

JobScript.JobScriptBase.elog

Definition at line 38 of file JobScript.py.

env

JobScript.JobScriptBase.env

submission descriptors

Definition at line 41 of file JobScript.py.

header

JobScript.JobScriptBase.header

Definition at line 49 of file JobScript.py.

jobpath

JobScript.JobScriptBase.jobpath

Definition at line 45 of file JobScript.py.

name

JobScript.JobScriptBase.name

job descriptors

Definition at line 33 of file JobScript.py.

nnode

JobScript.JobScriptBase.nnode

Definition at line 35 of file JobScript.py.

nppernode

JobScript.JobScriptBase.nppernode

Definition at line 34 of file JobScript.py.

olog

JobScript.JobScriptBase.olog

Definition at line 37 of file JobScript.py.

script

JobScript.JobScriptBase.script

Definition at line 46 of file JobScript.py.

walltime

JobScript.JobScriptBase.walltime

Definition at line 36 of file JobScript.py.

---

The documentation for this class was generated from the following file:

• mpas-bundle/mpas-jedi/graphics/cycling/JobScript.py