produtil.cluster Namespace Reference

Provides information about the cluster on which this job is running. More...

Detailed Description

Provides information about the cluster on which this job is running.

Classes
class	Cluster
	Stores information about a computer cluster. More...
class	NOAAGAEA
	Represents the NOAA GAEA cluster. More...
class	NOAAJet
	The NOAA Jet Cluster. More...
class	NOAATheia
class	NOAAWCOSS
	Represents the NOAA WCOSS clusters, Tide, Gyre and the test system Eddy. More...
class	NOAAZeus
	Represents the NOAA Zeus cluster. More...
class	UCARYellowstone
	Represents the Yellowstone cluster. More...
class	WCOSSCray
	This subclass of NOAAWCOSS handles the new Cray portions of WCOSS. More...
class	WisconsinS4
	Represents the S4 cluster. More...

Functions
def	set_cluster (there)
	Sets the current cluster (module-level "here" variable) to the given value. More...
def	where ()
	Guesses what cluster the program is running on, and if it cannot, returns a cluster named "noname" with reasonable defaults. More...
def	longname ()
	Synonym for here.longname. More...
def	name ()
	Synonym for here.name. More...
def	group_quotas ()
	Synonym for here.group_quotas. More...
def	acl_support ()
	Synonym for here.acl_support. More...
def	no_access_control ()
	True if the cluster provides no means to control access to files. More...
def	use_acl_for_rstdata ()
	Synonym for here.use_acl_for_rstdata. More...
def	ncepprod ()
	Are we on NCEP production? More...

Variables
list	__all__
	List of symbols exported by "from produtil.cluster import *". More...
tuple	DO_NOT_SET = object()
	Special values for parameters that should not be set. More...
	here = None
	The Cluster object for the local cluster. More...

Function Documentation

def produtil.cluster.acl_support

(

)

Synonym for here.acl_support.

Will call the "where()" function if "here" is uninitialized.

Definition at line 121 of file cluster.py.

def produtil.cluster.group_quotas

(

)

Synonym for here.group_quotas.

Will call the "where()" function if "here" is uninitialized.

Definition at line 115 of file cluster.py.

Referenced by produtil.fileop.deliver_file().

def produtil.cluster.longname

(

)

Synonym for here.longname.

Will call the "where()" function if "here" is uninitialized.

Definition at line 103 of file cluster.py.

def produtil.cluster.name

(

)

Synonym for here.name.

Will call the "where()" function if "here" is uninitialized.

Definition at line 109 of file cluster.py.

Referenced by scripts.exhwrf_gsi.main(), scripts.exhwrf_forecast.set_vars(), scripts.exhwrf_ensda.set_vars(), and hwrf.bufrprep.Bufrprep.tdrdump().

def produtil.cluster.ncepprod

(

)

Are we on NCEP production?

Returns

True if the present machine is the NCEP production machine. Note that this function may read a text file when it is called, and the return value may change during the execution of the program if the program is running during a production switch.

Definition at line 140 of file cluster.py.

def produtil.cluster.no_access_control

(

)

True if the cluster provides no means to control access to files.

This is true if the cluster uses group ids for quotas, and provides no access control list support.

Definition at line 127 of file cluster.py.

Referenced by produtil.rstprod.RestrictionClass.__init__().

def produtil.cluster.set_cluster

(

there

)

Sets the current cluster (module-level "here" variable) to the given value.

Bad things may happen if this is not a subclass of Cluster. #

Parameters

there

A Cluster object for this local cluster.

Definition at line 63 of file cluster.py.

Referenced by produtil.setup.setup().

def produtil.cluster.use_acl_for_rstdata

(

)

Synonym for here.use_acl_for_rstdata.

Will call the "where()" function if "here" is uninitialized.

Definition at line 134 of file cluster.py.

Referenced by produtil.rstprod.RestrictionClass.__init__(), and produtil.fileop.deliver_file().

def produtil.cluster.where

(

)

Guesses what cluster the program is running on, and if it cannot, returns a cluster named "noname" with reasonable defaults.

The result is stored in the module scope "here" variable.

Definition at line 71 of file cluster.py.

Referenced by produtil.cluster.acl_support(), produtil.cluster.group_quotas(), produtil.cluster.longname(), produtil.cluster.name(), produtil.cluster.ncepprod(), produtil.cluster.no_access_control(), produtil.setup.setup(), and produtil.cluster.use_acl_for_rstdata().

Variable Documentation

produtil.cluster.__all__

Initial value:

= ['Cluster','where','longname','name','group_quotas','acl_support',
         'no_access_control','use_acl_for_rstdata','ncepprod',
         'NOAAJet','NOAAGAEA','NOAAZeus','NOAAWCOSS']

List of symbols exported by "from produtil.cluster import *".

Definition at line 5 of file cluster.py.

produtil.cluster.DO_NOT_SET = object()

Special values for parameters that should not be set.

Definition at line 13 of file cluster.py.

produtil.cluster.here = None

The Cluster object for the local cluster.

Do not modify.

Definition at line 61 of file cluster.py.