PypeIt

PypeIt: The Python Spectroscopic Data Reduction Pipeline - Published in JOSS (2020)

https://github.com/pypeit/pypeit

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 8 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: arxiv.org, joss.theoj.org, zenodo.org
  • Committers with academic emails
    19 of 63 committers (30.2%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords from Contributors

astronomy mcmc

Scientific Fields

Mathematics Computer Science - 84% confidence
Artificial Intelligence and Machine Learning Computer Science - 83% confidence
Last synced: 4 months ago · JSON representation

Repository

The Python Spectroscopic Data Reduction Pipeline

Basic Info
  • Host: GitHub
  • Owner: pypeit
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: release
  • Size: 1.34 GB
Statistics
  • Stars: 185
  • Watchers: 24
  • Forks: 118
  • Open Issues: 117
  • Releases: 28
Created over 10 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog License Citation

README.rst

.. |PyPI| image:: https://img.shields.io/pypi/v/pypeit?label=PyPI&logo=pypi&logoColor=white
    :target: https://pypi.org/project/pypeit/#history

.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/pypeit
    :target: https://pypi.org/project/pypeit/#files

.. |License| image:: https://img.shields.io/github/license/pypeit/PypeIt
   :target: https://github.com/pypeit/PypeIt/blob/release/LICENSE.rst

.. |CITests| image:: https://github.com/pypeit/PypeIt/workflows/CI%20Tests/badge.svg
    :target: https://github.com/pypeit/PypeIt/actions?query=workflow%3A"CI+Tests"

.. |docs| image:: https://readthedocs.org/projects/pypeit/badge/?version=latest
    :target: https://pypeit.readthedocs.io/en/latest/

.. |DOI_latest| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3743493.svg
   :target: https://doi.org/10.5281/zenodo.3743493

.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.02308/status.svg
   :target: https://doi.org/10.21105/joss.02308

.. |arxiv| image:: https://img.shields.io/badge/arxiv-2005.06505-black
   :target: https://arxiv.org/abs/2005.06505

.. |astropy| image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
    :target: http://www.astropy.org/

.. |forks| image:: https://img.shields.io/github/forks/pypeit/PypeIt?style=social
   :target: https://github.com/pypeit/PypeIt

.. |stars| image:: https://img.shields.io/github/stars/pypeit/PypeIt?style=social
   :target: https://github.com/pypeit/PypeIt

.. |github| image:: https://img.shields.io/badge/GitHub-PypeIt-brightgreen
   :target: https://github.com/pypeit/PypeIt


.. image:: https://raw.githubusercontent.com/pypeit/PypeIt/release/doc/_static/PypeIt_color_white_txt_black_background.png
    :target: https://github.com/pypeit/PypeIt
    :width: 485


PypeIt |forks| |stars|
======================

|github| |pypi| |pypi_downloads| |License|

|docs| |CITests|

|DOI_latest| |JOSS| |arxiv|

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 our `online documentation
`__.

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, including long-slit, multi-slit, as well as
cross-dispersed echelle spectra.  **The spectrographs that PypeIt can be used
with are listed** `here
`__.

Also note that `this link
`__
contains some useful information about reducing data
with certain instruments that you might also find helpful.

In addition to our primary code base, we maintain an extensive `development
suite `__ primarily used to
perform multiple layers of code testing, from basic unit tests to full
end-to-end tests of all our command-line scripts.  **If you are new to PypeIt,
you are encouraged to pull example data from the DevSuite for your instrument
when learning how to use the software.**

----

.. _community:

Community
+++++++++

As a project, PypeIt is committed to fostering a welcoming, diverse, and
inclusive community.  As a member of this community you are expected to read and
follow our `Code of Conduct
`__.

Along with our extensive `online documentation
`__, we encourage the PypeIt user
base to communicate via our `PypeIt Users Slack `__.
All are welcome to join using `this invitation link `__.

If you find a bug (particularly one that is experienced by others in the Users
Slack) or have a feature request, please `submit an issue
`__.

----

Citation
++++++++

If you use PypeIt in your research, please cite the following publications
(we provide the relevant `BibTeX entries
`__
for your convenience):

 - Prochaska et al. (2020, JOSS): `arXiv `__, `JOSS `__
 - Prochaska et al. (2020, Zenodo): `Zenodo `__

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
`__):

.. code-block:: latex

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

----

Funding
+++++++

PypeIt receives direct funding from the following sources:

  * NASA ADAP (A20-0412, 20-1018)
  * W.M. Keck Observatory
  * University of California Observatories

We also rely on important in-kind contributions from individuals at
Caltech, the Multiple Mirror Observatory, and elsewhere.

----

Developers
++++++++++

PypeIt is an open-source, community developed package.  Astronomers are
encouraged to join the project and should review our `Code of Conduct
`__ and `Development
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 (JXP)
* Joseph F. Hennawi (JFH)
* Kyle B. Westfall
* Ryan J. Cooke
* Feige Wang
* Tiffany Hsyu
* Frederick B. Davies
* Emanuele Paolo Farina
* Debora Pelliccia
* James Reichwein
* Milan Roberson
* Timothy Pickering
* Timothy Ellsworth-Bowers
* Gregory Simonian
* Heather Martin

Owner

  • Name: PypeIt
  • Login: pypeit
  • Kind: organization

JOSS Publication

PypeIt: The Python Spectroscopic Data Reduction Pipeline
Published
December 16, 2020
Volume 5, Issue 56, Page 2308
Authors
J. Xavier Prochaska ORCID
University of California, Santa Cruz, Kavli Institute for the Physics and Mathematics of the Universe
Joseph F. Hennawi ORCID
University of California, Santa Barbara
Kyle B. Westfall ORCID
University of California Observatories
Ryan J. Cooke ORCID
Durham University, UK
Feige Wang ORCID
Kavli Institute for the Physics and Mathematics of the Universe, Steward Observatory, University of Arizona
Tiffany Hsyu ORCID
University of California, Santa Cruz
Frederick B. Davies ORCID
Kavli Institute for the Physics and Mathematics of the Universe, Lawrence Berkeley National Laboratory
Emanuele Paolo Farina ORCID
Kavli Institute for the Physics and Mathematics of the Universe, Max Planck Institut f\"{u}r Astrophysik
Debora Pelliccia ORCID
University of California Observatories
Editor
Dan Foreman-Mackey ORCID
Tags
astronomy data reduction spectroscopy

GitHub Events

Total
  • Create event: 62
  • Release event: 4
  • Issues event: 55
  • Watch event: 20
  • Delete event: 66
  • Member event: 1
  • Issue comment event: 173
  • Push event: 492
  • Pull request event: 115
  • Pull request review comment event: 245
  • Pull request review event: 272
  • Fork event: 18
Last Year
  • Create event: 62
  • Release event: 4
  • Issues event: 55
  • Watch event: 20
  • Delete event: 66
  • Member event: 1
  • Issue comment event: 173
  • Push event: 493
  • Pull request event: 115
  • Pull request review comment event: 245
  • Pull request review event: 272
  • Fork event: 18

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 13,267
  • Total Committers: 63
  • Avg Commits per committer: 210.587
  • Development Distribution Score (DDS): 0.742
Past Year
  • Commits: 377
  • Committers: 12
  • Avg Commits per committer: 31.417
  • Development Distribution Score (DDS): 0.687
Top Committers
Name Email Commits
profxj x****r@u****g 3,427
joe j****e@p****u 2,447
rcooke-ast r****t@g****m 2,198
Kyle Westfall w****l@u****g 1,785
Debora Pelliccia d****a@u****g 810
Feige Wang f****o@g****m 469
rcooke-ast r****t@g****m 297
Timothy P. Ellsworth Bowers t****s@l****u 263
profxj x****r@u****g 204
EmAstro e****a@g****m 176
T. E. Pickering t****g@g****m 172
Milan Roberson f****9@g****m 128
Adolfo Carvalho a****o@g****m 128
Dusty Reichwein d****y@u****g 114
Frederick Davies d****s@m****e 92
thsyu t****u@u****u 86
Dusty Reichwein j****e@u****u 65
Frederick Davies d****s@p****u 47
SunilSimha s****5@g****m 40
Asher Wasserman a****n@g****m 38
Tang Shenli t****g@T****l 28
ShaneBechtel s****l@y****m 22
Dave d****s@i****s 21
suksien h****n@y****y 20
Joseph Hennawi j****i 19
Alexa Villaume a****m@u****u 18
Dave d****e@g****m 17
hnmartin 1****n 17
ntejos n****s@g****m 17
Bradford Holden b****n@g****m 16
and 33 more...

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 121
  • Total pull requests: 458
  • Average time to close issues: 3 months
  • Average time to close pull requests: 15 days
  • Total issue authors: 61
  • Total pull request authors: 28
  • Average comments per issue: 1.63
  • Average comments per pull request: 2.16
  • Merged pull requests: 394
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 39
  • Pull requests: 137
  • Average time to close issues: 26 days
  • Average time to close pull requests: 9 days
  • Issue authors: 21
  • Pull request authors: 18
  • Average comments per issue: 0.77
  • Average comments per pull request: 1.11
  • Merged pull requests: 96
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • rcooke-ast (15)
  • kbwestfall (13)
  • jhennawi (12)
  • tbowers7 (7)
  • debora-pe (5)
  • opkuhn (3)
  • profxj (3)
  • jasonpeng17 (2)
  • xiejuan-dot (2)
  • jhod0 (2)
  • orenir49 (2)
  • ddobie (2)
  • badpandabear (2)
  • fawkez (2)
  • Mao-PH (2)
Pull Request Authors
  • kbwestfall (104)
  • rcooke-ast (87)
  • debora-pe (67)
  • profxj (36)
  • tbowers7 (24)
  • badpandabear (23)
  • Adolfo1519 (19)
  • jhennawi (17)
  • freddavies (17)
  • ejeschke (9)
  • SunilSimha (8)
  • tepickering (8)
  • wmorgali (6)
  • Raindogjones (5)
  • jhod0 (4)
Top Labels
Issue Labels
bug (10) enhancement (9) development (5) docs (2) IFU (2)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 257 last-month
  • Total dependent packages: 3
    (may contain duplicates)
  • Total dependent repositories: 4
    (may contain duplicates)
  • Total versions: 59
  • Total maintainers: 2
pypi.org: pypeit

PypeIt Spectroscopic Reduction

  • Versions: 43
  • Dependent Packages: 2
  • Dependent Repositories: 3
  • Downloads: 257 Last month
Rankings
Dependent packages count: 3.2%
Forks count: 4.7%
Stargazers count: 6.3%
Average: 7.0%
Dependent repos count: 8.9%
Downloads: 11.7%
Maintainers (2)
Last synced: 4 months ago
conda-forge.org: pypeit

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. PypeIt is a set of commands designed to perform the reduction without any additional coding.

  • Versions: 16
  • Dependent Packages: 1
  • Dependent Repositories: 1
Rankings
Forks count: 19.8%
Dependent repos count: 24.4%
Average: 26.1%
Dependent packages count: 29.0%
Stargazers count: 31.2%
Last synced: 4 months ago

Dependencies

.github/workflows/ci_cron.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/ci_tests.yml actions
  • actions/checkout v2 composite
  • actions/checkout v1 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v1 composite
deprecated/requirements.txt pypi
  • IPython >=7.2.0
  • PyYAML >=5.1
  • QtPy >=1.9
  • astropy >=4.0
  • configobj >=5.0.6
  • extension-helpers >=0.1
  • ginga >=3.0
  • linetools >=0.3.dev2231
  • matplotlib >=3.1
  • numpy >=1.18.0
  • packaging >=19.0
  • requests >=2.23
  • scikit-learn >=0.20
  • scipy >=1.4
deprecated/requirements_doc.txt pypi
  • Sphinx >=3.0
  • sphinx-automodapi >=0.12
  • sphinx_rtd_theme >=0.5
deprecated/setup.py pypi
  • for *
  • if *
  • line.strip *
pypeit/scripts/setup.py pypi
pyproject.toml pypi
setup.py pypi
environment.yml conda
  • pip
  • python >=3.11,<3.14