Welcome to kspecdr’s documentation!

kspecdr is a Python-based reduction pipeline for the K-SPEC instrument, inspired by and migrating from 2dFDR.

Note

The project is currently in alpha. Core preprocessing, tramline generation, SUM extraction, and arc wavelength calibration are available, while full science reduction is still under active development.

Getting Started

• Getting Started
  • Installation
  • Quick Start

Tutorials

• Tutorials
  • Basic Usage of kspecdr
  • Isoplane Data Reduction Workflow
  • Isoplane320 Wavelength Calibration Test

How-to Guides

• How-to Guides
  • Prepare Isoplane Inputs
  • Build Calibration Products
  • Extract and Calibrate Spectra

Explanations

• Explanations
  • Data Reduction Steps
  • Package Architecture
  • Isoplane Reduction Theory and Strategy (End-to-End)

API Reference

• API Reference
  • Preprocessing API
  • Tramline API
  • Extraction API
  • Wavelength Calibration API
  • Flux Calibration API
  • Instrument API
  • Utilities API

Development

• Development
  • Flux Calibration Design Plan for kspecdr
  • Object (Science) Reduction Planning Document
  • KSPECDR Flux Calibration Pipeline
  • Where Flux Calibration Happens
  • Inputs Required for Flux Calibration
  • Standard-Star Selection
  • Template Matching (Per Standard Star)
  • Photometric Scaling
  • Per-Star Calibration Vector
  • Combine Multiple Standards
  • Apply Calibration to All Fibers
  • Runtime Controls (args)
  • Practical Example (Commissioning Data)
  • QC Checklist
  • Known Gaps and Next Improvements
  • Summary

Indices and tables

• Index

• Module Index

• Search Page