INTEGRAL Science Data Centre (ISDC) =================================== http://www.isdc.unige.ch/integral/ Release Note ============ Package: osa_sw Version: 11.1 Rel. Date: 15-Sep-2020 Contents ======== 1. Introduction 2. Portability 3. System Requirements 4. Acknowledgements 5. Changes since last Release 1. Introduction ============ This is the release note for the ISDC 'Off-line Scientific Analysis (OSA)' software version 11.1 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 can be ported on different platforms using containers (Docker is supported). 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 or Docker container 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_5.11 x86_64 - CentOS_6.9 x86_64 - CentOS_7.7.1908 x86_64 - Ubuntu_16.04 x86_64 - Ubuntu_20.04 x86_64 - Containers - Docker The binary OSA software packages were built on the above platforms. 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 using libraries included in the binary OSA packages. In general, the OSA software could also run on a variety of other Linux platforms (Suse 42.2 and 42.3 have been used with the Ubuntu packages) and will be portable using containers. 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, note that the above platforms have been tested using: GNU C/C++ (gcc) version 4.4.7 GNU Fortran (gfortran) version 4.4.7 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. Source Code Package =================== Before compiling and installing the osa_sw version 11 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.34.34 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! : It is recommended to install ROOT from the source code. 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. Using different compilers may result in serious problems with your installation. - 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 11.0 -> OSA 11.1 ==================== ------- General ------- This release is compatible with rbnrmf distributed with heasoft 6.26 and 6.27 which has been modified in a backward incompatible way. This affects both jemx_science_analysis and ibis_science_analysis. ii_light Correction of feature: align in seconds, not days; also add more logs. ----- JEM-X ----- lc_pick Implemented a correction for JEM-X: it removes points with same time tag by summing the rates, as they belong to different science windows. It removes points with 'RATE==0 and (ERROR==0 or ERROR==100)' ibis_isgr_energy approximate treatment of the zero event case to 10.2 (for NRT) j_ima_iros Reinstate writing of burst images in sky_ima files. Assured initialization of Tslices[].GlobalLC[]-array Test version to locate index error in FUNedge Update definition of edgeXmm and edgeYmm in work2d.c Corrected error writing user sources into iros_lc files. Introduction of 'reord' array. Corrected error writing source light curves into reg-files. 'reord' array (as defined in 'srclres') is moved to struct 'log_con' and used in 'Write_LC' secure consistency between source names and ID's between 'srcl_res' and 'iros_lc' files Protect against 'dontUse'-neigbor time bins in burst search. Transfer mean and error for light curves to reg files Include greyfilter correction into burst search. Testet version for release Restrict light curve analysis to interval RTSTART to RTSTOP Introduce the use of timeStart/timeStop from parameter values by adding to struct 'log_con' alias 'logger' Correct error in j_iir_Write_LC.c causing empty iros_lc.fits light c. (JeromeA) (retain light curves with missing lines) Correct error causing confusion between SLX 1744-300 and SLX 1744-299 (JeromeC) (tighter Xdec check in work2d) Search for error reported by Carlo Ferreigno on 10190622: "Uncertainties in spectral bins are highly underestimated - particularly for bins with lower than average signal in the particular bin" - This prevents meaningful integration of signal from weak sources across scws. The problem was traced to 'final-sky.c' where (in line 353) peakcount[0] and [1] was forced to 1.0 if the peakval value found by 'peaktransfer.c' was less than 0.0. Conclusion: line 353 must be commented out. This is done in 6.1.07. Correction of error reported by Carlo Ferreigno on 10190622: "Uncertainties in spectral bins are highly underestimated - particularly for bins with lower than average signal in the particular bin" - This prevents meaningful integration of signal from weak sources across scws. Line 353 in final_sky.c is commented out. Ensure that the light curves and srcl_res data for all flag-1 sources are output, also in cases where several flag-1 sources cannot be cleanly separated (SLX 1744-300/-299 as one example) (JeromeD) Ensure that header comments in all source files reflects the current file name. (Only modifies comment lines !) Avoid double extraction of light curves (causing 'CONFUSED ID') Detsig values: In iros_lc-values: based on light-curve data, in srcl_res: based on imaging data Ad hoc rescue when OBT -> IJD conversion fails, mainly in NRT data. ==================== OSA 10.2 -> OSA 11.0 ==================== ------- General ------- Due to the increased divergence of Mac OS from Linux and the difficulty to upgrade OSA software to cope with new Mac designs, we opted to maintain OSA portability through the container technology. Thus, we provide OSA with docker container to be used on any platform. Instructions should be found in the OSA installation guide. Having HEASOFT installed and active is required for OSA to perform IBIS spectral analysis. ---- IBIS ---- Please consider that the validity of OSA11.0 for IBIS is currently limited to the recent data, since 2015-12-26 at 02:03:13 UT, i.e. from the beginning of the revolution 1626. The validity will be updated to past data as soon as possible. Regular updates for the more recent data are foreseen, as the instrument continues to evolve. For earlier data, the user should work with OSA 10.2. - A completely new energy calibration is performed within the dal_ibis library. Variable response files are provided which include both the redistribution and the effective area. - No effective area is shipped anymore. - The instability of count rate within one revolution due to the detector polarization has been corrected. - Use of time-dependent background and efficiency calibration file has been introduced. - The spectra can be binned conveniently using PIL input parameters, not by making a rebinned matrix as before. ----- JEM-X ----- A new version of j_ima_iros has been delivered with several improvements, which enhanced the stability of results. - An automatic search for bursts is implemented. - j_ima_iros is the default software to extract light curves, although the possibility to use the old method is still present. --- SPI --- The possibility to use PSD discriminator events for different energy ranges is introduced. This allows the user to extend the spectral extraction above 400 or 600 keV depending on the epochs (see the user manuals). Corresponding flat fields have been ingested in the IC tree.