11. Environment variables

ADiMat uses some enviromnent variables to customize its behaviour. The directory where the additional data is installed may be modified using the ADIMAT_HOME environment variable, for example. If the variables introduced here are not set on the machine, then default values will be used.

Currently these environment variables are used to customize the behaviour of ADiMat:

${ADIMAT_HOME}

Specify the path where the ADiMat is installed. The default value is: '/usr/local' on Linux and Unix and 'c:/adimat' on Windows. In particular the binary programs reside in '${ADIMAT_HOME}/bin'.

${ADIMAT_USER_HOME}

Specify the path user information is found. The default is '${HOME}/.adimat/' on Linux and Unix. On Windows, the default is '<appdata>/ADiMat/', where <appdata> is determined as follows: First the APPDATA folder is searched through the Windows API, then '${APPDATA}' is evaluated, and finally '${HOMEDRIVE}${HOMEPATH}', which defaults to 'c:\'

${ADIMAT_BUILTINSPATH}

ADiMat looks up the file 'ADiMat.amdb' in this path. The first occurrence , of this file is used (see section builtins for further information). The default path is: '${ADIMAT_HOME}/share/adimat:${HOME}/.adimat:. ' on Unix systems and '${ADIMAT_HOME}/builtins' on Windows systems.

${ADIMAT_DERIV_CLASSPATH}

${ADIMAT_DERIVCLASS}

The ADiMat_startup script provided with this distribution uses this variable to set the derivative class. Note you can also use the adimat_derivclass function after Matlab has started (see runtime functions).

${ADIMAT_ADJOINT}

The ADiMat_startup script provided with this distribution uses this variable to set the type of adjoints used. Note you can also use the adimat_adjoint function after Matlab has started (see runtime functions).

${ADIMAT_STACK}

The ADiMat_startup script provided with this distribution uses this variable to set the stack implementation used. Note you can also use the adimat_stack function after Matlab has started (see runtime functions).

${ADIMAT_STACK_FILE}

This variable is used by some stack implementations as the name of the file to save values that are pushed on the stack. If this variables is not set, then that file is created in the directory named by ${TMP}.

${ADMTRANSFORM_FLAGS}

This variable is read by admTransform and can be used to add flags to the source transformation command. The default is empty. You can also use the field flags of admOptions. See admTransform and admOptions.

${ADMTRANSFORM_PROGRAM}

This variable is read by admTransform and can be used to set the name of the source transformation program. The default is ${ADIMAT_HOME}/bin/adimat-client. See admTransform.

${ADMTRANSFORM_WRAP}

This variable is read by admTransform and can be used to set the name of the wrapper skript for the source transformation command. On Unix, the default is ${ADIMAT_HOME}bin/admwrap -K <matlabroot>/, where <matlabroot> is the result of the command matlabroot. This wrapper script removes all directories under matlabroot from LD_LIBRARY_PATH. If this is not done, adimat-client find shared libraries from there, which are incompatible. On PCs (Windows) the default is empty. See admTransform.