.. module:: lofarpipe.cuisine
   :synopsis: The Cuisine system.

************************************
The :mod:`lofarpipe.cuisine` package
************************************

The LOFAR pipeline system developed partly from the `WSRT Cuisine
<http://www.astron.nl/~renting/pipeline_frame.html>`_, developed by Adriaan
Renting for use at the Westerbork Synthesis Radio Telescope. Many of the basic
concepts (the recipe, with associated inputs and outputs, for example)
originated in the Cuisine system, and the user is encouraged to refer to its
documentation where necessary.

A slightly modified version of the "original" Cuisine is distributed as part
of the :mod:`lofarpipe` package. The modifications include:

* Use of `new style
  <http://www.python.org/download/releases/2.2.3/descrintro/>`_ Python classes
  throughout.

* Reworked option handling code to use the `optparse
  <http://docs.python.org/library/optparse.html>`_ module from the Python
  standard library.

* Reworked logging system using the `logging
  <http://docs.python.org/library/logging.html>`_ module from the Python
  standard library. This provides a flexible way of configuring logging formats
  and destinations, included logging to files or TCP sockets. See the section on
  the pipeline :ref:`logging system <lofarpipe-logging>`.

* Assorted bug-fixes and tweaks.

It is hoped that these changes will eventually be merged upstream.

Very little of the original Cuisine code is currently used in the LOFAR
framework, although the :class:`lofarpipe.cuisine.WSRTrecipe.WSRTrecipe` is
still used as the basis for all LOFAR recipes. The recipe author, however, is
*never* expected to directly interact with Cuisine code: all LOFAR pipeline
recipes inherit from :class:`lofarpipe.support.baserecipe.BaseRecipe`, which
entirely wraps all relevant Cuisine functionality. The
:mod:`lofarpipe.support` inheritance diagrams show exactly how these packages
are related. The following API documentation covers only those routines
directly used by the rest of the pipeline system, not Cuisine as a whole.

.. module:: lofarpipe.cuisine.WSRTrecipe
   :synopsis: Base module for all Cuisine recipe functionality.

:mod:`lofarpipe.cuisine.WSRTrecipe`
-----------------------------------

.. autoclass:: lofarpipe.cuisine.WSRTrecipe.WSRTrecipe
   :members: help, main_init, main, run, go, main_result, cook_recipe

.. module:: lofarpipe.cuisine.cook
   :synopsis: Cuisine cooks.

:mod:`lofarpipe.cuisine.cook`
-----------------------------

.. autoclass:: lofarpipe.cuisine.cook.PipelineCook
   :members: copy_inputs, copy_outputs, spawn, try_running