Inheritance diagram for python.pipeline.CondorJob:

Collaboration diagram for python.pipeline.CondorJob:

Public Member Functions
	__init__ (self, universe, executable, queue)
	get_executable (self)
	set_executable (self, executable)
	get_universe (self)
	set_universe (self, universe)
	get_grid_type (self)
	set_grid_type (self, grid_type)
	get_grid_server (self)
	set_grid_server (self, grid_server)
	get_grid_scheduler (self)
	set_grid_scheduler (self, grid_scheduler)
	set_executable_installed (self, installed)
	get_executable_installed (self)
	add_condor_cmd (self, cmd, value)
	get_condor_cmds (self)
	add_input_file (self, filename)
	add_output_file (self, filename)
	add_checkpoint_file (self, filename)
	get_input_files (self)
	get_output_files (self)
	get_checkpoint_files (self)
	add_arg (self, arg)
	add_file_arg (self, filename)
	get_args (self)
	add_opt (self, opt, value)
	get_opt (self, opt)
	add_file_opt (self, opt, filename)
	get_opts (self)
	add_short_opt (self, opt, value)
	get_short_opts (self)
	add_ini_opts (self, cp, section)
	set_notification (self, value)
	set_log_file (self, path)
	set_stdin_file (self, path)
	get_stdin_file (self)
	set_stderr_file (self, path)
	get_stderr_file (self)
	set_stdout_file (self, path)
	get_stdout_file (self)
	set_sub_file (self, path)
	get_sub_file (self)
	write_sub_file (self)

Detailed Description

Generic condor job class. Provides methods to set the options in the
condor submit file for a particular executable

Definition at line 71 of file pipeline.py.

Constructor & Destructor Documentation

◆ init()

python.pipeline.CondorJob.__init__	(	self,
		universe,
		executable,
		queue )

@param universe: the condor universe to run the job in.
@param executable: the executable to run.
@param queue: number of jobs to queue.

Definition at line 76 of file pipeline.py.

Member Function Documentation

◆ add_arg()

python.pipeline.CondorJob.add_arg	(		self,
			arg )

Add an argument to the executable. Arguments are appended after any
options and their order is guaranteed.
@param arg: argument to add.

Definition at line 241 of file pipeline.py.

◆ add_checkpoint_file()

python.pipeline.CondorJob.add_checkpoint_file	(		self,
			filename )

Add filename as a checkpoint file for this DAG job.

Definition at line 216 of file pipeline.py.

◆ add_condor_cmd()

python.pipeline.CondorJob.add_condor_cmd	(	self,
		cmd,
		value )

Add a Condor command to the submit file (e.g. a class add or evironment).
@param cmd: Condor command directive.
@param value: value for command.

Definition at line 184 of file pipeline.py.

◆ add_file_arg()

python.pipeline.CondorJob.add_file_arg	(		self,
			filename )

Add a file argument to the executable. Arguments are appended after any
options and their order is guaranteed. Also adds the file name to the
list of required input data for this job.
@param filename: file to add as argument.

Definition at line 249 of file pipeline.py.

◆ add_file_opt()

python.pipeline.CondorJob.add_file_opt	(	self,
		opt,
		filename )

Add a command line option to the executable. The order that the arguments
will be appended to the command line is not guaranteed, but they will
always be added before any command line arguments. The name of the option
is prefixed with double hyphen and the program is expected to parse it
with getopt_long().
@param opt: command line option to add.
@param value: value to pass to the option (None for no argument).

Definition at line 288 of file pipeline.py.

◆ add_ini_opts()

python.pipeline.CondorJob.add_ini_opts	(	self,
		cp,
		section )

Parse command line options from a given section in an ini file and
pass to the executable.
@param cp: ConfigParser object pointing to the ini file.
@param section: section of the ini file to add to the options.

Definition at line 328 of file pipeline.py.

◆ add_input_file()

