A release of the SPHERE pipeline recipes is now available !

A release of the SPHERE pipeline recipes is now available.

Together with the data processing modules, we also provide standalone applications for running them:

  • EsoReflex, a GUI which provides an easy and flexible way of runing pipeline execution workflows.
  • Gasgano, a GUI for data browsing and organisation, providing an intuitive and comprehensive interface to pipeline recipes that are based on the ESO Common Pipeline Library (CPL).
  • EsoRex, a command-line driven utility to launch pipeline recipes, which can be used either as an interactive tool, or can be embedded into scripts for automating some of the data reduction tasks.


Version 0.42.0 Public Release (24 May 2021)

  • A new dispersion calculation has been included for IFS WAVE CALIB frames
  • EsoReflex workflows have been updated & made clearer
  • Single ZIMPOL exposures can now be processed individually
  • Scaling of ZIMPOL dark frames has been corrected
  • Related documentation updates

Version 0.40.0 Public Release (2 June 2020)

  • Improvements to the manual and tutorials
  • Removed spurious data product output from sph_ifs_science_dr
  • Updated IRDIS DBI workflow to ensure IRD_FILTER_TABLE is associated for later Strehl ratio calculation
  • Updated OCA rules for IRDIS imaging to support distortion correction

Version 0.38.0 Public Release (22 May 2019)

  • Support compilation with gcc-9
  • Avoid illegal keyword in SPHERE pipeline products
  • Fix too large zimpol variation in total pol of STD
  • Reflex: update ZIMPOL_POL.oca
  • zpl.science_p1.subtract_overscan present in sph_zpl_science_imaging recipe
  • Reflex: support distortion correction for IRDIS
  • Reflex: replace IRDIS_LSS.oca and ZIMPOL_POL.oca
  • Take AO status into account for IRDIS zeropoints
  • Update the SCRIPTS_DIR path in the Gasgano preferences
  • Fix wrong units in online help of sph_ird_wave_calib
  • sph_ifs_wave_calib: change default of ifs.wave_calib.no_spline_interpol to true
  • Fix wrongly determined Pixel Scale for Strehl calculation
  • Fix typo in first equation on Page 163 of the SPHERE Pipeline Manual (v. 1.31)
  • Fix procedure for building manual
  • Process ZIMPOL polarimetric standard stars and provide monitoring information
  • SPHERE IRDIS photometric zeropoints INS4.FILT2.NAME=OPEN
  • Implement needed change of IRDIS IMG OCA rules for waffle map
  • Fix incorrect arcsecond value for IRDIS WCS RA+DEC
  • Fix error in the SPHERE pipeline manual
  • Fix issue with IRDIS_CI_DBI_DPI workkflow
  • Fix SEQ.ARM key missing/incorrect or with incorrect comment for static calibrations
  • Fix QC parameter of PFRAME in ZIMPOL imaging recipes
  • Refactor QC parameter saving and naming schema for Strehl and Zeropoint in ZIMPOL
  • The reflex workflow IRDIS_CI_DBI_DPI searches the calibration files in the wrong directory
  • In IRDIS mode, ESO QC STREHL2 is wrong
  • Provide zeropoints derived from ZIMPOL STD,FLUX observations
  • Correct most obvious problems in Pipeline User Manual
  • sph_zpl_star_center_*: DRS parameters refer to IFRAME/PFRAME
  • Fix SPHERE reduction pipeline/manual download issues
  • sph_ifs_cal_background: bad pixels need to be taken into account
  • IRDIS distortion self-calibration produces bad result

Version 0.36.0 Public Release (24 April 2018)

  • Removed gasgano warnings regarding removed IFS recipes
  • Reflex Workflows ported to Reflex 2.9
  • ZIMPOL Polarimetry for Standard star support implemented for P1 mode
  • Non-standard CFITSIO usage of ffopentest() replaced with ffopen()

Known Issues

  • The SPHERE pipeline recipes report a version number of 0.39.0, as can be seen with esorex --man recipename. This is incorrect - the current version is 0.40.0.

SPHERE pipeline recipes public version:

The public version of the SPHERE pipeline recipes is 0.42.0, and it is included in the pipeline distribution kit spher-kit-0.42.0-1.tar.gz together with the following packages:

SPHERE pipeline documentation

User Manual: 1.42
EsoReflex Tutorial: 1.3 (ifs)
EsoReflex Tutorial: 1.2 (ird-img)
EsoReflex Tutorial: 1.2 (ird-lss)
EsoReflex Tutorial: 1.2 (zpl-img)
EsoReflex Tutorial: 1.3 (zpl-pol)

SPHERE pipeline recipes System Requirements

The SPHERE pipeline kit version 0.42.0 is verified and supported on the VLT target platform:
  • CentOS 7 (x86_64), using gcc v4.8.5.
It is also verified that the pipeline kit can be built on the following platforms (x86_64):
  • Scientific Linux 7
  • Fedora 28
  • Fedora 29
  • Fedora 30
  • Fedora 31
  • Fedora 32
  • Ubuntu 16.04
  • Ubuntu 18.04
  • Ubuntu 18.10
  • Ubuntu 19.04
  • Ubuntu 20.04
  • Debian 9
  • MacOS 10.14
  • MacOS 10.15
  • MacOS 11

Installing and running the SPHERE pipeline recipes 0.42.0

There are several ways to install the pipeline on your machine. The recommended installation procedure depends on whether you are working on a Mac OSX or on Linux.

Installation using RPM repositories

