Inheritance diagram for python.pipeline.CondorDAGNode:

Collaboration diagram for python.pipeline.CondorDAGNode:

Public Member Functions
	__init__ (self, job)
	__repr__ (self)
	job (self)
	set_pre_script (self, script)
	add_pre_script_arg (self, arg)
	set_post_script (self, script)
	get_post_script (self)
	add_post_script_arg (self, arg)
	get_post_script_arg (self)
	set_name (self, name)
	get_name (self)
	set_category (self, category)
	get_category (self)
	set_priority (self, priority)
	get_priority (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)
	set_vds_group (self, group)
	get_vds_group (self)
	add_macro (self, name, value)
	add_io_macro (self, io, filename)
	add_input_macro (self, filename)
	add_output_macro (self, filename)
	add_checkpoint_macro (self, filename)
	get_opts (self)
	add_var_condor_cmd (self, command, value)
	add_var_opt (self, opt, value, short=False)
	add_file_opt (self, opt, filename, file_is_output_file=False)
	add_var_arg (self, arg, quote=False)
	add_file_arg (self, filename)
	get_args (self)
	set_retry (self, retry)
	get_retry (self)
	write_job (self, fh)
	write_category (self, fh)
	write_priority (self, fh)
	write_vars (self, fh)
	write_parents (self, fh)
	write_pre_script (self, fh)
	write_post_script (self, fh)
	write_input_files (self, fh)
	write_output_files (self, fh)
	set_log_file (self, log)
	add_parent (self, node)
	get_cmd_tuple_list (self)
	get_cmd_line (self)
	finalize (self)

Detailed Description

A CondorDAGNode represents a node in the DAG. It corresponds to a particular
condor job (and so a particular submit file). If the job has variable
(macro) options, they can be set here so each nodes executes with the
correct options.

Definition at line 640 of file pipeline.py.

Constructor & Destructor Documentation

◆ init()

python.pipeline.CondorDAGNode.__init__	(		self,
			job )

@param job: the CondorJob that this node corresponds to.

Definition at line 647 of file pipeline.py.

Member Function Documentation

◆ repr()

python.pipeline.CondorDAGNode.__repr__ ( self )

Definition at line 686 of file pipeline.py.

◆ add_checkpoint_file()

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

Add filename as a checkpoint file for this DAG node
@param filename: checkpoint filename to add

Definition at line 800 of file pipeline.py.

◆ add_checkpoint_macro()

python.pipeline.CondorDAGNode.add_checkpoint_macro	(		self,
			filename )

Definition at line 894 of file pipeline.py.

◆ add_file_arg()

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

Add a variable (or macro) file name argument to the condor job. The
argument is added to the submit file and a different value of the
argument can be set for each node in the DAG. The file name is also
added to the list of input files for the DAX.
@param filename: name of option to add.

Definition at line 957 of file pipeline.py.

◆ add_file_opt()

python.pipeline.CondorDAGNode.add_file_opt	(	self,
		opt,
		filename,
		file_is_output_file = False )

Add a variable (macro) option for this node. If the option
specified does not exist in the CondorJob, it is added so the submit
file will be correct when written. The value of the option is also
added to the list of input files for the DAX.
@param opt: option name.
@param value: value of the option for this node in the DAG.
@param file_is_output_file: A boolean if the file will be an output file
instead of an input file.  The default is to have it be an input.

Definition at line 931 of file pipeline.py.

◆ add_input_file()

python.pipeline.CondorDAGNode.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 776 of file pipeline.py.

◆ add_input_macro()

python.pipeline.CondorDAGNode.add_input_macro	(		self,
			filename )

Add a variable (macro) for storing the input files associated with
this node.
@param filename: filename of input file

Definition at line 878 of file pipeline.py.

◆ add_io_macro()

python.pipeline.CondorDAGNode.add_io_macro	(	self,
		io,
		filename )

Add a variable (macro) for storing the input/output files associated
with this node.
@param io: macroinput or macrooutput
@param filename: filename of input/output file

Definition at line 864 of file pipeline.py.

◆ add_macro()

python.pipeline.CondorDAGNode.add_macro	(	self,
		name,
		value )

Add a variable (macro) for this node.  This can be different for
each node in the DAG, even if they use the same CondorJob.  Within
the CondorJob, the value of the macro can be referenced as
'$(name)' -- for instance, to define a unique output or error file
for each node.
@param name: macro name.
@param value: value of the macro for this node in the DAG

Definition at line 851 of file pipeline.py.

◆ add_output_file()

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

Add filename as a output file for this DAG node.

@param filename: output filename to add

Definition at line 788 of file pipeline.py.

