MaroonX DRAGONS Documentation

Welcome to the MaroonX DRAGONS DRP docs. This documentation is intended for both users and developers of the MaroonX DRP.

This documentation is organized into three main manuals:

• User Manual: Learn how to use the MaroonX DRAGONS pipeline to reduce your data

• Tutorial: Step-by-step example for common reduction tasks

• Programmer Manual: Technical details for developers and advanced users

Documentation Sections

User Documentation

• DRAGONS MAROONX Data Reduction User Manual
  • 1. Instrument and Data
  • 2. Data Reduction Recipes
  • 3. Tips and Tricks
  • 4. Issues and Limitations
  • 5. MAROONX Primitives and Parameters Classes

Tutorials

• DRAGONS MAROONX Data Reduction Tutorial
  • 1. MAROON-X DRP: Setup and Installation
  • 2. MAROON-X DRP: Using the Reduce class API
  • 3. MAROON-X DRP: Using the CLI tools

Developer Documentation

• DRAGONS MAROONX Data Reduction Programmer Manual
  • 1. Introduction
  • 2. Flows
  • 3. Tags
  • 4. Recipes
  • 5. Primitives
  • 6. Parameters
  • 7. Tests
  • 8. Legacy References

Indices and Tables

• Index

• Module Index

• Search Page

Todo

Complete the documentation for all MAROONX data reduction flows, including:

• Calibration flows (darks, flats, wavelength calibrations)

• Science observation flows

• Quality assessment flows

• Flow diagrams

original entry

Todo

Document the bundle processing flow for MAROONX data, including the splitBundle primitive and subsequent processing steps.

original entry

Todo

Document the dark frame creation and processing flow.

original entry

Todo

Document the flat field creation and processing flow.

original entry

Todo

Document the static wavelength calibration flow using reference solutions.

original entry

Todo

Document the dynamic wavelength calibration flow using simultaneous calibration sources.

original entry

Todo

Document the complete echelle spectroscopy processing flow, including:

• 2D image processing

• Fiber spectra extraction

• Wavelength calibration

• 1D spectrum creation

• Barycentric velocity correction

• Final science product generation

original entry

Todo

List all relevant headers keywords created after reduction

original entry

Todo

Add description of the synthetic darks. Uses SOOOE frames

original entry

Todo

Add instrument drift keywords here

original entry

Todo

Provide a quick reference table mapping legacy products to DRAGONS equivalents. Focus on array names within the files and key header keywords.

original entry

Todo

Document missing or desirable tests for MAROONX data reduction pipeline.

maroonx/maroonx_fit/ maroonx/maroonx_echellespectrum/

original entry

Todo

any known issues, any known limitations, workarouds, etc. can be performance issues too.

original entry

Todo

Document 2D image processing primitives and parameters.

original entry

Todo

Document echelle extraction primitives and parameters.

original entry

Todo

Document spectrum processing primitives and parameters.

original entry

Todo

Document inherited primitives from DRAGONS framework.

original entry

Todo

• List of available recipes.

• Typical processing flow.

• Science flow charts.

• Associated recipes.

original entry

Todo

Tips and tricks for MAROONX data reduction.

original entry