Skip to main content

pyKLIP

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!

Metadata

Release files for pyklip 2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyklip 2.2
File Size Uploaded Provenance Actions
pyklip-2.2.tar.gz 11.2 MB Without provenance Details for pyklip-2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyklip 2.2
File Interpreter ABI Platform Actions
pyklip-2.2-py3-none-any.whl Python 3 none any Details for pyklip-2.2-py3-none-any.whl

Total release size: 22.3 MB

Release files / pyklip-2.2.tar.gz

Download URL pyklip-2.2.tar.gz
Size 11.2 MB
Tags Source
SHA-256 checksum
How to use checksums
597d20cc2732468c62f53c105bf2b3e5e41d79cc23ad22992605630820e99470
BLAKE2b-256 checksum
How to use checksums
dd7b0e6d61d3779bbdf97a11f7b6401d4f90ec2695cb782684de84d62f183447
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.10

Release files / pyklip-2.2-py3-none-any.whl

Download URL pyklip-2.2-py3-none-any.whl
Size 11.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
26840d547d9919a1a7c6ed95ea60d09c75407777500c3a7452eb0c8e302bf9f3
BLAKE2b-256 checksum
How to use checksums
c02e006872b35d2db6e67f4f643a5240ed7f3facae495c439d55177685045ad7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.10

Security for pyklip 2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page