Added hooks to the pipeline runners.

asimov/pipeline.py

@@ -99,6 +99,24 @@ def detect_completion(self):
         else:
             return False
 
+    def before_submit(self):
+        """
+        Define a hook to run before the DAG file is generated and submitted.
+
+        Note, this method should take no arguments, and should be over-written in the 
+        specific pipeline implementation if required.
+        """
+        pass
+
+    def after_completion(self):
+        """
+        Define a hook to run after the DAG has completed execution successfully.
+
+        Note, this method should take no arguments, and should be over-written in the 
+        specific pipeline implementation if required.
+        """
+        pass
+
     def submit_dag(self):
         """
         Submit a DAG file to the condor cluster.
@@ -124,6 +142,9 @@ def submit_dag(self):
            This will be raised if the pipeline fails to submit the job.
         """
         os.chdir(self.production.rundir)
+
+        self.before_submit()
+
         try:
             command = ["condor_submit_dag",
                                    os.path.join(self.production.rundir, "multidag.dag")]

docs/source/pipelines.rst

@@ -8,7 +8,6 @@ An interface for any pipeline can be constructed, provided that pipeline can be
 
 The ``asimov.pipeline`` module defines the factory classes for these interfaces, and individual interfaces can be found in the ``asimov.pipelines`` module.
 
-
 Adding new pipelines
 --------------------
 
@@ -17,6 +16,22 @@ The most important of these is the ``build_dag`` method, which is used by the as
 
 An example of a complete pipeline interface can be seen in the code for :class:``asimov.pipelines.lalinference.LALinference``.
 
+
+Pipeline hooks
+--------------
+
+It is possible to customise the run process of the asimov pipeline runner using hooks.
+By overloading the hook methods (listed below) inherited from the ``asimov.pipeline.Pipeline`` class additional operations can
+be conducted during the processing workflow.
+Hooks should take no arguments.
+
+Implemented hooks are:
+
+::
+
+   before_submit()    --- Executed immediately before the DAG file for a pipeline is generated.
+   after_completion() --- Executed once execution has successfully completed.
+
 Supported Pipelines
 -------------------