Metadata-Version: 2.4
Name: kahe-pipeline
Version: 0.1.0
Summary: Calibration and analysis tools for Keck/NIRSPEC spectroscopy
Author-email: Chase Urasaki <chasemu@hawaii.edu>, Michael Zhang <zmzhang@uchicago.edu>
License: MIT
Project-URL: Homepage, https://github.com/chase-urasaki/KAHE-pipeline
Project-URL: Repository, https://github.com/chase-urasaki/KAHE-pipeline
Project-URL: Issues, https://github.com/chase-urasaki/KAHE-pipeline/issues
Keywords: astronomy,spectroscopy,NIRSPEC,calibration
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: astropy
Requires-Dist: matplotlib
Requires-Dist: scipy
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Requires-Dist: sphinx-autodoc-typehints; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Dynamic: license-file

# KAHE Pipeline

Calibration and analysis tools for Keck/NIRSPEC spectroscopy.

## Installation

### 1. Install Package 

#### From Source (development)

```bash
git clone https://github.com/chase-urasaki/KAHE-pipeline.git
cd KAHE-pipeline
pip install -e .
```
#### From PyPI 
```bash
pip install kahe
```
## Quick Start 

### 1. Create a new project
This creates a project directory with the required folder structure and a blank configuration file: 

```bash
kahe-setup {targetname}_{obsdate}
``` 
This generates the following: 
TOI2123_240704/
├── pipeline_config.ini           # Edit this with your parameters
├── cals/                         # Master calibration files which you can reuse for the same night
├── raw/                          # Raw FITS data
├── extracted_spectra/            # 1D extracted spectra
├── wl_calibrated/                # Wavelength-calibrated spectra
├── telluric_correction_inputs/   # Inputs for telluric correction
└── telluric_correction_out/      # Telluric-corrected output

### 2. Organize Raw Data 
raw/
├── darks/
│   ├── dark_0001.fits
│   ├── dark_0002.fits
│   └── ...
├── flats/
│   ├── flat_0001.fits
│   ├── flat_0002.fits
│   └── ...
└── science/
    ├── science_0001.fits
    ├── science_0002.fits
    └── ...
