Metadata-Version: 2.2
Name: pyird
Version: 1.1.0
Summary: Python pipeline for infrared detectors, and/or IRD/REACH
Home-page: https://github.com/prvjapan/pyird
Author: Yui Kasagi, Hajime Kawahara, and Collaborators
Author-email: kasagi.y96@gmail.com
Maintainer: Yui Kasagi, Hajime Kawahara, and Collaborators
Maintainer-email: kasagi.y96@gmail.com
License: MIT
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: tqdm
Requires-Dist: scipy
Requires-Dist: sep
Requires-Dist: gpkron
Requires-Dist: pandas
Requires-Dist: astropy
Requires-Dist: astroquery==0.4.7
Requires-Dist: numpy<2
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black; extra == "dev"

<img src=documents/figures/pyird_logo.png width=70%>

PyIRD
===========
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/prvjapan/pyird/blob/develop/LICENSE)
[![Version](https://img.shields.io/badge/version-v1.0.0-blue?logo=github)](https://github.com/prvjapan/pyird/releases/tag/v1.0.0)
[![PyPI Version](https://img.shields.io/pypi/v/pyird)](https://pypi.org/project/pyird/)
[![Run pytest](https://github.com/prvjapan/pyird/actions/workflows/main.yml/badge.svg)](https://github.com/prvjapan/pyird/actions/workflows/main.yml)

`PyIRD` is a Python-based pipeline for reducing spectroscopic data obtained with [IRD](https://ird.mtk.nao.ac.jp/IRDpub/index_tmp.html) and [REACH](https://secondearths.sakura.ne.jp/reach/) on the Subaru Telescope. 
It is designed to process raw images into one-dimensional spectra in a semi-automatic manner. 
Unlike traditional methods, it does not rely on IRAF (Tody et al. [1986](https://ui.adsabs.harvard.edu/abs/1986SPIE..627..733T/abstract), [1993](https://ui.adsabs.harvard.edu/abs/1993ASPC...52..173T/abstract)), a software traditionally used for astronomical data reduction. This approach simplifies the workflow while maintaining efficiency and accuracy.
Additionally, the pipeline includes an updated method for removing readout noise patterns from raw images, enabling efficient extraction of spectra even for faint targets such as brown dwarfs.


Install
------------------

```
pip install pyird
```

or

```
git clone https://github.com/prvjapan/pyird.git
cd pyird
pip install .
```

Examples
------------------

`PyIRD` is designed to perform data reduction semi-automatically by following a general workflow for high-dispersion spectroscopic data reduction (e.g., readout noise subtraction, flat fielding, aperture extraction, wavelength calibration, and normalization).

See the following examples how to create 1D spectra from raw data.
- [pyird/examples/python/IRD_stream.py](https://github.com/prvjapan/pyird/blob/master/examples/python/IRD_stream.py) -- for IRD data; read [the docs](https://secondearths.sakura.ne.jp/pyird/tutorials/IRD_stream.html) for the detailed explanation.
- [pyird/examples/python/REACH_stream.py](https://github.com/prvjapan/pyird/blob/master/examples/python/REACH_stream.py) -- for REACH data; basically the same as `IRD_stream.py`, but with the variable `inst` set to `REACH` instead.

The raw data for `IRD_stream.py` can be downloaded from the [Zenodo repository](https://zenodo.org/records/14614004). 


License
------------------------------
`PyIRD` is publicly available under the MIT license. For developers, please read [CONTRIBUTING.md](https://github.com/prvjapan/pyird/blob/develop/CONTRIBUTING.md).
