DBSP_DRP

DBSP_DRP: A Python package for automated spectroscopic data reduction of DBSP data - Published in JOSS (2022)

https://github.com/finagle29/dbsp_drp

Science Score: 93.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 22 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 6 months ago · JSON representation

Repository

Fully-automated data reduction pipeline for DBSP built with PypeIt

Basic Info
  • Host: GitHub
  • Owner: finagle29
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 14.1 MB
Statistics
  • Stars: 8
  • Watchers: 1
  • Forks: 0
  • Open Issues: 4
  • Releases: 2
Created over 5 years ago · Last pushed almost 3 years ago
Metadata Files
Readme License

README.md

Documentation Status Test DOI

PyPI version conda-forge version pip downloads conda downloads

DBSP_DRP

Description

DBSPDRP is a Data Reduction Pipeline for Palomar's workhorse spectrograph DBSP. It is built on top of PypeIt. DBSPDRP automates the reduction, fluxing, telluric correction, and combining of the red and blue sides of one night's data. It adds several GUIs to allow for easier control of your reduction: - select which data to reduce, and verify the correctness of your FITS headers in an editable table GUI - manually place traces for a sort of manually "forced" spectroscopy with the -m option - after manually placing traces, manually select sky regions and tweak the FWHM of your manual traces

The latest documentation can be found on Read the Docs.

Citation

If you use DBSP_DRP in your research, please cite the following publications, or use the BibTeX provided below. DOI DOI

Additionally, please cite PypeIt, with the BibTeX entries provided below (the Zenodo BibTex is for PypeIt 1.6.0, used in this version of DBSP_DRP).

DBSP_DRP BibTeX

