.. title:: Overview

The HAWKI 2.4.11 pipeline
###################################

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

Standard recipes
----------------
:data:`hawki_cal_distortion`
   (OBSOLETE) Distortion autocalibration

:data:`hawki_dark_combine`
   HAWKI dark combination recipe

:data:`hawki_science_process`
   HAWKI jitter recipe

:data:`hawki_standard_process`
   HAWKI standard field recipe

:data:`hawki_tec_filtchk`
   (OBSOLETE) Filter checking recipe

:data:`hawki_twilight_flat_combine`
   HAWKI twilight combination recipe

Additional recipes
--------------------
:data:`hawki_cal_dark`
   (OBSOLETE) Dark recipe

:data:`hawki_cal_flat`
   (OBSOLETE) Twillight flat recipe

:data:`hawki_cal_zpoint`
   (OBSOLETE) Zero point computation recipe

:data:`hawki_detector_noise`
   HAWKI detector noise recipe

:data:`hawki_linearity_analyse`
   HAWKI linearity recipe

:data:`hawki_sci_jitter`
   (OBSOLETE) Jitter recipe

:data:`hawki_science_postprocess`
   HAWKI post processing recipe

:data:`hawki_step_apply_dist`
   (OBSOLETE) Distortion correction utility

:data:`hawki_step_basic_calib`
   (OBSOLETE) Basic reduction recipe

:data:`hawki_step_combine`
   (OBSOLETE) Jitter image combination recipe

:data:`hawki_step_compute_bkg`
   (OBSOLETE) Background computing utility

:data:`hawki_step_detect_obj`
   (OBSOLETE) Object detection recipe

:data:`hawki_step_photom_2mass`
   (OBSOLETE) 2MASS photometric calibration

:data:`hawki_step_refine_offsets`
   (OBSOLETE) Jitter recipe

:data:`hawki_step_stats`
   (OBSOLETE) Standard statistics utility

:data:`hawki_step_stitch`
   (OBSOLETE) Stitching utility

:data:`hawki_step_subtract_bkg`
   (OBSOLETE) Background subtraction utility

:data:`hawki_util_gendist`
   (OBSOLETE) Distortion map creation

:data:`hawki_util_stdstars`
   (OBSOLETE) Standard stars catalog creation

.. toctree::
   :hidden:

   hawki_cal_distortion
   hawki_dark_combine
   hawki_science_process
   hawki_standard_process
   hawki_tec_filtchk
   hawki_twilight_flat_combine
   hawki_cal_dark
   hawki_cal_flat
   hawki_cal_zpoint
   hawki_detector_noise
   hawki_linearity_analyse
   hawki_sci_jitter
   hawki_science_postprocess
   hawki_step_apply_dist
   hawki_step_basic_calib
   hawki_step_combine
   hawki_step_compute_bkg
   hawki_step_detect_obj
   hawki_step_photom_2mass
   hawki_step_refine_offsets
   hawki_step_stats
   hawki_step_stitch
   hawki_step_subtract_bkg
   hawki_util_gendist
   hawki_util_stdstars

.. 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 <https://www.eso.org/sci/software/pipelines/>`_
       over the existing ESO pipelines,

     * the `python-cpl <https://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.