PypeIt
¶
Version: 1.3.0
PypeIt
is a Python package for semi-automated reduction of
astronomical, spectroscopic data. Its algorithms build on
decades-long development of previous data reduction pipelines by the
developers. The reduction procedure - including a complete list of
the input parameters and available functionality - is provided by
this online documentation.
PypeIt
is a set of commands designed to perform the reduction
without any additional coding.
This release of PypeIt
is designed to be used by both advanced
spectroscopists with prior data reduction expertise and astronomers
with no prior experience of data reduction. It is highly configurable
and designed to be applied to any standard slit-imaging spectrograph,
and can accommodate long-slit, multi-slit, as well as cross-dispersed
echelle spectra.
Citation¶
If you use PypeIt
in your research, please cite the following
publications (PypeIt BibTeX Entries are provided below):
If there is no place to include the relevant citations in the text of the publication, please include the following acknowledgement (provided in latex and using the provided PypeIt BibTeX Entries):
This research made use of \ttfamily{PypeIt},\footnote{\url{https://pypeit.readthedocs.io/en/latest/}}
a Python package for semi-automated reduction of astronomical slit-based spectroscopy
\citep{pypeit:joss_pub, pypeit:zenodo}.
What this version provides¶
Support for 20+ Spectrographs; see there for the full list, including those that are currently in various stages of development.
Gemini/GNIRS
Gemini/GMOS
Gemini/FLAMINGOS 2
Lick/Kast
Magellan/MagE
Magellan/Fire
MDM/OSMOS
Keck/DEIMOS (600ZD, 830G, 1200G)
Keck/KCWI (BM, BH2)
Keck/LRIS
Keck/MOSFIRE (Y, J, K gratings tested)
Keck/NIRES
Keck/NIRSPEC (low-dispersion; old detector)
LBT/Luci-I
LBT/Luci-II
LBT/MODS
MDM/OSMOS
MMT/MMIRS
MMT/binospec
NOT/ALFOSC
P200/DBSP
P200/TripleSpec
VLT/X-Shooter (VIS, NIR)
VLT/FORS2 (300I, 300V)
Default reduction algorithms
Flat Fielding with illumination pattern correction
Full 2D Wavelength Calibration (no rectification)
Flexure Correction (spatial and spectral)
Global and local Sky Subtraction
Optimal (and boxcar) Extraction
Slitmask metadata slurping including RA/DEC (Keck/DEIMOS only)
Documentation
Data Models for (nearly) all output files
Scripts and Tools for Inspection
Slit Edges – pypeit_chk_edges
Flats – pypeit_chk_flats
1D Spectra– pypeit_show_1dspec
2D Spectra– pypeit_show_2dspec
What this version is missing (i.e. what we are working on)¶
Full 2D coadd support
Additional QA outputs
A dashboard to monitor/control
PypeIt
Keck/HIRES, Keck/ESI support
Users¶
If you are mainly here to use PypeIt
to reduce your observational
data then this section is for you. Ideally, you will need to go not
much further than the few links in this section take you.
If you have problems, we have a very active “PypeIt Users” Slack workspace. We periodically update the invitation here. If you find a bug or have a feature request, please submit an issue.
Getting started
Running
Standard outputs
Further processing
For developers
Contributors¶
PypeIt
is an open-source, community developed package.
Astronomers are encouraged to join the project and should review our
Code of Conduct and PypeIt Development Procedures and Guidelines. We would also appreciate
if you contact the lead developers (JXP, JFH) before beginning
development activities.
The following persons have contributed substantially to the
development of PypeIt
.
J Xavier Prochaska
Joseph F. Hennawi
Kyle B. Westfall
Ryan J. Cooke
Feige Wang
Tiffany Hsyu
Frederick B. Davies
Emanuele Paolo Farina
Debora Pelliccia
James Reichwein
PypeIt BibTeX Entries¶
@ARTICLE{pypeit:joss_arXiv,
author = {{Prochaska}, J. Xavier and {Hennawi}, Joseph F. and {Westfall}, Kyle B. and
{Cooke}, Ryan J. and {Wang}, Feige and {Hsyu}, Tiffany and
{Davies}, Frederick B. and {Farina}, Emanuele Paolo},
title = "{PypeIt: The Python Spectroscopic Data Reduction Pipeline}",
journal = {arXiv e-prints},
keywords = {Astrophysics - Instrumentation and Methods for Astrophysics},
year = 2020,
month = may,
eid = {arXiv:2005.06505},
pages = {arXiv:2005.06505},
archivePrefix = {arXiv},
eprint = {2005.06505},
primaryClass = {astro-ph.IM},
adsurl = {https://ui.adsabs.harvard.edu/abs/2020arXiv200506505P},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
@article{pypeit:joss_pub,
doi = {10.21105/joss.02308},
url = {https://doi.org/10.21105/joss.02308},
year = {2020},
publisher = {The Open Journal},
volume = {5},
number = {56},
pages = {2308},
author = {J. Xavier Prochaska and Joseph F. Hennawi and Kyle B. Westfall and Ryan J. Cooke and Feige Wang and Tiffany Hsyu and Frederick B. Davies and Emanuele Paolo Farina and Debora Pelliccia},
title = {PypeIt: The Python Spectroscopic Data Reduction Pipeline},
journal = {Journal of Open Source Software}
}
@MISC{pypeit:zenodo,
author = {{Prochaska}, J. Xavier and {Hennawi}, Joseph and {Cooke}, Ryan and
{Westfall}, Kyle and {Wang}, Feige and {EmAstro} and {Tiffanyhsyu} and
{Wasserman}, Asher and {Villaume}, Alexa and {Marijana777} and
{Schindler}, JT and {Young}, David and {Simha}, Sunil and
{Wilde}, Matt and {Tejos}, Nicolas and {Isbell}, Jacob and
{Fl{\"o}rs}, Andreas and {Sandford}, Nathan and {Vasovi{\'c}}, Zlatan and
{Betts}, Edward and {Holden}, Brad},
title = "{pypeit/PypeIt: Release 1.0.0}",
year = 2020,
month = apr,
eid = {10.5281/zenodo.3743493},
doi = {10.5281/zenodo.3743493},
version = {v1.0.0},
publisher = {Zenodo},
adsurl = {https://ui.adsabs.harvard.edu/abs/2020zndo...3743493P},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}