In this file:

* About the GIRAFFE pipeline
* Availability
* Installing the GIRAFFE pipeline recipes
*   Supported platforms
*   Prerequisites
*   Compiling the GIRAFFE pipeline recipes
* Running the recipes
* Related information
* Reporting bugs


About the GIRAFFE pipeline:
---------------------------

This is version 2.16.10 of the GIRAFFE instrument pipeline.

The package provides the GIRAFFE pipeline recipes for processing data
obtained from the mid- to high-resolution spectrograph GIRAFFE, which is
available at the ESO observatory at Cerro Paranal, Chile.

The GIRAFFE pipeline is free software, you can redistribute it and/or
modify it under the terms of the GNU General Public License.


Availability:
-------------

The latest, stable version of the GIRAFFE pipeline library and recipes is
always available at http://www.eso.org/pipelines.


Installing the GIRAFFE pipeline recipes:
----------------------------------------

Supported platforms:
--------------------
This GIRAFFE pipeline version has been verified on the VLT target platforms

    - CentOS 7.3 (x86_64), using gcc 4.8.5

In addition, it has been built successfully on the following platforms
(x86_64) using the default system compiler:
    - Debian 9
    - Fedora 27
    - Fedora 28
    - Fedora 29
    - Fedora 30
    - Fedora 31
    - openSuSE Leap 15.1
    - openSuSE Leap 15.0
    - openSuSE Leap 42.3
    - openSuSE Leap 42.2
    - openSuSE Leap 42.1
    - Scientific Linux 7
    - Ubuntu 16.04
    - Ubuntu 18.04
    - Ubuntu 18.10
    - Ubuntu 19.04
    - MacOS 10.11 
    - MacOS 10.12 
    - MacOS 10.13 
    - MacOS 10.14 

Prerequisites:
--------------
To compile and install the GIRAFFE pipeline recipes, one needs:

    - an appropriate version of the GNU C compiler,
    - a version of the tar file archiving program,
    - the GNU gzip and make utilities, and
    - an installation of the CFITSIO FITS IO library, version 3.350, or newer.
    - an installation of the ESO Common Pipeline Library (CPL), version 6.4.
    - ESO's esorex recipe frontend, version 3.10, or newer.

For details on the installation of CPL, and esorex please refer to
the documentation, which is available at http://www.eso.org/cpl.

Compiling the GIRAFFE pipeline recipes:
---------------------------------------

1. Unpack the GIRAFFE pipeline tarball in a temporary directory:

    cd $HOME/tmp
    tar -zxvf giraf-<version>.tar.gz

   which will create a subdirectory giraf-<version> in your current
   directory.

2. Change directory to the created subdirectory giraf-version:

3. Set the environment variables CPLDIR and CFITSIODIR to the root of your
   CPL and CFITSIO installation tree, for instance:

     export CPLDIR=$HOME/cpl
     export CFITSIODIR=$CPLDIR

   assuming that CFITSIO and CPL share a directory tree. As an alternative to
   setting the environment variables, one can use the appropriate command
   line options of configure (see ./configure --help for details). In the
   latter case please note that you will have to give also the location
   of the Cext library, in addition to the location of CFITSIO and CPL. This
   library is part of the CPL distribution and will therefore be found in the
   same directory tree as CPL. This means that the same path has to be
   provided on the command line for the CPL and Cext location.

4. Run the configure script. The script's prefix option (--prefix) may
   be used to set the target directory for the installation. If the
   recipes are not installed into /usr/local, which is the default, it is
   recommended to install the recipes into the same directory tree as CPL.

5. Build and install the GIRAFFE pipeline recipes, using:

     make
     make install

6. If the target directory's sub directory lib is not already listed in
   your LD_LIBRARY_PATH (or equivalent), add it. Also check that the CFITSIO
   library is located in a directory which is in your library search path!


Running the recipes:
--------------------

To use the GIRAFFE pipeline recipes you need the recipe frontend application
esorex, which can be obtained at http://www.eso.org/cpl

For details on how to configure and use esorex to execute pipeline recipes,
please refer to its documentation.


Related information:
--------------------

Further information on the packages mentioned here can be found at:

    http://www.eso.org/cpl
    http://www.eso.org/pipelines


Reporting bugs:
---------------

Please send bug reports and feedback to <https://support.eso.org/>
