Keck DRP Framework Documentation

This is the documentation for Keck Data Reduction Pipeline Framework package (KDRPF).

KDRPF is a general framework capable of running data reduction pipelines developed specifically for Keck instruments, but it can be used to run any type of data reduction pipelines.

It has been developed by the WMKO Data Reduction Project.

This document shows how to install the package, describes the key concepts behind the framework, and shows the steps necessary to run or develop a pipeline.

Requirements

KDRPF has the following requirements:

• Astropy
• pandas

Installation

You can download the code by cloning this repository:

git clone https://github.com/Keck-DataReductionPipelines/KeckDRPFramework.git

Change directory into the KeckDRPF directory and run:

python setup.py install

Note that you will download the develop branch, which is the default branch. To switch to the master branch, use:

git checkout -b master --track origin/master

Framework design and concepts

• Design and basic concepts
  • Setting up and starting the framework
  • The event loop
  • The event queues
  • Adding events to the queues
• Startup Scripts
  • The import block
  • The argument parser
  • The main function
    • Opening
    • Configuration
    • Initialization of the framework
    • Processing of files and arguments
  • Operational modes
    • Reduction of individual files
    • Ingestion of all the files in a specified directory
    • Starting the framework processing engine with no files
• Primitives
  • Primitives as classes
  • Primitives as functions
• Arguments
• Pipelines
• Events and Actions
  • Events
  • Actions
• Plotting with Bokeh
  • Plotting
• Creating a pipeline using the template
  • Setup.py
  • The main pipeline
  • Creating the startup script
  • Installation and examples

Reference API

• Reference/API