Skip to main content

A backwards-incompatible, python3 compatible, pyraf-free version of PyKE: a suite of tools to analyze Kepler/K2 data

Project description

# PyKE3: Kepler, K2 & TESS Data Analysis Tools [![Build Status](https://travis-ci.org/KeplerGO/PyKE.svg?branch=dev)](https://travis-ci.org/KeplerGO/PyKE) [![Documentation Status](https://readthedocs.org/projects/pyke/badge/?version=latest)](http://pyke.readthedocs.io/en/latest/?badge=latest) <a href=”http://ascl.net/1208.004”><img src=”https://img.shields.io/badge/ascl-1208.004-blue.svg?colorB=262255” alt=”ascl:1208.004” /></a>

*Developed since 2012, PyKE offers a user-friendly way to inspect and analyze the pixels and lightcurves obtained by NASA’s Kepler, K2, and TESS missions.*

Documentation: [pyke.readthedocs.io](pyke.readthedocs.io)

## What’s new in PyKE v3? (July 2017)

PyKE3 is the latest generation of the Kepler/K2/TESS toolkit. It provides the following key improvements: * PyKE is now a true Python package installable via pip; * tasks are now added to the path as unix-style command-line tools; * both Python 2 and 3 are now supported; * PyKE no longer depends on PyRAF and is TESS-ready.

## Example use

With pyke, you can directly visualize frames from a target pixel file. That can be done with kepmask as follows:

` $ kepmask kplr008462852-2013098041711_lpd-targ.fits.gz 100 --maskfile tabystar.txt `

![kepmask](docs/source/_static/images/readme/kepmask.png)

where 100 is the frame number. If you want to know all the features provided by kepmask, use --help argument.

kepmask is an interactive tool that allows one to create an arbitrary aperture mask which can be subsequently be used in another pyke tool, such as kepextract.

kepextract performs simple aperture photometry in the pixels given by the mask created by kepmask:

` $ kepextract kplr008462852-2013098041711_lpd-targ.fits.gz tabys-lc.fits --maskfile tabystar.txt `

To visualize the light curve, you may want to use kepdraw:

` $ kepdraw taby-lc.fits `

![kepdraw](docs/source/_static/images/readme/kepdraw.png)

## Installation

If you have a working version of Python 2 or 3 on your system (we recommend [Anaconda Python](https://www.continuum.io/downloads)), you can simply install the latest stable release of PyKE using pip:

$ pip install pyketools

Alternatively, if you want to experiment with the latest development version of PyKE, you can install it straight from GitHub:

$ git clone https://github.com/KeplerGO/PyKE.git $ cd PyKE $ pip install -e .

Note: PyKE version 2 and older, which was in use between 2012 and 2016 and required PyRAF, is available in the branch py27-pyraf.

## Documentation

Documentation is hosted at [pyke.readthedocs.io](pyke.readthedocs.io).

## Acknowledgement If you find this code useful in your research, please consider [citing](http://adsabs.harvard.edu/abs/2012ascl.soft08004S):

` Title:  PyKE: Reduction and analysis of Kepler Simple Aperture Photometry data Authors:          Still, Martin; Barclay, Tom Publication:      Astrophysics Source Code Library, record ascl:1208.004 Publication Date: 08/2012 `

This package is developed by Martin Still, Tom Barclay, Ze Vinicius, Geert Barentsen, Michael Gully-Santiago, Ann Marie Cody, and Christine Hedges for the Kepler/K2 GO Office.

## Contributing

Users are welcome to open [issues](https://github.com/KeplerGO/PyKE/issues) or [pull requests](https://github.com/KeplerGO/PyKE/pulls). You can also contact the development team via keplergo@mail.arc.nasa.gov

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 pyketools, version 3.0a0
Filename, size File type Python version Upload date Hashes
Filename, size pyketools-3.0a0.tar.gz (153.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page