ExpFileSystemConfig

Name

ExpFileSystemConfig -- Configuration cluster for event directory tree

Synopsis

package require ExpFileSystemConfig

::ExpFileSystemConfig::setDefaults

::ExpFileSystemConfig::environmentOverrides

::ExpFileSystemConfig::getStageArea

::ExpFileSystemConfig::getExperimentDirectory

DESCRIPTION

This cluster of configuration options is built on top of the Configuration package. Commands have been defined to initialize the variables supplied by this system to default values and to process environment variable overrides to those defaults. In addition to the normal get and Set methods supplied by the Configuration package, this package also provides convenience commands to fetch specific configuration options.

COMMANDS

::ExpFileSystemConfig::setDefaults

Set the configuration variables to their default values. Note that this is done by the readout GUI automatically. Only call this if you want to reinitialize these configuration values.

::ExpFileSystemConfig::environmentOverrides

Applies environment variables to the configuration values. See ENVIRONMENT below for information about the environment variables that drive this command.

::ExpFileSystemConfig::getStageArea

Returns the path to the top level directory of the directory tree that contains the event data and its metadata.

::ExpFileSystemConfig::getExperimentDirectory

Returns the path to the top level of the directory tree that contains the event metadata (run directories).

DEFAULTS

The defaults are as follows:

StageArea

The stage area default is set to ~/stagearea this is usually a symbolic link to the real stage area.

Experiment

The experiment meta data directory defaults to ~/experiment this is normally a symbolic link to ~/stagearea/experiment.

ENVIRONMENT

The following environment variables override default values for the configuration variables:

EVENTS

The value of this environment variable overrides the Stage area default

EXPDIR

The value of this environment variable overrides the Experiment metadata default value.