Running the Test Scripts

Once a consistent set of the OSA software, IC, CAT and the test data packages has been successfully installed, the available test scripts can be used to verify the correct installation, set-up and functioning of the INTEGRAL Off-line Scientific Analysis.

To do that, the following command sequence should be followed. Here, we report only the commands for the csh-family, but they can be easily ported for the sh-family by substituing setenv VAR VALUE with setenv VAR=VALUE.

1. setenv ISDC_ENV __directory_of_OSA_SW_installation__
   the ``_directory_of_OSA_SW_installation'' can be, e.g., ``/opt/osa/''
2. setenv ISDC_REF_CAT __DOL_of_the_reference_catalogue__
   
   e.g. ``__directory_of_cat_installation__/cat/hec/gnrl_refr_cat_0043.fits[1]'' The double-quotes (``'') are important if you are using a shell of the csh-family. Otherwise the shell will try to interpret the [1] as a regular expression.

3. setenv ISDC_OMC_CAT __DOL_of_the_OMC_catalogue__
   
   e.g. ``__directory_of_cat_installation__/cat/omc/omc_refr_cat_0005.fits[1]'' The double-quotes (``'') are again important (see above).

4. setenv REP_BASE_PROD __TEST_DATA_install_dir__/testdata
5. source $ISDC_ENV/bin/isdc_init_env.csh
   for sh-family, use
   . $ISDC_ENV/bin/isdc_init_env.sh The `source' or the leading `.' are important!

6. cd __TEST_DATA_install_dir__/testdata
7. Make a symbolic link to the ic and idx locations on your system
8. ln -s _my_location/ic
9. ln -s _my_location/idx
10. cd ..
11. It is always a good idea to remove old parameter files that are stored in your user pfiles directory - usually the pfiles subdirectory in your home directory. You actually only need to remove the entry-level parameter files, ibis_science_analysis.par, jemx_science_analysis.par, omc_science_analysis.par or spi_science_analysis.par

12. make test INSTR=instr
    instr should be either ibis, picsit, jemx, spi or omc to perform the test for a specific instrument.¹
13. make dircmp INSTR=instr
    - optional. See below for details.
    instr should be either ibis, picsit, jemx, spi or omc to verify the test for a specific instrument.

The ``make test INSTR=instr'' command will run the data analysis for the test observation. If you have the FTOOL fdiff available on your system, you may run as well the ``make dircmp INSTR=instr'' command. A comparison of the output data of the current test run with the reference output data will be performed. The reference output data is included in the OSA test data package in the directory `instr_outref'. It was generated running OSA on a 64-bit Linux platform. The make test command should exit with a return code of 0. Users may check the return code by typing echo `$?' immediately after the make test or make dircmp command.

If make test terminated with an error and you cannot figure out the problem yourself, please consult the 'Frequently Asked Questions' at http://www.isdc.unige.ch/integral/analysis#FAQ to check for a solution to your problem or send an E-mail to the INTEGRAL help-desk at mailto:inthelp@rssd.esa.intinthelp@sciops.esa.int. See the appendix on `Troubleshooting' for information you should provide to help us solving the problem you have.

We have introduced a test also for running trough the docker container. First make sure that docker is installed on your system (see the following section). Then, you need to define just two enviromental variables

• setenv REP_BASE_PROD __TEST_DATA_install_dir__/testdata
• setenv CURRENT_IC __IC_TREE_install_dir__

Then, you can run the scripts: make test INSTR=instrdocker
instr should be either ibis, jemx, spi or omc to verify the test for a specific instrument.