◆ add_output_macro()

python.pipeline.CondorDAGNode.add_output_macro	(		self,
			filename )

Add a variable (macro) for storing the output files associated with
this node.
@param filename: filename of output file

Definition at line 886 of file pipeline.py.

◆ add_parent()

python.pipeline.CondorDAGNode.add_parent	(		self,
			node )

Add a parent to this node. This node will not be executed until the
parent node has run sucessfully.
@param node: CondorDAGNode to add as a parent.

Definition at line 1092 of file pipeline.py.

◆ add_post_script_arg()

python.pipeline.CondorDAGNode.add_post_script_arg	(		self,
			arg )

Adds an argument to the post script that is executed before the DAG node is
run.

Definition at line 726 of file pipeline.py.

◆ add_pre_script_arg()

python.pipeline.CondorDAGNode.add_pre_script_arg	(		self,
			arg )

Adds an argument to the pre script that is executed before the DAG node is
run.

Definition at line 703 of file pipeline.py.

◆ add_var_arg()

python.pipeline.CondorDAGNode.add_var_arg	(	self,
		arg,
		quote = False )

Add a variable (or macro) argument to the condor job. The argument is
added to the submit file and a different value of the argument can be set
for each node in the DAG.
@param arg: name of option to add.

Definition at line 946 of file pipeline.py.

◆ add_var_condor_cmd()

python.pipeline.CondorDAGNode.add_var_condor_cmd	(	self,
		command,
		value )

Add a variable (macro) condor command for this node. If the command
specified does not exist in the CondorJob, it is added so the submit file
will be correct.
PLEASE NOTE: AS with other add_var commands, the variable must be set for
all nodes that use the CondorJob instance.
@param command: command name
@param value: Value of the command for this node in the DAG/DAX.

Definition at line 905 of file pipeline.py.

◆ add_var_opt()

python.pipeline.CondorDAGNode.add_var_opt	(	self,
		opt,
		value,
		short = False )

Add a variable (macro) option for this node. If the option
specified does not exist in the CondorJob, it is added so the submit
file will be correct when written.
@param opt: option name.
@param value: value of the option for this node in the DAG.

Definition at line 919 of file pipeline.py.

◆ finalize()

python.pipeline.CondorDAGNode.finalize ( self )

The finalize method of a node is called before the node is
finally added to the DAG and can be overridden to do any last
minute clean up (such as setting extra command line arguments)

Definition at line 1172 of file pipeline.py.

◆ get_args()

python.pipeline.CondorDAGNode.get_args ( self )

Return the arguments for this node. Note that this returns
only the arguments for this instance of the node and not those
associated with the underlying job template.

Definition at line 968 of file pipeline.py.

◆ get_category()

python.pipeline.CondorDAGNode.get_category ( self )

Get the category for this node in the DAG.

Definition at line 758 of file pipeline.py.

◆ get_checkpoint_files()

python.pipeline.CondorDAGNode.get_checkpoint_files ( self )

Return a list of checkpoint files for this DAG node and its job.

Definition at line 829 of file pipeline.py.

◆ get_cmd_line()

python.pipeline.CondorDAGNode.get_cmd_line ( self )

Return the full command line that will be used when this node
is run by DAGman.

Definition at line 1159 of file pipeline.py.

◆ get_cmd_tuple_list()

python.pipeline.CondorDAGNode.get_cmd_tuple_list ( self )

Return a list of tuples containg the command line arguments

Definition at line 1102 of file pipeline.py.

◆ get_input_files()

python.pipeline.CondorDAGNode.get_input_files ( self )

Return list of input files for this DAG node and its job.

Definition at line 811 of file pipeline.py.

◆ get_name()

python.pipeline.CondorDAGNode.get_name ( self )

Get the name for this node in the DAG.

Definition at line 746 of file pipeline.py.

◆ get_opts()

python.pipeline.CondorDAGNode.get_opts ( self )

Return the opts for this node. Note that this returns only
the options for this instance of the node and not those
associated with the underlying job template.

Definition at line 897 of file pipeline.py.

◆ get_output_files()

python.pipeline.CondorDAGNode.get_output_files ( self )

Return list of output files for this DAG node and its job.

Definition at line 820 of file pipeline.py.

◆ get_post_script()

python.pipeline.CondorDAGNode.get_post_script ( self )

returns the name of the post script that is executed before the DAG node is
run.
@param script: path to script

Definition at line 718 of file pipeline.py.

◆ get_post_script_arg()

python.pipeline.CondorDAGNode.get_post_script_arg ( self )

Returns and array of arguments to the post script that is executed before
the DAG node is run.

Definition at line 733 of file pipeline.py.