For Fedora 28/29/30/31/32, CentOS 7 and Scientific Linux 7, it is recommended to install the pipeline from our RPM repository. The RPM repositories include not only the pipeline recipes but also the library dependencies (CPL, etc..), the EsoReflex workflow, demo data and the EsoReflex tool itself.

Please refer to the instructions provided here.

Installation using MacPorts repositories

For Apple macOS 10.14/10.15/11, it is recommended to install the pipeline with MacPorts. The MacPorts repositories include not only the pipeline recipes but also the library dependencies (CPL, etc..), the EsoReflex workflow, demo data and the EsoReflex tool itself.

Please refer to the instructions provided here.

Installation using the EsoReflex installation procedure

Please refer to EsoReflex Software Prerequisites and Installation Instructions for detailed instructions

Installation using the public pipeline kit

To install the SPHERE pipeline recipes 0.42.0 you will need to retrieve the pipeline distribution kit, unpack and install it.

  • Please check the software prerequisites here.

Installation procedure:

  1. Change directory to where you want to retrieve the SPHERE pipeline recipes 0.42.0 package. It can be any directory of your choice but not:
    • $HOME/gasgano
    • $HOME/.esorex
  2. Download the software and the static calibration data (line catalogs etc.) necessary for running the pipeline recipes:
  3. Unpack using for example the following command:     tar xzf spher-kit-0.42.0-1.tar.gz
  4. Install: after moving into the installation directory,     cd spher-kit-0.42.0-1 it is recommended to perform the installation using the supplied installer script:     ./install_pipeline (BEWARE: The installation may take several minutes). By default the script will install the SPHERE recipes, Gasgano, EsoRex, all the necessary libraries, and the static calibration tables, into a directory tree rooted at $HOME. A different path may be specified as soon as the script is run. For instance (user input is boldfaced):
    $ ./install_pipeline
    I am about to install the following software packages:
    • cfitsio3.49.tar.gz
    • cpl-7.1.4.tar.gz
    • esorex-3.13.5.tar.gz
    • gasgano-2.4.8.tar.gz
    • spher-kit-0.42.0-1.tar.gz
    with the following pipeline calibration file(s):
    • spher-calib-0.42.0.tar.gz
    The software installation will be organised in bin/, lib/ and include/ directories, while the calibration files will be installed in a calib/ directory. Where should I install the software packages ? [/home/userid] /home/dummy/pipelines
    Where should I install the pipeline calibration files ? [/home/dummy/pipelines] /home/dummy/calibrations
    In this case the software is installed under the directory /home/dummy/pipelines and the static calibration tables under /home/dummy/calibrations/spher The only exception to all this is the Gasgano tool, that will always be installed under the directory $HOME/gasgano Note that the installer will move an existing $HOME/gasgano directory to $HOME/gasgano.old before the new Gasgano version is installed.
    Important: the installation script would ensure that any existing Gasgano and EsoRex setup would be inherited into the newly installed configuration files (avoiding in this way any conflict with other installed instrument pipelines).
    Please follow the instructions shown at the end of a successful installation script: they will indicate how to set your PATH and CPLDIR variables in your machine in order to run the pipeline.
    Alternatively, it is possible to perform a manual installation (experienced users only): the README file located in the top installation directory contains more detailed information about a step-by-step installation.

Executing the pipeline 0.42.0

Using EsoReflex

  • To run the EsoReflex workflow, please refer to the SPHERE workflow tutorial available in this table under column Documentation.

Using Gasgano

  1. To run the Gasgano GUI, just add $HOME/gasgano/bin to your PATH environment variable:     export PATH="$HOME/gasgano/bin:"$PATH You should also define an environment variable CPLDIR to point to the same path specified for the installation. Possible files to update are:     $HOME/.bashrc     $HOME/.profile Finally, enter the command     gasgano
  2. If the Gasgano main panel appears, then you have successfully installed Gasgano. Make sure, however, that the expected Gasgano 2.4.8 release is running: the version number is listed at the top of the main Gasgano panel.
  3. Refer to the Gasgano User's Manual to learn how to browse data and run pipeline recipes. Refer to the Pipeline User Manual(s) for detailed information about the recipes usage.

Using EsoRex

  1. The EsoRex executable should be available in the bin directory under your installation path (see above). The PATH environment variable should be upgraded accordingly (similarly as done for Gasgano).
  2. Refer to the EsoRex web page for details about the related features and options.


The EsoReflex Users' Manual is availale for download

The GASGANO Users' Manual (~1.2 Mb, 66 pages) is available for download in the Gasgano web page.

On the EsoRex web page some online documentation about EsoRex can be found.

The CPL manuals are available on the CPL web pages.

In case of problems when opening the documents directly from your web browser, the files may be first saved on disk, and then opened with Acrobat Reader.

Bug Reports

If you experience an unexpected behavior of any component of the SPHERE pipeline recipes package, please, first verify that you are using one of the above mentioned supported platforms and refer to the list of known problems and limitations in the pipeline manual of the current SPHERE pipeline release.

For any other issues or requests, please, send a report to the ESO User Support Department mentioning SPHERE pipeline in the subject, describing:        

  • the SPHERE pipeline version (currently 0.42.0), and the version of other components (e.g., Gasgano, EsoRex, ...) you are using
  • the version of your OS and C compiler.
  • the exact sequence of actions that were performed before the problem occurred
  • what were precisely the symptoms and the possible error message(s)
  • whether the problem is repeatable