Skip to main content

PypeIt Spectroscopic Reduction

Project description

PypeIt

PyPI Conda Version Conda Downloads

CI Tests 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)
  • 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.1.tar.gz (87.5 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.1-cp39-cp39-macosx_10_15_x86_64.whl (64.3 MB view details)

Uploaded CPython 3.9macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: pypeit-1.4.1.tar.gz
  • Upload date:
  • Size: 87.5 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.1.tar.gz
Algorithm Hash digest
SHA256 21755b106465240ab1098617c57bafe2ebbcc41868d036b0893f367ddea7dab8
MD5 f980714c274671b36d8184d1ad536544
BLAKE2b-256 17bae2c21a24a4fe4d41dcac082c21c0560446e9f979a9729dfa26f9fc47a637

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pypeit-1.4.1-cp39-cp39-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 64.3 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.1-cp39-cp39-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 c229f7d3a319a9c07649de827e1527556f82a49d4a8a289de64213f8bebbd0a2
MD5 e635b5e42b316d7d1276bad388ae85a5
BLAKE2b-256 d3c88f01026f0013a8a15107846cf743aa2d9b19589bd803de4b85ad08686e70

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