Skip to main content

PypeIt Spectroscopic Reduction

Project description

PypeIt

PyPI Conda Version Conda Downloads

CI Tests Coverage (release) Coverage (develop) Documentation Status astropy

The Python Spectroscopic Data Reduction Pipeline. For documentation visit:

http://pypeit.readthedocs.io

and/or see our HOWTO:

https://tinyurl.com/pypeit-howto

and/or join our PypeIt Users Slack (the invite is recorded in this Issue: https://github.com/pypeit/PypeIt/issues/676)

Citation:

If you use PypeIt in your research, please cite the following publications (BibTeX entries are provided below):

DOI DOI

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 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}.

BibTeX

@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}
}

Contribute

We encourage anyone to help us develop the PypeIt code base to better suit your needs and to improve its algorithms. If you do so, please follow our Development Guidlines

In particular, please note our Code of Conduct.

Instruments Served

  • Bok/B&C
  • Gemini/GNIRS
  • Gemini/GMOS
  • Gemini/FLAMINGOS 2
  • GTC/OSIRIS
  • Lick/Kast
  • Magellan/MagE
  • Magellan/Fire
  • MMT/BinoSpec (270 and 600 tested)
  • MMT/MMIRS (HK_zJ, J_zJ, and K_K tested)
  • MMT/Blue Channel (300 tested)
  • MDM/OSMOS
  • Keck/DEIMOS (600ZD, 830G, 1200G)
  • Keck/KCWI (BM, BH2)
  • Keck/LRIS
  • Keck/MOSFIRE (J and Y gratings tested)
  • Keck/NIRES
  • Keck/NIRSPEC (low-dispersion)
  • LBT/Luci-I, Luci-II
  • LBT/MODS (beta)
  • LDT/DeVeny
  • Lick/APF (planned)
  • NOT/ALFOSC (grism4)
  • VLT/X-Shooter
  • VLT/FORS2 (300I, 300V)
  • WHT/ISIS
  • P200/DBSP (316/7500 on red arm, 600/4000 on blue arm)
  • P200/TripleSpec

Requirements

(see setup.cfg or environment.yml)

  • python
  • numpy
  • scipy
  • matplotlib
  • astropy
  • ginga
  • h5py
  • future
  • PyYAML
  • linetools
  • IPython
  • scikit-learn
  • configobj

License (BSD-3)

(see LICENSE.rst)

Copyright (c) 2018-2019, PypeIt Developers All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the Astropy Team nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pypeit-1.4.2.tar.gz (87.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pypeit-1.4.2-cp39-cp39-macosx_10_15_x86_64.whl (64.5 MB view details)

Uploaded CPython 3.9macOS 10.15+ x86-64

File details

Details for the file pypeit-1.4.2.tar.gz.

File metadata

  • Download URL: pypeit-1.4.2.tar.gz
  • Upload date:
  • Size: 87.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.5

File hashes

Hashes for pypeit-1.4.2.tar.gz
Algorithm Hash digest
SHA256 e781e111b4d410968a9e7b75fbfbf3a3390afe0f1c77b8c26bbc33c314bd257a
MD5 03c513c62bf9806771b6730ed4da0417
BLAKE2b-256 12c8ce4230d51134604b73fe11e708ea17fa994f334802f4cbbd8c8c468161c1

See more details on using hashes here.

File details

Details for the file pypeit-1.4.2-cp39-cp39-macosx_10_15_x86_64.whl.

File metadata

  • Download URL: pypeit-1.4.2-cp39-cp39-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 64.5 MB
  • Tags: CPython 3.9, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.5

File hashes

Hashes for pypeit-1.4.2-cp39-cp39-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 952dbefe30bfeb34f6736b8408b1f917ff5995e41ff4d26b6dc73bbcb31fa36a
MD5 03f360cbeb75125b73dd0b5c10552c0d
BLAKE2b-256 a7014d3c6ebb65036222b28793747b190c1807e25d4b985e425fd15fce1d244a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page