This document describes the complete list of environment variables used by the pipeline.
ORAC-DR uses a number of environment variables for configuration.
Users may need to change the following variables before using the software.
ORAC_CAL_ROOT Directory where the instrument-specific
ORAC_DATA_CAL Location of the calibration files for the instrument. Set by the instrument startup script to
ORAC_CAL_ROOT/instrument.
ORAC_DATA_IN Actual location of raw data files. Should be set after the instrument startup script.
ORAC_DATA_OUT Actual location of reduced data files. This is also the working directory of the pipeline. Should be set after the instrument startup script.
ORAC_DATA_ROOT Location of the raw and reduced data directories if it conforms with the naming
convention for the instrument. Should be set before the instrument startup script, which
uses this variable to set ORAC_DATA_IN and ORAC_DATA_OUT.
ORAC_HISTORY_DIR Location of the GAIA .skycat_history log. This is to avoid the monitor clashing with a running pipeline.
ORAC_KAPVIEW_DEV If set, specifies a suffix to use for KAPVIEW device names. This can be used to have multiple runs of the pipeline use the same set of KAPVIEW windows. If not set, a suffix is generated based on the hostname and process ID to avoid conflicts between multiple instances of the pipeline.
ORAC_KEEP If set, all intermediate files created by ORAC-DR will be kept. This does not include
temporary files; to keep temporary files (oractemp*) set ORAC_KEEP to "temp".
ORAC_LOCATION_DIR Specifies a directory to which the location file should be written when processing data for the current day. (This file contains the location of ORAC_DATA_OUT and allows other systems to locate the pipeline’s products.) If not specified, then "/jac_sw/oracdr-locations" is used.
ORAC_NOGROUPS If set, group processing will be disabled.
ORAC_PRIMITIVE_DIR Location of user-defined primitives. These supersede any identically names primitives in
ORAC_DIR/primitives/instrument.
ORACDR_PROXY If set, ORAC-DR will use a proxy for network lookups. This variable should be set to the full proxy name, including the protocol, name, and port. An example of this is "http://proxy.example.com:8181".
ORAC_RECIPE_DIR Location of user-defined recipes. These supersede any identically names recipes in ORAC_DIR/recipes/instrument.
ORACDR_TMP Location of scratch files for the ADAM messaging system. If this environment variable is
not set, then this location will default to ORAC_DATA_OUT.
Starlink and EAO users should not redefine these variables under normal circumstances because they are correctly set by their user logins. They are included here for reference only.
ORAC_DIR The location of the ORAC-DR software directory. This is normally set by a login script.
ORAC_INSTRUMENT The instrument under whose environment ORAC-DR should run. Normally this is set by
the appropriate instrument script in ORAC_DIR/etc/.
ORAC_LOOP The default type of looping scheme that should be used for online reduction of
ORAC_INSTRUMENT. This is used in the splash screen.
ORAC_PERL5LIB The location of the ORAC-DR perl libraries. These are normally in ORAC_DIR/lib/perl5.
ORAC_PERSON The e-mail address of the person who supports ORAC-DR for $ORAC_INSTRUMENT. This is
used in the splash screen. (This was formerly the JAC contact name and assumed a JAC
e-mail address $ORAC_PERSON@jach.hawaii.edu.)
ORAC_SUN The Starlink User Note number that documents the data reduction for ORAC_INSTRUMENT.
This is used in the splash screen.
Original author: frossie