INTEGRAL Science Data Center (ISDC)
                    ===================================

                         http://isdc.unige.ch


                             Release Note
                             ============


      Package:      new_spi_coeff
      Version:      7.0
      Rel. Date:    4-January-2024


Contents
========

   1. Introduction
   2. Instructions
   3. Portability
   4. System Requirements
   5. Changes since last Release


1. Introduction
   ============
   
   The INTEGRAL/SPI instrument and ISDC teams noticed inaccurate gain
   coefficients affecting a few SPI detectors in some revolutions after 1150.

   The "new_spi_coeff" package allows to use updated gain coefficients by the SPI
   data analysis programs "spi_science_analysis" and "spimodfit_analysis".
   
   This package contains two Shell scripts and a directory "new_scw" including
   updated "spi_gain_coeff.fits.gz" stored per spacecraft revolution number
   following the usual directory structure of INTEGRAL data.
   
   The two scripts allow the user to either:
     1. substitute the original "spi_gain_coeff.fits.gz" files by updated ones
     2. create an index file pointing to the updated files.
   
	The first method should be preferred for local copies of the INTEGRAL data
	archive. The analysis of data from a given revolution will make use of the
	new coefficients in a straightforward way. Read and write permission on the
	files is required. 

    The second method is intended for protected INTEGRAL archives for which the
    user does not have modification rights. An index file has to be created for
    the analysis of a given Observation Group which includes revolutions
    containing incorrect gain coefficients.


2. Instructions
   ============

   Method 1 (replacement of the original "spi_gain_coeff.fits.gz" files)
   --------
    1) Unpack the provided tar file:
       gzip -dc new_spi_coeff.tar.gz | tar xvf -
    2) Go to the new directory "new_spi_coeff":
       cd new_spi_coeff/
    3) Make the script "replace_coeff.sh" executable with:
       chmod +x replace_coeff.sh
    4) Identify the location of the existing ScW archive ( local_scw_path )
       in the local system (e.g. /isdc/arc/rev_3/scw )
    5) Run the script as:
       replace_coeff.sh  local_scw_path  new_scw

   Method 2 (creation of an index file pointing to the updated files)
   --------
    1) Unpack the provided tar file:
       gzip -dc new_spi_coeff.tar.gz | tar xvf -
    2) Go to the new directory "new_spi_coeff":
       cd new_spi_coeff/
    3) Make the script "create_new_idx.sh" executable with:
       chmod +x create_new_idx.sh
    4) Identify the location of the existing ScW archive ( local_scw_path )
       in the local system (e.g. /isdc/arc/rev_3/scw )
    5) Identify the directory path where to store the new index file that will
       be created ( path_to_new_index_file ).
    6) Run the script as:
       create_new_idx.sh  local_scw_path  new_scw  path_to_new_index_file
    7) Specify the newly created file "new_spi_gain_coeff.fits" with its full
       directory path ( path_to_new_index_file ) as the parameter "coeff_DOL"
       in your SPI analysis. In the Graphical User Interface (GUI) this
       parameter is referred to as "Gain Coefficient file name".


3. Portability
   ===========

   Not applicable


4. System Requirements
   ===================
    
   Not applicable


5. Changes since last Release
   ==========================

   ============	
   
   version 7.0
   
   ============

   Version 7.0 (4-January-2024) contains updated SPI gain coefficients for
   spacecraft revolutions 2691 to 2721.


   ============	
   
   version 6.0
   
   ============

   Version 6.0 (10-November-2021) contains updated SPI gain coefficients for
   spacecraft revolutions 2387 to 2431.


   ============	
   
   version 5.0
   
   ============

   Version 5.0 (03-August-2020) contains updated SPI gain coefficients for
   spacecraft revolutions 1973 to 2241 (during rev. 2238-2241, a 
   change of voltage causes the old coefficient to be inaccurate)


   ============	
   
   version 4.0
   
   ============

   Version 4.0 (27-August-2018) contains updated SPI gain coefficients for
   spacecraft revolutions 1973 to 1978


   ============
   
   version 3.0
   
   ============

   Version 3.0 (21-January-2017) contains updated SPI gain coefficients for
   spacecraft revolutions 1150 to 1770

   ============
   
   version 2.0
   
   ============

   Version 2.0 (29-August-2014) contains updated SPI gain coefficients for
   spacecraft revolutions 1150 to 1449

   ============
   
   version 1.0
   
   ============

   Version 1.0 (3-Jul-2013) contains updated SPI gain coefficients for
   spacecraft revolutions 1150 to 1280