gstlal 1.13.0
Loading...
Searching...
No Matches
python.pipeline.CondorDAG Class Reference
Inheritance diagram for python.pipeline.CondorDAG:
Collaboration diagram for python.pipeline.CondorDAG:

Public Member Functions

 __init__ (self, log)
 get_nodes (self)
 get_jobs (self)
 set_integer_node_names (self)
 set_dag_file (self, path)
 get_dag_file (self)
 add_node (self, node)
 add_maxjobs_category (self, categoryName, maxJobsNum)
 get_maxjobs_categories (self)
 write_maxjobs (self, fh, category)
 write_sub_files (self)
 write_concrete_dag (self)
 write_dag (self)
 write_script (self)

Detailed Description

A CondorDAG is a Condor Directed Acyclic Graph that describes a collection
of Condor jobs and the order in which to run them. All Condor jobs in the
DAG must write their Codor logs to the same file.
NOTE: The log file must not be on an NFS mounted system as the Condor jobs
must be able to get an exclusive file lock on the log file.

Definition at line 1236 of file pipeline.py.

Constructor & Destructor Documentation

◆ __init__()

python.pipeline.CondorDAG.__init__ ( self,
log )
@param log: path to log file which must not be on an NFS mounted file system.

Definition at line 1244 of file pipeline.py.

Member Function Documentation

◆ add_maxjobs_category()

python.pipeline.CondorDAG.add_maxjobs_category ( self,
categoryName,
maxJobsNum )
Add a category to this DAG called categoryName with a maxjobs of maxJobsNum.
@param node: Add (categoryName,maxJobsNum) tuple to CondorDAG.__maxjobs_categories.

Definition at line 1310 of file pipeline.py.

◆ add_node()

python.pipeline.CondorDAG.add_node ( self,
node )
Add a CondorDAGNode to this DAG. The CondorJob that the node uses is
also added to the list of Condor jobs in the DAG so that a list of the
submit files needed by the DAG can be maintained. Each unique CondorJob
will be added once to prevent duplicate submit files being written.
@param node: CondorDAGNode to add to the CondorDAG.

Reimplemented in python.dagparts.DAG, and python.dags.util.DAG.

Definition at line 1291 of file pipeline.py.

◆ get_dag_file()

python.pipeline.CondorDAG.get_dag_file ( self)
Return the path to the DAG file.

Definition at line 1282 of file pipeline.py.

◆ get_jobs()

python.pipeline.CondorDAG.get_jobs ( self)
Return a list containing all the jobs in the DAG

Definition at line 1263 of file pipeline.py.

◆ get_maxjobs_categories()

python.pipeline.CondorDAG.get_maxjobs_categories ( self)
Return an array of tuples containing (categoryName,maxJobsNum)

Definition at line 1317 of file pipeline.py.

◆ get_nodes()

python.pipeline.CondorDAG.get_nodes ( self)
Return a list containing all the nodes in the DAG

Definition at line 1257 of file pipeline.py.

◆ set_dag_file()

python.pipeline.CondorDAG.set_dag_file ( self,
path )
Set the name of the file into which the DAG is written.
@param path: path to DAG file.

Definition at line 1275 of file pipeline.py.

◆ set_integer_node_names()

python.pipeline.CondorDAG.set_integer_node_names ( self)
Use integer node names for the DAG

Definition at line 1269 of file pipeline.py.

◆ write_concrete_dag()

python.pipeline.CondorDAG.write_concrete_dag ( self)
Write all the nodes in the DAG to the DAG file.

Definition at line 1343 of file pipeline.py.

◆ write_dag()

python.pipeline.CondorDAG.write_dag ( self)
Write a dag.

Definition at line 1370 of file pipeline.py.

◆ write_maxjobs()

python.pipeline.CondorDAG.write_maxjobs ( self,
fh,
category )
Write the DAG entry for this category's maxjobs to the DAG file descriptor.
@param fh: descriptor of open DAG file.
@param category: tuple containing type of jobs to set a maxjobs limit for
    and the maximum number of jobs of that type to run at once.

Definition at line 1323 of file pipeline.py.

◆ write_script()

python.pipeline.CondorDAG.write_script ( self)
Write the workflow to a script (.sh instead of .dag).

Assuming that parents were added to the DAG before their children,
dependencies should be handled correctly.

Definition at line 1379 of file pipeline.py.

◆ write_sub_files()

python.pipeline.CondorDAG.write_sub_files ( self)
Write all the submit files used by the dag to disk. Each submit file is
written to the file name set in the CondorJob.

Definition at line 1332 of file pipeline.py.


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