@article{dbsp_drp:joss, doi = {10.21105/joss.03612}, url = {https://doi.org/10.21105/joss.03612}, year = {2022}, publisher = {The Open Journal}, volume = {7}, number = {70}, pages = {3612}, author = {Milan Sharma Mandigo-Stoba and Christoffer Fremling and Mansi M. Kasliwal}, title = {DBSP_DRP: A Python package for automated spectroscopic data reduction of DBSP data}, journal = {Journal of Open Source Software} } @misc{dbsp_drp:arxiv, title={DBSP_DRP: A Python package for automated spectroscopic data reduction of DBSP data}, author={Milan Sharma Mandigo-Stoba and Christoffer Fremling and Mansi M. Kasliwal}, year={2021}, eprint={2107.12339}, archivePrefix={arXiv}, primaryClass={astro-ph.IM} } @software{dbsp_drp:zenodo, author = {Mandigo-Stoba, Milan Sharma and Fremling, Christoffer and Kasliwal, Mansi M.}, title = {{DBSP\_DRP: A Python package for automated spectroscopic data reduction of DBSP data}}, month = feb, year = 2022, publisher = {Zenodo}, version = {v1.0.0}, doi = {10.5281/zenodo.6241526}, url = {https://doi.org/10.5281/zenodo.6241526} }

PypeIt BibTeX

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

@software{pypeit:zenodovv16, author = {J. Xavier Prochaska and Joseph Hennawi and Ryan Cooke and Kyle Westfall and Feige Wang and Debora Pelliccia and EmAstro and Milan Roberson and T. E. Pickering and tiffanyhsyu and badpandabear and Asher Wasserman and Timothy Ellsworth Bowers and Nicolas Tejos and Alexa Villaume and Brad Holden and marijana777 and Sunil Simha and JT Schindler and David Young and Andreas Flörs and Matt Wilde and S.Tang and Erik Tollerud and Jacob Isbell and Kristen Thyng and Dan Foreman-Mackey and David Jones and Edward Betts and Zlatan Vasović}, title = {pypeit/PypeIt: Version 1.6.0}, month = oct, year = 2021, publisher = {Zenodo}, version = {1.6.0}, doi = {10.5281/zenodo.5548381}, url = {https://doi.org/10.5281/zenodo.5548381} } ```

Prerequisites

DBSPDRP's dependencies are detailed in environment.yml. You can install all prerequisites for a pip or source install by downloading the environment.yml file, navigating to the directory containing it in your terminal window and running ```shellsession $ conda env create -f environment.yml `` Installing DBSP_DRP usingconda` does not require this step.

The telluric correction code provided by PypeIt relies on a large (5 GB) atmospheric model file, TellFitsLick310011100R10000.fits, which can be downloaded here and must be installed into the pypeit/data/telluric/ directory of your PypeIt installation.

An easier alternative is to use the download_tellfile script to download and install the atmospheric model file for you.

Installation

You can install using conda shell_session $ conda install -c conda-forge dbsp_drp

or pip shell_session $ pip install dbsp-drp

Or you can install from source shell_session $ git clone https://github.com/finagle29/DBSP_DRP.git $ cd DBSP_DRP $ pip install -e .

Usage

shell_session $ dbsp_reduce -r /path/to/data/DBSP_YYYYMMDD -d /path/to/data/DBSP_YYYYMMDD_redux [-a {red,blue}] [-i] [-m] [--debug] [-j N] [-p PARAMETER_FILE] [-t] [-c] [--splicing-interpolate-gaps]

Owner

  • Name: Milan Sharma Mandigo-Stoba
  • Login: finagle29
  • Kind: user

JOSS Publication

DBSP_DRP: A Python package for automated spectroscopic data reduction of DBSP data
Published
March 21, 2022
Volume 7, Issue 71, Page 3612
Authors
Milan Sharma Mandigo-Stoba ORCID
Schmidt Academy of Software Engineering, California Institute of Technology, Division of Physics, Mathematics and Astronomy, California Institute of Technology
Christoffer Fremling ORCID
Division of Physics, Mathematics and Astronomy, California Institute of Technology
Mansi M. Kasliwal ORCID
Division of Physics, Mathematics and Astronomy, California Institute of Technology
Editor
Arfon Smith ORCID
Tags
astronomy data reduction spectroscopy

GitHub Events

Total
  • Watch event: 3
  • Issue comment event: 5
Last Year
  • Watch event: 3
  • Issue comment event: 5

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 353
  • Total Committers: 1
  • Avg Commits per committer: 353.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Milan Roberson f****9@g****m 353

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 10
  • Total pull requests: 26
  • Average time to close issues: 3 months
  • Average time to close pull requests: 10 days
  • Total issue authors: 4
  • Total pull request authors: 1
  • Average comments per issue: 1.8
  • Average comments per pull request: 0.77
  • Merged pull requests: 23
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • finagle29 (4)
  • arjunsavel (4)
  • yaoyuhan (1)
  • lichengy5 (1)
Pull Request Authors
  • finagle29 (26)
Top Labels
Issue Labels
enhancement (3) documentation (1)
Pull Request Labels
documentation (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 21 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 5
  • Total maintainers: 1
pypi.org: dbsp-drp

"Automated Data Reduction Pipeline for Palomar's Double Spectrograph"

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 21 Last month
Rankings
Dependent packages count: 10.0%
Stargazers count: 19.3%
Dependent repos count: 21.8%
Average: 24.2%
Forks count: 29.8%
Downloads: 40.0%
Maintainers (1)
Last synced: 6 months ago
conda-forge.org: dbsp_drp

DBSP_DRP is a Data Reduction Pipeline for Palomar's workhorse spectrograph DBSP. It is built on top of PypeIt. DBSP_DRP automates the reduction, fluxing, telluric correction, and combining of the red and blue sides of one night's data. It adds several GUIs to allow for easier control of your reduction: - select which data to reduce, and verify the correctness of your FITS headers in an editable table GUI - manually place traces for a sort of manually "forced" spectroscopy with the `-m` option - after manually placing traces, manually select sky regions and tweak the FWHM of your manual traces

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Average: 50.5%
Dependent packages count: 51.2%
Stargazers count: 55.7%
Forks count: 61.1%
Last synced: 7 months ago

Dependencies

docs/requirements.txt pypi
  • astropy *
  • configobj *
  • matplotlib *
  • numpy *
  • pypeit *
  • pytest *
  • scipy *
  • tqdm *
  • yattag *
.github/workflows/docker.yml actions
  • actions/checkout v2 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/metadata-action v3 composite
  • docker/setup-buildx-action v1 composite
  • docker/setup-qemu-action v1 composite
.github/workflows/test.yml actions
  • actions/checkout v2 composite
  • conda-incubator/setup-miniconda v2 composite
Dockerfile docker
  • condaforge/miniforge3 latest build
  • dbsp_ql latest build
pyproject.toml pypi
setup.py pypi
environment.yml conda
  • astropy >=4.0
  • configobj >=5
  • matplotlib >=3.1,<3.5
  • numpy >=1.16.0,<1.24
  • pypeit 1.6.0
  • pyside2 >=5.12
  • pytest >=3.0.7
  • python >=3.8
  • scipy >=1.4
  • tqdm >=4.52
  • yattag >=1.13