Pipeline Engine is a Java-based framework that links sequential activities, human and computer, into a defined process flow and manages how data moves from step to step in that flow based on the results of each step. In most laboratories, some processes (or pipelines) are carried out automatically without any human intervention while others require a person to do manual steps, such as drawing a region of interest. Pipeline Engine facilitates both fully automated and semi-automated workflows. Pipelines can be executed up to a step, then notify a user(s) to perform the manual task, and finally restart the pipeline from the next step. The process flow is defined in am XML document called the pipeline descriptor and the executables are defined in a separate XML document called resource descriptors.
Pipeline engine is a standalone tool. However, when used with XNAT one can:
The location of <XNAT_HOME> depends on your system configuration. In the default XNAT 1.7 Vagrant machine, this is located in /data/xnat/home
When you install XNAT, pipeline engine is setup for you. By default, the pipeline engine is located in a directory next to XNAT_HOME: /data/xnat/pipeline, which we will call PIPELINE_HOME.
Pipeline engine can be located anywhere on the file system, as long as the PIPELINE_HOME folder has appropriate permissions for the user who launches tomcat and the non-default path to the PIPELINE_HOME should be set using Administer -> More Options -> Default Settings.
If you choose to setup pipeline engine outside XNAT, after downloading the engine, launch
<PIPELINE_HOME>/setup.sh YOUR_ADMIN_EMAIL_ID YOUR_SMTP_SERVER
This step will generate the file <PIPELINE_HOME>/pipeline.config
PIPELINE_EMAIL_ID = email@example.com PIPELINE_SMTP_HOST = your.smtp.server PIPELINE_CATALOG_ROOT_PATH = PATH_TO_CATALOG_FOLDER ADMIN_EMAIL = firstname.lastname@example.org XNAT_SITE = YOUR_SITE_ID
Please refer to the XNAT Pipeline Development Schema developer documentation.
Only site admins can install pipelines in XNAT. Please refer to the admin documentation on Installing Pipelines in XNAT.
Once a pipeline has been installed, any project owner can add it to their project.
Pipelines can be executed in two modes viz. standalone mode using <PIPELINE_HOME>/bin/PipelineRunner or by updating XNAT as the pipeline progresses. In order to update XNAT, use PIPELINE_HOME/bin/XnatPipelineLauncher with appropriate parameters.
User Docs: Running Pipelines In XNAT
Pipeline engine ships with support for Sun Grid Engine (SGE). This is done using the DRMAA API. A site can use its own job scheduling application and integrate it with XNAT/Pipeline Engine by "overloading" the script PIPELINE_HOME/bin/schedule. Out of the box, this script just invokes the command that is passed. PIPELINE_HOME/lib/PipelineClient.jar contains the class org.nrg.pipeline.client.PipelineJobSubmitter which supports scheduling jobs on the SGE.
/Pipeline/resourceRequirements can be used to set resource requirements like Architecture, free memory while submitting the job onto the grid.