Loading [MathJax]/extensions/TeX/AMSsymbols.js
LAL 7.7.0.1-5e288d3
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
lal.pipeline.CondorDAGManNode Class Reference

Detailed Description

Condor DAGMan node class.

Appropriate for setting up DAGs to run within a DAG. Adds the user-tag functionality to condor_dagman processes running in the DAG. May also be used to extend dagman-node specific functionality.

Definition at line 1187 of file pipeline.py.

Inherits lal.pipeline.CondorDAGNode.

Public Member Functions

def __init__ (self, job)
 
def set_user_tag (self, usertag)
 Set the user tag that is passed to the analysis code. More...
 
def get_user_tag (self)
 Returns the usertag string. More...
 
def add_maxjobs_category (self, categoryName, maxJobsNum)
 Add a category to this DAG called categoryName with a maxjobs of maxJobsNum. More...
 
def get_maxjobs_categories (self)
 Return an array of tuples containing (categoryName,maxJobsNum) More...
 
def set_cluster_jobs (self, cluster)
 Set the type of job clustering pegasus can use to collapse jobs. More...
 
def get_cluster_jobs (self)
 Returns the usertag string. More...
 
- Public Member Functions inherited from lal.pipeline.CondorDAGNode
def __init__ (self, job)
 
def __repr__ (self)
 
def job (self)
 Return the CondorJob that this node is associated with. More...
 
def set_pre_script (self, script)
 Sets the name of the pre script that is executed before the DAG node is run. More...
 
def add_pre_script_arg (self, arg)
 Adds an argument to the pre script that is executed before the DAG node is run. More...
 
def set_post_script (self, script)
 Sets the name of the post script that is executed before the DAG node is run. More...
 
def get_post_script (self)
 returns the name of the post script that is executed before the DAG node is run. More...
 
def add_post_script_arg (self, arg)
 Adds an argument to the post script that is executed before the DAG node is run. More...
 
def get_post_script_arg (self)
 Returns and array of arguments to the post script that is executed before the DAG node is run. More...
 
def set_name (self, name)
 Set the name for this node in the DAG. More...
 
def get_name (self)
 Get the name for this node in the DAG. More...
 
def set_category (self, category)
 Set the category for this node in the DAG. More...
 
def get_category (self)
 Get the category for this node in the DAG. More...
 
def set_priority (self, priority)
 Set the priority for this node in the DAG. More...
 
def get_priority (self)
 Get the priority for this node in the DAG. More...
 
def add_input_file (self, filename)
 Add filename as a necessary input file for this DAG node. More...
 
def add_output_file (self, filename)
 Add filename as a output file for this DAG node. More...
 
def add_checkpoint_file (self, filename)
 Add filename as a checkpoint file for this DAG node. More...
 
def get_input_files (self)
 Return list of input files for this DAG node and its job. More...
 
def get_output_files (self)
 Return list of output files for this DAG node and its job. More...
 
def get_checkpoint_files (self)
 Return a list of checkpoint files for this DAG node and its job. More...
 
def set_vds_group (self, group)
 Set the name of the VDS group key when generating a DAX. More...
 
def get_vds_group (self)
 Returns the VDS group key for this node. More...
 
def add_macro (self, name, value)
 Add a variable (macro) for this node. More...
 
def add_io_macro (self, io, filename)
 Add a variable (macro) for storing the input/output files associated with this node. More...
 
def add_input_macro (self, filename)
 Add a variable (macro) for storing the input files associated with this node. More...
 
def add_output_macro (self, filename)
 Add a variable (macro) for storing the output files associated with this node. More...
 
def add_checkpoint_macro (self, filename)
 
def get_opts (self)
 Return the opts for this node. More...
 
def add_var_condor_cmd (self, command, value)
 Add a variable (macro) condor command for this node. More...
 
def add_var_opt (self, opt, value, short=False)
 Add a variable (macro) option for this node. More...
 
def add_file_opt (self, opt, filename, file_is_output_file=False)
 Add a variable (macro) option for this node. More...
 
def add_var_arg (self, arg, quote=False)
 Add a variable (or macro) argument to the condor job. More...
 
def add_file_arg (self, filename)
 Add a variable (or macro) file name argument to the condor job. More...
 
def get_args (self)
 Return the arguments for this node. More...
 
def set_retry (self, retry)
 Set the number of times that this node in the DAG should retry. More...
 
def get_retry (self)
 Return the number of times that this node in the DAG should retry. More...
 
def write_job (self, fh)
 Write the DAG entry for this node's job to the DAG file descriptor. More...
 
def write_category (self, fh)
 Write the DAG entry for this node's category to the DAG file descriptor. More...
 
def write_priority (self, fh)
 Write the DAG entry for this node's priority to the DAG file descriptor. More...
 
def write_vars (self, fh)
 Write the variable (macro) options and arguments to the DAG file descriptor. More...
 
def write_parents (self, fh)
 Write the parent/child relations for this job to the DAG file descriptor. More...
 
def write_pre_script (self, fh)
 Write the pre script for the job, if there is one. More...
 
def write_post_script (self, fh)
 Write the post script for the job, if there is one. More...
 
def write_input_files (self, fh)
 Write as a comment into the DAG file the list of input files for this DAG node. More...
 
def write_output_files (self, fh)
 Write as a comment into the DAG file the list of output files for this DAG node. More...
 
def set_log_file (self, log)
 Set the Condor log file to be used by this CondorJob. More...
 
def add_parent (self, node)
 Add a parent to this node. More...
 
def get_cmd_tuple_list (self)
 Return a list of tuples containg the command line arguments. More...
 
def get_cmd_line (self)
 Return the full command line that will be used when this node is run by DAGman. More...
 
def 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) More...
 

Constructor & Destructor Documentation

◆ __init__()

def lal.pipeline.CondorDAGManNode.__init__ (   self,
  job 
)
Parameters
joba CondorDAGNodeJob

Reimplemented from lal.pipeline.CondorDAGNode.

Definition at line 1191 of file pipeline.py.

Member Function Documentation

◆ set_user_tag()

def lal.pipeline.CondorDAGManNode.set_user_tag (   self,
  usertag 
)

Set the user tag that is passed to the analysis code.

Parameters
usertagthe user tag to identify the job

Definition at line 1201 of file pipeline.py.

◆ get_user_tag()

def lal.pipeline.CondorDAGManNode.get_user_tag (   self)

Returns the usertag string.

Definition at line 1207 of file pipeline.py.

◆ add_maxjobs_category()

def lal.pipeline.CondorDAGManNode.add_maxjobs_category (   self,
  categoryName,
  maxJobsNum 
)

Add a category to this DAG called categoryName with a maxjobs of maxJobsNum.

Parameters
categoryNamecategory name
maxJobsNummax jobs num

Definition at line 1215 of file pipeline.py.

◆ get_maxjobs_categories()

def lal.pipeline.CondorDAGManNode.get_maxjobs_categories (   self)

Return an array of tuples containing (categoryName,maxJobsNum)

Definition at line 1221 of file pipeline.py.

◆ set_cluster_jobs()

def lal.pipeline.CondorDAGManNode.set_cluster_jobs (   self,
  cluster 
)

Set the type of job clustering pegasus can use to collapse jobs.

Parameters
clusterclustering type

Definition at line 1228 of file pipeline.py.

◆ get_cluster_jobs()

def lal.pipeline.CondorDAGManNode.get_cluster_jobs (   self)

Returns the usertag string.

Definition at line 1234 of file pipeline.py.