python.pipeline.CondorJob.add_input_file	(		self,
			filename )

Add filename as a necessary input file for this DAG node.

@param filename: input filename to add

Definition at line 198 of file pipeline.py.

◆ add_opt()

python.pipeline.CondorJob.add_opt	(	self,
		opt,
		value )

Add a command line option to the executable. The order that the arguments
will be appended to the command line is not guaranteed, but they will
always be added before any command line arguments. The name of the option
is prefixed with double hyphen and the program is expected to parse it
with getopt_long().
@param opt: command line option to add.
@param value: value to pass to the option (None for no argument).

Definition at line 266 of file pipeline.py.

◆ add_output_file()

python.pipeline.CondorJob.add_output_file	(		self,
			filename )

Add filename as a output file for this DAG node.

@param filename: output filename to add

Definition at line 207 of file pipeline.py.

◆ add_short_opt()

python.pipeline.CondorJob.add_short_opt	(	self,
		opt,
		value )

Add a command line option to the executable. The order that the arguments
will be appended to the command line is not guaranteed, but they will
always be added before any command line arguments. The name of the option
is prefixed with single hyphen and the program is expected to parse it
with getopt() or getopt_long() (if a single character option), or
getopt_long_only() (if multiple characters).  Long and (single-character)
short options may be mixed if the executable permits this.
@param opt: command line option to add.
@param value: value to pass to the option (None for no argument).

Definition at line 308 of file pipeline.py.

◆ get_args()

python.pipeline.CondorJob.get_args ( self )

Return the list of arguments that are to be passed to the executable.

Definition at line 260 of file pipeline.py.

◆ get_checkpoint_files()

python.pipeline.CondorJob.get_checkpoint_files ( self )

Return a list of checkpoint files for this DAG node

Definition at line 235 of file pipeline.py.

◆ get_condor_cmds()

python.pipeline.CondorJob.get_condor_cmds ( self )

Return the dictionary of condor keywords to add to the job

Definition at line 192 of file pipeline.py.

◆ get_executable()

python.pipeline.CondorJob.get_executable ( self )

Return the name of the executable for this job.

Definition at line 105 of file pipeline.py.

◆ get_executable_installed()

python.pipeline.CondorJob.get_executable_installed ( self )

return whether or not the executable is installed

Definition at line 178 of file pipeline.py.

◆ get_grid_scheduler()

python.pipeline.CondorJob.get_grid_scheduler ( self )

Return the grid scheduler.

Definition at line 156 of file pipeline.py.

◆ get_grid_server()

python.pipeline.CondorJob.get_grid_server ( self )

Return the grid server on which the job will run.

Definition at line 143 of file pipeline.py.

◆ get_grid_type()

python.pipeline.CondorJob.get_grid_type ( self )

Return the grid type of the job.

Definition at line 130 of file pipeline.py.

◆ get_input_files()

python.pipeline.CondorJob.get_input_files ( self )

Return list of input files for this DAG node.

Definition at line 223 of file pipeline.py.

◆ get_opt()

python.pipeline.CondorJob.get_opt	(		self,
			opt )

Returns the value associated with the given command line option.
Returns None if the option does not exist in the options list.
@param opt: command line option

Definition at line 278 of file pipeline.py.

◆ get_opts()

python.pipeline.CondorJob.get_opts ( self )

Return the dictionary of opts for the job.

Definition at line 302 of file pipeline.py.

◆ get_output_files()

python.pipeline.CondorJob.get_output_files ( self )

Return list of output files for this DAG node.

Definition at line 229 of file pipeline.py.

◆ get_short_opts()

python.pipeline.CondorJob.get_short_opts ( self )

Return the dictionary of short options for the job.

Definition at line 322 of file pipeline.py.

◆ get_stderr_file()

python.pipeline.CondorJob.get_stderr_file ( self )

Get the file to which Condor directs the stderr of the job.

