4.4 SCIRun's Initialization File--.scirunrc

SCIRun processes .scirunrc file on startup. File .scirunrc contains assignments to environment variables that affect SCIRun's behavior. Lines beginning with '#' are ignored.

When started by a user the first time, SCIRun creates a default version of .scirunrc in the user's home directory. Users may modify their default .scirunrc file.

Users may also set SCIRun related environment variables in their shell. Values of variables set in the shell override values set in .scirunrc.

See the content of .scirunrc for a complete list of SCIRun related environment variables. The following is a partial list of variables understood by SCIRun:

SCIRUN_ON_THE_FLY_LIBS_DIR

SCIRUN_ON_THE_FLY_LIBS_DIR specifies the location of dynamically generated code (see Dynamic Compilation for details on the meaning and use of this variable). Users shouldn't need to change the default value (˜/on-the-fly-libs) of this variable.

SCIRUN_CONFIRM_OVERWRITE

SCIRUN_CONFIRM_OVERWRITE determines the default behavior of file saving operations. If set to 1, the user is asked to confirm a save operation if an existing file would be overwritten. If set to 0 then the user is not asked for confirmation. SCIRUN_CONFIRM_OVERWRITE's default value is 1.

SCIRUN_DATA, SCIRUN_DATASET

These two variables specify the complete path to a SCIRun data set. A data set is a collection of SCIRun type data fields, matrices, etc. that are stored in a directory and used in SCIRun networks.

SCIRUN_DATA specifies a directory that contains a collection of data set directories. SCIRUN_DATA is used in conjunction with SCIRUN_DATASET to specify the full path of a data set. SCIRUN_DATASET specifies a specific data set directory.

When working with the sample SCIRun data sets, for example, SCIRUN_DATA is set to /usr/local/SCIRunData (assuming this is where SCIRun's sample data were installed). SCIRUN_DATASET can then be set to utahtorso to specify the Utah Torso data set.

SCIRUN_NET_SUBSTITUTE_DATADIR

When saving a network containing a reader or writer module, SCIRun normally records (in the network file) the absolute pathname of a reader/writer module's chosen file. If SCIRUN_NET_SUBSTITUTE_DATADIR is set to 1 and if a reader/writer module is set to read/write from/to a file in $SCIRUN_DATA/$SCIRUN_DATASET then SCIRun will record a filename whose path will be determined by future values of SCIRUN_DATA and SCIRUN_DATASET. The default value of SCIRUN_NET_SUBSTITUTE_DATADIR is 0.

SCIRUN_TMP_DIR

SCIRUN_TMP_DIR specifies the directory where SCIRun will create temporary files. It's default value is /tmp.

SCIRUN_LOAD_PACKAGE

SCIRUN_LOAD_PACKAGE is a comma separated list of packages SCIRun is to load upon startup. Normally SCIRun loads all installed packages. To load, for example, only the BioPSE and Teem packages: SCIRUN_LOAD_PACKAGE=BioPSE,Teem.

SCIRUN_NOSPLASH

If SCIRUN_NOSPLASH is set to 1, then SCIRun will not display its splash screen at startup. The default value is 0.

SCIRUN_HIDE_PROGRESS

If SCIRUN_HIDE_PROGRESS is set to 1, SCIRun will not display progress bars during startup. The default value is 0.

SCIRUN_STRAIGHT_CONNECTIONS

If SCIRUN_STRAIGHT_CONNECTIONS is set to 1, SCIRun will draw straight connections between modules in the Network Editor. The default value of SCIRUN_STRAIGHT_CONNECTIONS is 0.

SCIRUN_FAST_QUIT

If defined, disables the confirmation dialog that is normally displayed when exiting SCIRun.

SCIRUN_MPEG_LICENSE_ACCEPT

MPEG software is freely distributed with SCIRun and may be used for any non-commercial purpose. However, patents are held by several companies on various aspects of the MPEG video standard. Companies or individuals who want to develop commercial products that include this code must acquire licenses from these companies. For information on licensing, see Appendix F in the standard. For more information, please see the README file in the mpeg_encode distribution. If you are allowed to use the MPEG functionality based on the above license, you may enable MPEG movie recording in SCIRun (accessible via the SCIRun Viewer's "File->Record Movie" menu) by setting the value of SCIRUN_MPEG_LICENSE_ACCEPT to "true".