XNAT Pipeline Engine and core pipelines
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
gradle/wrapper
lib
templates
.gitignore
README.md
build.gradle
gradlew
gradlew.bat
sample.gradle.properties
settings.gradle
setup.bat
setup.sh

README.md

XNAT Pipeline Engine

Version 1.7.2 Neuroinformatics Research Group (http://nrg.wustl.edu), Washington University in Saint Louis

Developers

This repository was copied from a previous repository on Bitbucket, which was itself copied from a different previous repository on Bitbucket.

Installation

This version of the XNAT pipeline engine is built and installed differently from earlier versions. It uses a Gradle-based build script to manage the pipeline resources and dependencies. More importantly, instead of building directly back into the pipeline installation folder, it builds to another destination folder. You can specify the build property destination with the path to the destination folder or just use the default destination, which is the folder build/pipeline in the pipeline build folder.

You can build the pipeline engine by three different methods:

  1. Call the setup.sh or setup.bat script, passing the administrator email, mail server, and XNAT server address as parameters (you can also add the optional XNAT site name parameter):

     ./setup.sh <admin email> <SMTP server> <XNAT url> [XNAT site name] [destination] [modulePath1 modulePath2 modulePath3... modulePathn]
    
     ./setup.sh you@yourlab.org mail.yourlab.org http://xnat.yourlab.org YourXNAT
    
  2. Call the gradlew or gradlew.bat script located in the root folder of the pipeline build, along with values for all of the required and optional build parameters. Note that Gradle build parameters are passed in the form -Pparam=value.

     ./gradlew -PadminEmail=you@yourlab.org -Pdestination=/pipeline/folder \
               -PsiteName=YourXNAT -PxnatUrl=http://xnat.yourlab.org \
               -PsmtpServer=mail.yourlab.org -PmodulePaths=/path1/to/modules,/path2/to/modules
    
  3. Lastly, you can call the gradlew or gradlew.bat script on its own, with all of the values passed on the command line in the previous method now stored in the gradle.properties file. This file just takes the standard properties file format of param=value. There's a sample version of this file already in the build folder named sample.gradle.properties. You can copy that file and fill in your own values as appropriate. This is very useful when developing pipeline modules or other code that requires frequent redeployment.

Customization

The main point of converting the pipeline build to use Gradle is to support pipeline modules. Pipeline modules are collections of code, scripts, and configuration files that can be integrated directly into the pipeline build. The purpose of this README is not to explain how to create custom pipeline modules, however a little information on how modules can be deployed is in order.

Pipeline modules can be placed in a number of locations:

  • In the modules folder located inside the pipeline engine
  • In any of the folders indicated by a path configured with the modulePaths build property

Pipeline modules can be structured in two ways:

  • All folders and files directly under the module folder, using the same structure as the pipeline build. This is a resource-only module, i.e. it has no scripts.
  • All resource folders and files in a folder named resources located under the module folder and all script folders and files in a folder named scripts located under the module folder. Scripts are treated somewhat differently from resources, in that they are renamed with the .bat extension when built on a Windows machine.