ClusterBase Class Reference

Inheritance diagram for ClusterBase:

Public Member Functions
def	__init__ (self)
	The default constructor.
str	createDoneFileName (self, Script job)
	Generate the file name used for the done output.
def	prepareSubmission (self, Script job, options, tag)
	Setup output folders and create the wrapping shell script. More...
def	checkDoneFile (self, job)
	Checks whether the '.done'-file has been created for a job. More...
def	terminate (self, Script job)
	Terminate running job.
def	adjust_path (self, path)
	This method can be used if path names are different on submission and execution hosts. More...

Public Attributes
	path
	The default constructor. More...
	logger
	Contains a reference to the logger-object from validate_basf2 Set up the logging functionality for the 'cluster execution'-Class, so we can log to validate_basf2.py's log what is going on in .execute and .is_finished.
	tools
	Path to the basf2 tools and central/local release.
	b2setup
	The command for b2setup (and b2code-option)
	clusterlog
	The file object to which all cluster messages will be written.

Detailed Description

Base class which provides basic functionality to wrap basf2 into a shell
script setting up the environment and checking for completion of script

Definition at line 21 of file clustercontrolbase.py.

Member Function Documentation

adjust_path()

def adjust_path	(		self,
			path
	)

This method can be used if path names are different on submission and execution hosts.

Parameters

path	The past that needs to be adjusted

Returns

: The adjusted path

Definition at line 177 of file clustercontrolbase.py.

    def adjust_path(self, path):
        """!
        This method can be used if path names are different on submission
        and execution hosts.
        @param path: The past that needs to be adjusted
        @return: The adjusted path
        """

checkDoneFile()

def checkDoneFile	(		self,
			job
	)

Checks whether the '.done'-file has been created for a job.

If so, it returns True, else it returns False in the first part of the tuple. Also deletes the .done-File it if exists. The second entry in the tuple will be the exit code read from the done file

Definition at line 139 of file clustercontrolbase.py.

prepareSubmission()

def prepareSubmission	(		self,
		Script	job,
			options,
			tag
	)

Setup output folders and create the wrapping shell script.

Will return the full file name of the generated wrapper script.

Definition at line 82 of file clustercontrolbase.py.

Member Data Documentation

path

path

The default constructor.

The path, where the help files are being created Maybe there should be a special subfolder for them?

Definition at line 33 of file clustercontrolbase.py.

---

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

• validation/scripts/clustercontrolbase.py