Skip to main content

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

Project description

<p align=”center”><img width = “400” src=”https://github.com/christinahedges/contaminante/blob/master/docs/figures/logo.png?raw=true”/></p>

# contaminante kohn - tah - mee - nahn - teh

[Read the docs here!](http://christinahedges.github.io/contaminante)

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.

<center><img width = “900” src=”https://github.com/christinahedges/contaminante/blob/master/docs/figures/FP.png?raw=true”/></center>

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

<center><img width = “900” src=”https://github.com/christinahedges/contaminante/blob/master/docs/figures/real.png?raw=true”/></center>

## How do I use contaminante?

You can check out our [tutorial](https://christinahedges.github.io/contaminante/_build/html/tutorial.html) 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](https://colab.research.google.com/github/christinahedges/contaminante/blob/master/tutorials/Colaboratory-Notebook.ipynb) to open a new Colaboratory notebook and run contaminante in the cloud!

## Dependencies

contaminante uses the most up to date version of [lightkurve](https://github.com/keplerGO/lightkurve), and uses some of the features available in v2.0. Make sure your lightkurve installation is up to date before using contaminante.

Project details


Download files

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

Files for contaminante, version 0.5.3
Filename, size File type Python version Upload date Hashes
Filename, size contaminante-0.5.3.tar.gz (8.3 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page