PyIRD

PyIRD is a Python-based pipeline for reducing spectroscopic data obtained with IRD and REACH on the Subaru Telescope. It is designed to process raw images into one-dimensional spectra in a semi-automatic manner.

Introduction:

• Getting Started
  • Installation
  • Running the Tutorial
  • Sample Data
• Input Data

Tutorial:

• Pipeline to Get 1D Spectra from Raw Data (IRD Stream)
  • Step 0: Settings
  • Step 1: Preprocessing the Calibration Dataset
  • Step 2: Extracting the Target 1D Spectrum
• Output Spectra
• Overview of Output Files

Userguide:

• Background
  • Readout Noise Pattern Model
  • Names and Terms of IRD/REACH data
• Handling Apertures
  • Single Fiber Mode (nap = 21 or nap = 51)
  • Wavelength Calibration with User Defined Apertures (nap < 20 for H or nap < 51 for YJ)
• Useful Options
  • Increment/Decrement FITS IDs
  • Read Hotpixel Mask
  • Change Output Format
  • REACH Data Reduction
• For Developers
  • Test code for developers

API:

• pyird package

License & Attribution

Copyright 2021-2025, Contributors:

• Yui Kasagi (maintainer),

• Hajime Kawahara (co-maintainer),

• Ziying Gu,

• Teruyuki Hirano,

• Takayuki Kotani,

• Masayuki Kuzuhara,

• Kento Masuda

PYIRD is free software made available under the MIT License. For details see the LICENSE.

Community Guidelines

For developers, please read CONTRIBUTING.md for details how to contribute to the project. If you encounter a bug or have suggestions, feel free to open an Issue.