next up previous contents
Next: Data Analysis Up: OSA Introduction Manual Previous: Known limitations of the   Contents

Setting up the environment

This section describes how to set up the environment to successfully run the ISDC software.

The following environment variables need to be set by the user before running any ISDC software:

  1. ROOTSYS

    This environment variable has to point to the location where the ROOT software package used for OSA is installed.

    In general, the ROOTSYS directory will at least contain the following subdirectories:

    If you are not sure about your local ROOT installation, contact your system administrator. The ROOT software package can be downloaded from the ISDC WWW pages at the following URL: http://www.isdc.unige.ch/integral/analysis#Software

  2. ISDC_ENV

    This environment variable has to point to the location where the ISDC Off-line Scientific Analysis Software is installed.

    In general, the ISDC_ENV directory will at least contain the following subdirectories:

    The ISDC Off-line Scientific Analysis software package can be downloaded from the ISDC WWW pages at the following URL: http://www.isdc.unige.ch/integral/analysis#Software

  3. REP_BASE_PROD

    This environment variable has to point to an ISDC compliant data repository, i.e. the location where the ISDC Data and Instrument Characteristics packages are installed.

    In general the REP_BASE_PROD directory will at least contain the following subdirectories (or symbolic links):

    The ISDC Instrument Characteristics package can be downloaded from the ISDC WWW pages at the following URL: http://www.isdc.unige.ch/integral/analysis#Software

  4. ISDC_REF_CAT

    This environment variable has to contain the `Data Object Locator' (DOL) of the ISDC Catalog. For the description of a DOL see the section on `INTEGRAL Data' of this document.

    An example could be $REP_BASE_PROD/cat/hec/gnrl_refr_cat_0033.fits

    Note:
    You should type echo "$ISDC_REF_CAT" to verify the setting of this environment variable. The double quotes (") are significant.

    The ISDC Catalog can be obtained from the following URL:
    http://www.isdc.unige.ch/integral/analysis#Software

Execute
setenv my_variable "value"
to set an environment variable with the name my_variable to the value my_value. The double quotes (") may be significant in some cases, so it is always good to use double quotes.
If the setenv command fails with a message like: `setenv: command not found' or `setenv: not found', you are very likely not using a command interpreter (shell) of a C-Shell flavour (e.g., csh or tcsh). Please replace the single command
setenv my_variable my_value
by the following command sequence
my_variable=my_value ; export my_variable

Warning:
No blank characters must be present in the my_variable=my_value command. Otherwise you will get an error message like my_variable not found.


When these four environment variables are set, the following script should be executed to complete the set-up:
source $ISDC_ENV/bin/isdc_init_env.csh

You should see no errors or warning messages from this script.

To learn more about this script in general, its warning and error messages and the error recovery, type:

source $ISDC_ENV/bin/isdc_init_env.csh help

After the successful completion of the isdc_init_env script the environment is ready to run the ISDC software. Please see the cookbook sections of the instrument specific Analysis User Manual for details on how to run the ISDC Off-line Scientific Analysis Software.

If the source command fails with a message like: 'source: not found' or you get many error messages indication that the command actually failed, you are very likely not using a command interpreter (shell) of a C-Shell flavour (e.g., csh or tcsh). Please replace the single command
source $ISDC ENV/bin/isdc_init_env.csh
by the following single command
. $ISDC ENV/bin/isdc_init_env.sh

Warning:
You really must type the `.' followed by a blank character before the name of the script. Otherwise the setting of the environment variables inside the script will not be kept after the script terminated.
In addition, make sure to replace the script extension .csh by .sh


next up previous contents
Next: Data Analysis Up: OSA Introduction Manual Previous: Known limitations of the   Contents
inthelp@sciops.esa.int