2 SCUBA-2 Pipeline Variants

 2.1 Requirements for running the SCUBA-2 pipeline
 2.2 Important environment variables
 2.3 Getting help

There are three variants of the SCUBA-2 pipeline, users will likly only need to run the science pipeline. The other two pipelines are designed to run in real time at the JCMT.

2.1 Requirements for running the SCUBA-2 pipeline

The SCUBA-2 pipeline requires a recent Starlink installation. The latest version may be obtained from http://starlink.eao.hawaii.edu/starlink. Since development of the pipeline is an ongoing process, it is recommended that the newest builds be used to access the full capabilities of the pipeline. These builds can be obtained from
http://starlink.eao.hawaii.edu/starlink/rsyncStarlink and may be kept up-to-date with rsync.

The Starlink Perl installation (Starperl) must be used to run the pipeline due to the module requirements. The Starlink environment should be initialized as usual before running Orac-dr.

The software used to process raw data into images is called the SubMillimetre User Reduction Facility (Smurf). Detailed documentation on Smurf can be found in SUN/258, while SC/21 is a cookbook that describes some of the background to SCUBA-2 data reduction.

The pipeline uses the following Starlink applications:

2.2 Important environment variables

The pipeline uses a number of environment variables to determine where data should be read from and written to. Some are set automatically when the pipeline is initialized, but they can be overridden manually and, with the -honour flag may be left unchanged between successive runs of the pipeline. The variables that must be defined in order for the pipeline to run are denoted as ‘Mandatory’ in the list below.

As an example, to set up or override the pipeline environment variables, tcsh users will need to do:

  % setenv ORAC_DATA_IN folder1
  % setenv ORAC_DATA_OUT folder2

and bash users will need to do:

  $ export ORAC_DATA_IN=folder1
  $ export ORAC_DATA_OUT=folder2

2.3 Getting help

Basic help and a list of command-line options may be obtained after initializing Orac-dr by running :

  % oracdr -h


  % oracdr -man

More complete documentation on Orac-dr can be found in SUN/230.