◆ get_priority()

python.pipeline.CondorDAGNode.get_priority ( self )

Get the priority for this node in the DAG.

Definition at line 770 of file pipeline.py.

◆ get_retry()

python.pipeline.CondorDAGNode.get_retry ( self )

Return the number of times that this node in the DAG should retry.
@param retry: number of times to retry node.

Definition at line 983 of file pipeline.py.

◆ get_vds_group()

python.pipeline.CondorDAGNode.get_vds_group ( self )

Returns the VDS group key for this node

Definition at line 845 of file pipeline.py.

◆ job()

python.pipeline.CondorDAGNode.job ( self )

Return the CondorJob that this node is associated with.

Definition at line 689 of file pipeline.py.

◆ set_category()

python.pipeline.CondorDAGNode.set_category	(		self,
			category )

Set the category for this node in the DAG.

Definition at line 752 of file pipeline.py.

◆ set_log_file()

python.pipeline.CondorDAGNode.set_log_file	(		self,
			log )

Set the Condor log file to be used by this CondorJob.
@param log: path of Condor log file.

Definition at line 1085 of file pipeline.py.

◆ set_name()

python.pipeline.CondorDAGNode.set_name	(		self,
			name )

Set the name for this node in the DAG.

Definition at line 740 of file pipeline.py.

◆ set_post_script()

python.pipeline.CondorDAGNode.set_post_script	(		self,
			script )

Sets the name of the post script that is executed before the DAG node is
run.
@param script: path to script

Definition at line 710 of file pipeline.py.

◆ set_pre_script()

python.pipeline.CondorDAGNode.set_pre_script	(		self,
			script )

Sets the name of the pre script that is executed before the DAG node is
run.
@param script: path to script

Definition at line 695 of file pipeline.py.

◆ set_priority()

python.pipeline.CondorDAGNode.set_priority	(		self,
			priority )

Set the priority for this node in the DAG.

Definition at line 764 of file pipeline.py.

◆ set_retry()

python.pipeline.CondorDAGNode.set_retry	(		self,
			retry )

Set the number of times that this node in the DAG should retry.
@param retry: number of times to retry node.

Definition at line 976 of file pipeline.py.

◆ set_vds_group()

python.pipeline.CondorDAGNode.set_vds_group	(		self,
			group )

Set the name of the VDS group key when generating a DAX
@param group: name of group for thus nore

Definition at line 838 of file pipeline.py.

◆ write_category()

python.pipeline.CondorDAGNode.write_category	(		self,
			fh )

Write the DAG entry for this node's category to the DAG file descriptor.
@param fh: descriptor of open DAG file.

Definition at line 1008 of file pipeline.py.

◆ write_input_files()

python.pipeline.CondorDAGNode.write_input_files	(		self,
			fh )

Write as a comment into the DAG file the list of input files
for this DAG node.

@param fh: descriptor of open DAG file.

Definition at line 1065 of file pipeline.py.

◆ write_job()

python.pipeline.CondorDAGNode.write_job	(		self,
			fh )

Write the DAG entry for this node's job to the DAG file descriptor.
@param fh: descriptor of open DAG file.

Definition at line 990 of file pipeline.py.

◆ write_output_files()

python.pipeline.CondorDAGNode.write_output_files	(		self,
			fh )

Write as a comment into the DAG file the list of output files
for this DAG node.

@param fh: descriptor of open DAG file.

Definition at line 1075 of file pipeline.py.

◆ write_parents()

python.pipeline.CondorDAGNode.write_parents	(		self,
			fh )

Write the parent/child relations for this job to the DAG file descriptor.
@param fh: descriptor of open DAG file.

Definition at line 1039 of file pipeline.py.

◆ write_post_script()

python.pipeline.CondorDAGNode.write_post_script	(		self,
			fh )

Write the post script for the job, if there is one
@param fh: descriptor of open DAG file.

Definition at line 1056 of file pipeline.py.

◆ write_pre_script()

python.pipeline.CondorDAGNode.write_pre_script	(		self,
			fh )

Write the pre script for the job, if there is one
@param fh: descriptor of open DAG file.

Definition at line 1047 of file pipeline.py.

◆ write_priority()

python.pipeline.CondorDAGNode.write_priority	(		self,
			fh )

Write the DAG entry for this node's priority to the DAG file descriptor.
@param fh: descriptor of open DAG file.

Definition at line 1015 of file pipeline.py.

◆ write_vars()

python.pipeline.CondorDAGNode.write_vars	(		self,
			fh )

Write the variable (macro) options and arguments to the DAG file
descriptor.
@param fh: descriptor of open DAG file.

Definition at line 1022 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