Definition at line 373 of file pipeline.py.

◆ get_stdin_file()

python.pipeline.CondorJob.get_stdin_file ( self )

Get the file from which Condor directs the stdin of the job.

Definition at line 360 of file pipeline.py.

◆ get_stdout_file()

python.pipeline.CondorJob.get_stdout_file ( self )

Get the file to which Condor directs the stdout of the job.

Definition at line 386 of file pipeline.py.

◆ get_sub_file()

python.pipeline.CondorJob.get_sub_file ( self )

Get the name of the file which the Condor submit file will be
written to when write_sub_file() is called.

Definition at line 400 of file pipeline.py.

◆ get_universe()

python.pipeline.CondorJob.get_universe ( self )

Return the condor universe that the job will run in.

Definition at line 117 of file pipeline.py.

◆ set_executable()

python.pipeline.CondorJob.set_executable	(		self,
			executable )

Set the name of the executable for this job.

Definition at line 111 of file pipeline.py.

◆ set_executable_installed()

python.pipeline.CondorJob.set_executable_installed	(		self,
			installed )

If executable installed is true, then no copying of the executable is
done. If it is false, pegasus stages the executable to the remote site.
Default is executable is installed (i.e. True).
@param installed: true or fale

Definition at line 169 of file pipeline.py.

◆ set_grid_scheduler()

python.pipeline.CondorJob.set_grid_scheduler	(		self,
			grid_scheduler )

Set the grid scheduler.
@param grid_scheduler: grid scheduler on which to run.

Definition at line 162 of file pipeline.py.

◆ set_grid_server()

python.pipeline.CondorJob.set_grid_server	(		self,
			grid_server )

Set the grid server on which to run the job.
@param grid_server: grid server on which to run.

Definition at line 149 of file pipeline.py.

◆ set_grid_type()

python.pipeline.CondorJob.set_grid_type	(		self,
			grid_type )

Set the type of grid resource for the job.
@param grid_type: type of grid resource.

Definition at line 136 of file pipeline.py.

◆ set_log_file()

python.pipeline.CondorJob.set_log_file	(		self,
			path )

Set the Condor log file.
@param path: path to log file.

Definition at line 346 of file pipeline.py.

◆ set_notification()

python.pipeline.CondorJob.set_notification	(		self,
			value )

Set the email address to send notification to.
@param value: email address or never for no notification.

Definition at line 339 of file pipeline.py.

◆ set_stderr_file()

python.pipeline.CondorJob.set_stderr_file	(		self,
			path )

Set the file to which Condor directs the stderr of the job.
@param path: path to stderr file.

Definition at line 366 of file pipeline.py.

◆ set_stdin_file()

python.pipeline.CondorJob.set_stdin_file	(		self,
			path )

Set the file from which Condor directs the stdin of the job.
@param path: path to stdin file.

Definition at line 353 of file pipeline.py.

◆ set_stdout_file()

python.pipeline.CondorJob.set_stdout_file	(		self,
			path )

Set the file to which Condor directs the stdout of the job.
@param path: path to stdout file.

Definition at line 379 of file pipeline.py.

◆ set_sub_file()

python.pipeline.CondorJob.set_sub_file	(		self,
			path )

Set the name of the file to write the Condor submit file to when
write_sub_file() is called.
@param path: path to submit file.

Definition at line 392 of file pipeline.py.

◆ set_universe()

python.pipeline.CondorJob.set_universe	(		self,
			universe )

Set the condor universe for the job to run in.
@param universe: the condor universe to run the job in.

Definition at line 123 of file pipeline.py.

◆ write_sub_file()

python.pipeline.CondorJob.write_sub_file ( self )

Write a submit file for this Condor job.

Definition at line 407 of file pipeline.py.

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

/home/abuild/rpmbuild/BUILD/gstlal-1.13.0-build/build_python313/python/pipeline.py

Public Member Functions