Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Tools to inspect and analyze the pixels and lightcurves obtained by NASA's Kepler, K2, and TESS space telescopes.

Project description

Easy command line tools for Kepler, K2 & TESS data analysis.

pypi-badge ci-badge appveyor-badge doi-badge

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

Documentation is hosted at pyke.keplerscience.org.

What’s new in PyKE v3.1? (January 2017)

PyKE3 is the latest generation of the Kepler/K2/TESS toolkit. It provides the following key improvements:

  • PyKE3 is now a pip-installable package and supports both Python 2 and 3
  • tasks are now available both as command-line tools and Python functions
  • documentation and tutorials are now generated using Sphinx
  • PyKE3 provides an easy interface to play with target pixel files and light curve files from within a Python session
  • The PRF photometry tools were refactored into a more flexible interface

See the following IPython notebook for examples of the new features and changes: http://pyke.keplerscience.org/tutorials/ipython_notebooks/whatsnew31.html.

Quickstart

If you have a working version of Python 2 or 3 on your system (we recommend Anaconda Python), you can simply install the latest stable release of PyKE using pip:

$ pip install pyketools

With PyKE installed, you can directly visualize frames from a target pixel file. For example, let’s visualize the pixels of Kepler target KIC008462852 (a.k.a. Tabby’s Star):

$ kepmask kplr008462852-2013098041711_lpd-targ.fits.gz --maskfile mask.txt
http://pyke.keplerscience.org/_images/kepmask1.png

kepmask is an interactive tool used to create a custom aperture mask which can subsequently be used in other PyKE tasks.

For example, we can now use the kepextract task to perform aperture photometry using the pixels defined using kepmask above:

$ kepextract kplr008462852-2013098041711_lpd-targ.fits.gz --outfile lightcurve.fits --maskfile mask.txt

This creates a file called lightcurve.fits which contains a lightcurve in a format similar to those found in the official archive. To visualize the resulting light curve, we can use kepdraw:

$ kepdraw lightcurve.fits
http://pyke.keplerscience.org/_images/kepdraw1.png

Contributing

Users are welcome to open issues or pull requests. You can also contact the development team via keplergo@mail.arc.nasa.gov

Citing

If you find this code useful in your research, please cite both (Vinícius et al. 2017) and (Still & Barclay, 2012) using the BibTeX provided below. Also, please give us a GitHub star!

@misc{pyke3,
  author       = {Zé Vinícius and
                  Geert Barentsen and
                  Michael Gully-Santiago and
                  Ann Marie Cody and
                  Christina Hedges and
                  Martin Still and
                  Tom Barclay},
  title        = {KeplerGO/PyKE},
  month        = jul,
  year         = 2017,
  doi          = {10.5281/zenodo.835583},
  url          = {https://doi.org/10.5281/zenodo.835583}
}

@misc{2012ascl.soft08004S,
  author       = {{Still}, M. and {Barclay}, T.},
  title        = "{PyKE: Reduction and analysis of Kepler Simple Aperture Photometry data}",
  keywords     = {Software},
  howpublished = {Astrophysics Source Code Library},
  year         = 2012,
  month        = aug,
  archivePrefix= "ascl",
  eprint       = {1208.004},
  adsurl       = {http://adsabs.harvard.edu/abs/2012ascl.soft08004S}
}

Project details


Release history Release notifications

This version
History Node

3.1.0

History Node

3.1b1

History Node

3.1b0

History Node

3.0.0

History Node

3.0b5

History Node

3.0b4

History Node

3.0b3

History Node

3.0b2

History Node

3.0b1

History Node

3.0a1

History Node

3.0a0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pyketools-3.1.0.tar.gz (180.9 kB) Copy SHA256 hash SHA256 Source None Jan 26, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page