contaminante

Find the contaminant transiting source in Kepler, K2 or TESS data.

https://github.com/christinahedges/contaminante

Science Score: 44.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Find the contaminant transiting source in Kepler, K2 or TESS data.

Basic Info
  • Host: GitHub
  • Owner: christinahedges
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 46.1 MB
Statistics
  • Stars: 7
  • Watchers: 2
  • Forks: 4
  • Open Issues: 13
  • Releases: 2
Created almost 6 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

contaminante

kohn - tah - mee - nahn - teh

Read the docs here!

A package to help find the contaminant transiting source in NASA's Kepler, K2 or TESS data. When hunting for transiting planets, sometimes signals come from neighboring contaminants. This package helps users identify where the transiting signal comes from in their data.

What does contaminante do?

contaminante uses pixel level modeling of the TargetPixelFile data from NASA's astrophysics missions that are processed with the Kepler pipeline. The output of contaminante is a Python dictionary containing the source location and transit depth, and a contaminant location and depth. Optionally you can output a figure showing

  1. Where the main target is centered in all available TPFs.
  2. What the phase curve looks like for the main target
  3. Where the transiting source is centered in all available TPFs, if a transiting source is located outside the main target
  4. The transiting source phase curve, if a transiting source is located outside the main target

An example output is shown below for a target with a transiting contaminant.

Where as a transit that is centered on the target gives the following output:

How do I use contaminante?

You can check out our tutorial for how to run contaminante. To run contaminante you will need a target name, a transit period, a transit center and a transit duration.

How do I install contaminante?

You can install contaminante using pip:

pip install contaminante --upgrade

You can also install contaminante by cloning this repo:

git clone https://github.com/christinahedges/contaminante cd contaminante python setup.py install

Help, I can't install contaminante!

You might not be able to install contaminante because your computer doesn't support some of the features, or perhaps you're new to Python. Don't worry, you can still use contaminante! If you're struggling to install, try running contaminante online using Google's Colaboratory. You can click here to open a new Colaboratory notebook and run contaminante in the cloud!

Dependencies

contaminante uses the most up to date version of lightkurve, and uses some of the features available in v2.0. Make sure your lightkurve installation is up to date before using contaminante.

Owner

  • Name: Christina Hedges
  • Login: christinahedges
  • Kind: user
  • Location: NASA Ames
  • Company: Research Scientist

Data driven astronomer

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Hedges
  given-names: Christina
  orcid: "https://orcid.org/0000-0002-3385-8391"
- family-names: Saunders
  given-names: Nicholas
  orcid: "https://orcid.org/0000-0003-2657-3889"
- family-names: Martínez-Palomera
  given-names: Jorge
  orcid: "https://orcid.org/0000-0002-7395-4935"
title: "contaminante"
version: 0.5.6
doi: 10.3847/2515-5172/ac3765
date-released: 2021-11-2
url: "https://github.com/christinahedges/contaminante"
preferred-citation:
  type: article
  authors:
  - family-names: Hedges
    given-names: Christina
    orcid: "https://orcid.org/0000-0002-3385-8391"
  - family-names: Saunders
    given-names: Nicholas
    orcid: "https://orcid.org/0000-0003-2657-3889"
  - family-names: Martínez-Palomera
    given-names: Jorge
    orcid: "https://orcid.org/0000-0002-7395-4935"
  doi: 10.3847/2515-5172/ac3765
  journal: "Research Notes of the American Astronomical Society"
  month: 11
  start: 260 # First page number
  end: 261 # Last page number
  title: "Contaminante: A Tool for Automatically Finding a Close-to-optimal Aperture for Transiting Signals in Kepler, K2, and TESS Data"
  issue: 11
  volume: 5
  year: 2021

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 6
  • Total pull requests: 21
  • Average time to close issues: 7 months
  • Average time to close pull requests: 18 days
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 0.67
  • Average comments per pull request: 0.14
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 13
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
  • christinahedges (2)
  • danhey (2)
  • ExoRob (1)
  • nksaunders (1)
Pull Request Authors
  • dependabot[bot] (12)
  • christinahedges (6)
  • orionlee (2)
Top Labels
Issue Labels
Pull Request Labels
dependencies (12)

Dependencies

poetry.lock pypi
  • 119 dependencies
pyproject.toml pypi
  • black ^21.10b0 develop
  • jupyterlab ^3.2.1 develop
  • pytest ^6.2.5 develop
  • vetting ^0.2 develop
  • astropy ^4.3.1
  • lightkurve ^2.0.11
  • matplotlib ^3.4.3
  • numpy ^1.21.3
  • pandas ^1.3.4
  • python >=3.8,<3.10
  • scipy ^1.7.1
  • tqdm ^4.62.3
requirements.txt pypi
  • astropy >=1.3
  • lightkurve >=2.0.9
  • matplotlib >=1.5.3
  • numpy >=1.11
  • pandas *
  • scipy >=0.19.0,
  • tqdm >=4.25.0
.github/workflows/black.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • psf/black 20.8b1 composite
.github/workflows/tests.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite