รถ INTEGRAL Science Data Center (ISDC) =================================== http://www.isdc.unige.ch/integral/ Release Note ============ Package: osa_sw Version: 10.0 Rel. Date: 18-Sep-2012 Contents ======== 1. Introduction 2. Portability 3. System Requirements 4. Acknowledgements 5. Changes since last Release 1. Introduction ============ This is the release note for the official ISDC 'Off-line Scientific Analysis' software version 10.0 This release contains instrument specific analysis software for the four INTEGRAL instruments (IBIS, SPI, JEM-X and OMC), and some generic tools. It runs on Linux and Mac OS X Intel platforms. This Release Note gives some portability information and describes system requirements. The software is available to the scientific community as downloadable binary tar files from the ISDC public release page at http://www.isdc.unige.ch/integral/analysis#Software If needed OSA can be compiled and installed from the source code as well. The source code tar file is available via the above URL. Information for user support is available at http://www.isdc.unige.ch/integral/support/helpdesk 2. Portability =========== Binary Packages =============== The software was checked to correctly run on the following platforms: - Linux - CentOS release 5.8 32 and 64 bit - Scientific Linux release 6.1 32 and 64 bit - Mac OS X - 10.6 Snow Leopard (Darwin 10.8.0) - 10.7 Lion (Darwin 11.4.0) The binary OSA software packages were built on the above Mac OS X platforms and on the CentOS 32 and 64 systems. They are ready to use and contain everything you need to run the OSA software. If needed you may compile and link your own software with the libraries included in the binary OSA packages. In general, the OSA software will also run on a variety of other Linux platforms. As we at the ISDC do not necessarily have access to those platforms, we only provide full support for the platforms mentioned above. Depending on the particular choice of your Linux distribution you may miss specific system libraries when running OSA from a binary package. Please let us know in case you require additional libraries. Source Code Package =================== Before you consider building OSA from source, please consider using the supplied binary packages. If you need to build the OSA software from the source code, the following platforms have been tested: - Linux CentOS 32 and 64 bit : GNU C/C++ compiler version 4.4.6 gfortran compiler version 4.4.6 - Mac OS X Mac OS 10.6 (snow leopard) and 10.7 (lion): GNU C/C++ compiler version 4.2.1 G95 Fortran compiler version 4.2.4 3. System Requirements =================== Binary Packages =============== - Linux The OSA software requires as run-time library the libgfortran.so.3 and the libc.so.6 libraries. Please refer to the Installation Guide for more details. - Mac OS X X11 -- if not yet available on your system, you will have to install X11 from e.g. the Mac OS X installation disks. Source Code Package =================== Before compiling and installing the osa_sw version 10 from the source code, you need to make sure that the following packages are installed: - GNU make version 3.79.1 (or higher) - ROOT version 5.32.00 Since OSA version 3.0 you can choose between an installation with and without ROOT. If you choose to install without ROOT, you will NOT benefit from all OSA functionalities, i.e. GUI support is not available. To learn more about how to install OSA without ROOT please see Appendix B section 'Setting up the Environment' of the 'Installation Guide for the INTEGRAL Offline Scientific Analysis' ROOT is available via the ISDC WWW-site at URL: http://www.isdc.unige.ch/integral/osa/current/developers Warning !: For Mac OS X users it is required to install ROOT from the source code. For other operating systems, this is also recommended. If you want to download ROOT as a binary package, you must make sure that the compiler used to compile ROOT is identical to the one you are using for the installation of the OSA SW. Otherwise, please download the ROOT source code package and compile and install it yourself. Using different compilers may result in serious problems with your system. - X11 On Mac OS X you have to have X11 available. You may install it from the Mac OS X installation disks. - Disk space for installation The unpacked osa_sw binary package requires approximately 2 GB depending on the operating system. The unpacked osa_sw source code package requires some 300 MB of disk space. Once the software is built and installed a total of some 2 GB of disk space is needed dependending on the operating system and compiler used. Note: After the successful installation from the source code, you may reduce the disk space needed by osa_sw by executing 'make distclean' in the same directory where you executed 'make global_install'. This will reduce the amount of disk space needed to some 890 MB. You may additionally remove the source code directories (support-sw, analysis-sw, contrib-sw). This will reduce the disk space needed to some 790 MB. 4. Acknowledgements ================ The OSA math library (isdcmath) includes code from the following packages: - BLAS / LINPACK http://www.netlib.org/blas/index.html - CDFLIB90 http://odin.mdacc.tmc.edu/anonftp/ - LAPACK http://netlib.org/lapack/index.html - PORT from Bell Labs http://netlib.bell-labs.com/netlib/port/ - PDA from Starlink http://star-www.rl.ac.uk/static_www/soft_further_PDA.html 5. Changes since last Release ========================== =================== OSA 9.0 -> OSA 10.0 =================== ----- ISGRI ----- OSA 10 contains important improvements in the reconstruction of the photon energy for the detector ISGRI of IBIS. The conversion factor from electronic pulse-height to incoming photon energy has been observed to change with time. In OSA 9, the description of such gain drift was based on IREM counters integrated over time, to take into account the solar flares, but the measurement of the background lines at 59 and 511 keV showed that this correction was not valid along the whole mission. OSA 10 improves very significantly the reconstruction of the real photon energy, in particular the secular drift of gains, which was not correctly accounted for in OSA 9. The main improvements are the following: 1. The dependency of gains and offsets on the temperature of the eight modules in which the ISGRI detector is subdivided has been calibrated on ground and in-flight, and accounted for in OSA versions later than 7. In OSA 10, this correction has been improved by using the measured module temperatures of the thermal probes instead of assuming a constant temperature gradient between the different modules all along the mission. 2. A temporal dependency of the gain and offset through which the pulse heights are converted into energy has been determined by using the calibration lines on the existing data. A low-order polynomial fit ensures that this correction can be used on new data and will be monitored throughout the INTEGRAL lifetime. It has been observed that the gain and offset evolution depend also on the event rise-time and therefore a calibration table has been produced which accounts for these complex dependency and provides an optimal stability of the energy reconstruction over time. The energy resolution degraded over the mission by a factor of ~2, while the non-optimal correction performed in OSA9 introduced a spurious worsening by a factor of ~3. 3. The lower threshold at which the ISGRI pixels are sensitive to photons is continuously adjusted over the mission to ensure the optimal detector performance. As a consequence of the the new energy reconstruction and the degradation of the spectral resolution, also the function which accounts for this effect to reconstruct the source flux below ~30 keV needed an update. 4. New spectral calibration files. A set of ancillary response files (ARFs) for different epochs has been produced using Crab observations, this is necessary to account for the detector evolution. A weighted mean of the response files based on temporal proximity is provided by OSA when extracting a source spectrum for an arbitrary data-set. This ensures that the best available knowledge of the detector response is used in each spectral fitting. ----- JEM-X ----- The software has been significantly improved in several aspects. The improvements to the standard spectral extraction algorithm increase noticeably the stability of almost-constant source spectra throughout the mission and refine the determination of source detection significance at the imaging level. The introduction of an experimental algorithm for the image reconstruction, based on the Pixel Illumination Fraction, leads to substantial improvements on the sensitivity for weak source detection, in particular in crowded fields or in proximity of strong sources. In the production of JEM-X mosaic maps, the user has now the possibility to choose Aitoff-Hammer projection, which makes possible the mosaicking of large parts of the sky without introducing distortions of the maps. This projection can be therefore applied to reproduce e.g. in a single map a Galactic Plane Scan observation. An example of the output image can be seen in the figure below. The reconstruction of energy is based on continuously updated calibration files which are ingested in the instrument characteristic repository maintained by ISDC. Other changes introduced in OSA 10 include: - the introduction of an improved algorithm to compute the gain correction; with time and age the JEM-X units (in particular JEM-X 1) have become sensitive not only to temperature, but also to the total trigger rate of the detector. This last effect is now taken into account in the software, in cases where the correction is not performed through an IC gain history table. - the correction of a bug in updating the spectrum header keywords when the analysis is performed within a user-defined time interval; the header keywords "TSTART" and "TSTOP" of the spectrum file are now updated taking into account the time interval required by the user (as defined through "timeStart" and "timeStop" parameters of jemx_science_analysis). Also the column "EXPOSURE" reports now the correct integration time for the spectrum. In addition, the JEM-X User Manual has been thoroughly updated. --- SPI --- OSA 10 improvements on SPI are mainly related to the introduction of updated calibration files. The new Instrumental Response File take now into account the failure of detector 1 occurred in May 2010. New flat-fields have been produced, which may cover more finely the mission and provide a better modeling of the background evolution. An updated bad pointing list is given to the observer, including also the latest annealing phases that the SPI detector has undergone. Minor changes have been applied to the pipeline scripts, correcting for small bugs in the parameter handling. The format of the final spectral products resulting from both "spiros" and "spimodfit" analysis have been slightly modified to allow a smooth analysis with the latest XSPEC versions (version 12.7 for the time being). Finally, a short overview of the SPI products in the HEAVENS database maintained at ISDC has been included in the SPI User Manual. A first-look data analysis of SPI observations will be available through this new web interface, including both imaging, spectra and SPI lightcurves. --------------- Compilers, ROOT --------------- OSA 10 compiles now with more recent compilers, i.e. version 4.2 and 4.4. A few warnings and bugs, shown up with these compilers were fixed. A new ROOT version (5.32) is used with OSA 10. There were no changes required to build OSA with this ROOT version.