.. title:: Overview

The HAWKI 1.8.12 pipeline
###################################

These pages describe the python interface for the HAWKI pipeline recipes.

Standard recipes
----------------
:data:`hawki_cal_distortion`
   Distortion autocalibration

:data:`hawki_cal_dark`
   Dark recipe

:data:`hawki_cal_flat`
   Twillight flat recipe

:data:`hawki_cal_zpoint`
   Zero point computation recipe

:data:`hawki_sci_jitter`
   Jitter recipe

:data:`hawki_tec_filtchk`
   Filter checking recipe

Additional recipes
--------------------
:data:`hawki_step_stitch`
   Stitching utility

:data:`hawki_util_gendist`
   Distortion map creation

:data:`hawki_step_apply_dist`
   Distortion correction utility

:data:`hawki_step_detect_obj`
   Object detection recipe

:data:`hawki_util_stdstars`
   Standard stars catalog creation

:data:`hawki_step_basic_calib`
   Basic reduction recipe

:data:`hawki_step_photom_2mass`
   2MASS photometric calibration

:data:`hawki_util_extinction`
   Zero point with extinction computation recipe

:data:`hawki_step_compute_bkg`
   Background computing utility

:data:`hawki_step_combine`
   Jitter image combination recipe

:data:`hawki_step_refine_offsets`
   Jitter recipe

:data:`hawki_step_subtract_bkg`
   Background subtraction utility

:data:`hawki_step_stats`
   Standard statistics utility

.. toctree::
   :hidden:

   hawki_cal_distortion
   hawki_cal_dark
   hawki_cal_flat
   hawki_cal_zpoint
   hawki_sci_jitter
   hawki_tec_filtchk
   hawki_step_stitch
   hawki_util_gendist
   hawki_step_apply_dist
   hawki_step_detect_obj
   hawki_util_stdstars
   hawki_step_basic_calib
   hawki_step_photom_2mass
   hawki_util_extinction
   hawki_step_compute_bkg
   hawki_step_combine
   hawki_step_refine_offsets
   hawki_step_subtract_bkg
   hawki_step_stats

.. seealso::

     * The `HAWKI Pipeline User Manual 
       <ftp://ftp.eso.org/pub/dfs/pipelines/hawki/hawki-pipeline-manual-1.2.3.pdf>`_ in PDF format,

     * an `overview <http://www.eso.org/sci/software/pipelines/>`_
       over the existing ESO pipelines,

     * the `python-cpl <http://packages.python.org/python-cpl>`_ package.
    
Bug reports
===========

If you experience an unexpected behavior of any component of the HAWKI
pipeline recipes package, please, first refer to the list of known problems
and limitations in the pipeline manual of the current HAWKI pipeline
release.

For any other issues or requests, please, send a report to the `ESO User
Support Department <usd-help@eso.org>`_, describing:

 * the HAWKI pipeline version,
 * 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.
