Welcome to PypeIt’s documentation!

PypeIt is a Python based data reduction pipeline (DRP) written oringinally for echelle spectroscopy and since expanded to low-resolution spectrometers. This documentation details the code, how to run it, and what it produces.

Getting Started

• Installing PypeIt
• Code Flow

Running PypeIt

PYPEIT HOWTO

• PypeIt Parameters
  • Current PypeItPar Parameter Hierarchy
  • Instrument-Specific Default Configuration
• PypeIt Cookbook
  • Outline
• PypeIt Reduction File
  • Overview
  • Types
  • pypeit_setup
  • By Example
  • Line by line
• Calibration Check
  • Overview
  • calcheck
  • Settings
• Running PypeIt
  • run_pypeit

Data Products

• Outputs
  • Contents
  • Standard Products
  • Reduction Mode
  • Compactness
  • Organization
• PypeIt QA
  • HTML
  • Calibration QA
  • Exposure QA

Calibrations

• Calibration Overview
  • Sequence of Events
  • datasec
• Bias Subtraction
  • Overview
  • Methods
• Slit Tracing
  • Algorithm
  • Open Issues
  • Reduction Mode
  • Scripts
  • Trace Slit Settings
  • Slit Profile
  • Tips on Trace Flat Frames
  • For Developers
• Wavelength Calibration
  • Basic Algorithms
  • Common Failure Modes
  • Possible Items to Modify
  • Line Lists
  • By-Hand Calibration
  • Flexure Correction
  • Wavelength Frame
  • Developers
  • Validation
• Wavelength Tilts
  • Overview
  • QA
  • Scripts
  • Settings
• Flat fielding
  • Overview
  • Methods
  • Blaze information
• Fluxing
  • Overview
  • Flux Spec Script
  • FluxSpec Class
  • Example File
  • Sensitivity Function
  • Fluxing Output
  • Troubleshooting

Instruments

• Instruments
  • Overview
  • Kast
  • LRIS
  • DEIMOS
  • X-Shooter
• Keck DEIMOS
  • Overview
  • Deviations
• Keck LRIS
  • Overview
  • Longslit
  • Taking Calibrations for LRISb
  • Taking Calibrations for LRISr
• Magellan Mage
  • Overview
  • Short slits

Object Algorithms

• Object Finding
  • Overview
  • Algorithms
  • Parameters
• Object Tracing
  • Parameters
• Coadd 1D Spectra
  • Coadd 1dspec
  • Input File
  • Spectral Parameters
  • Flux Scaling
  • Cosmic Ray Cleaning
  • Additional Coadding Parameters
  • Running the Coadd Code

Documentation

• Flexure Correction
• Frame Type
• Instrument Settings
• Internals

For Developers

• PypeIt scripts
• Code Flow
• New Spectrograph
• PypeIt API

Contents

• pypeit package
  • Subpackages
    • pypeit.core package
      • Submodules
      • Module contents
    • pypeit.scripts package
      • Submodules
      • Module contents
    • pypeit.spectrographs package
      • Submodules
      • Module contents
  • Submodules
    • pypeit.bpmimage module
    • pypeit.filter module
    • pypeit.flatfield module
    • pypeit.fluxspec module
    • pypeit.masterframe module
    • pypeit.scienceimage module
    • pypeit.traceslits module
    • pypeit.wavecalib module
    • pypeit.waveimage module
  • Module contents

Indices and tables

• Index
• Module Index
• Search Page