Skip to main content

pyKLIP: PSF Subtraction for Exoplanets and Disks

Project description


Documentation Status build-status Coverage Status ASCL Reference PyPI version

A python library for PSF subtraction for both exoplanet and disk imaging. It uses a parallelized and optimzied implmentation of KLIP that supports ADI, SDI, and RDI with a variety of tunable parameters. For characterization, forward modelling tools include a suite of tools built off KLIP-FM for astrometry, spectroscopy, planet detection, and disk modelling. pyKLIP is modular and supports data from the Gemini Planet Imager, P1640, Keck/NIRC2, MagAO/VisAO, and SPHERE, with more on the way.

Want to get started? Check out the quick GPI KLIP tutorial for the basics of pyKLIP.

Development led by Jason Wang. Contributions made by Jonathan Aguilar, JB Ruffio, Rob de Rosa, Schuyler Wolff, Abhijith Rajan, Zack Briesemeister, Kate Follette, Maxwell Millar-Blanchaer, Alexandra Greenbaum, Simon Ko, Tom Esposito, Elijah Spiro, Pauline Arriaga, Bin Ren, Alan Rainot, Arthur Vigan, Graça Rocha, Jacob Golomb, Johan Mazoyer and Laurent Pueyo (see contributors.txt for a details).

If you use pyKLIP in your research, please cite the Astrophysical Source Code Library record of it: ASCL or ADS.

Wang, J. J., Ruffio, J.-B., De Rosa, R. J., et al. 2015, Astrophysics Source Code Library, ascl:1506.001

For setup instructions, example code, and API details, read the documentation online!

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 pyklip, version 2.2
Filename, size File type Python version Upload date Hashes
Filename, size pyklip-2.2-py3-none-any.whl (11.2 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pyklip-2.2.tar.gz (11.2 MB) 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