Installation

Requirements

• Python 3.10 or later
• A working internet connection (for downloading light curves from MAST)

Basic install

Create a conda environment and install from PyPI:

conda create -n quicklook python=3.12
conda activate quicklook
pip install -U quicklook-package

This installs the ql, read_tls, and rank_tls command-line tools plus the Python API.

Install with Web GUI

The web GUI requires additional dependencies (Flask, flask-sock). Install them with:

pip install -U "quicklook-package[gui]"

This adds the ql-gui command.

Install for notebooks

To run QuickLook interactively in Jupyter:

pip install -U "quicklook-package[notebooks]"

Development install

Clone the repository and install in editable mode with all extras:

git clone https://github.com/jpdeleon/quicklook.git
cd quicklook
pip install -e ".[dev,gui,notebooks]"

This installs testing tools (pytest, black, ruff, tox) and enables live code changes without reinstalling.

Verifying the install

# Check the CLI
ql --help

# Check imports
python -c "from quicklook import TessQuickLook; print('OK')"

Dependencies

QuickLook depends on these core packages (installed automatically):

Package	Purpose
lightkurve	TESS/Kepler light curve search and download
transitleastsquares	Transit detection periodogram
wotan	Light curve detrending/flattening
astropy	Coordinates, units, FITS I/O
matplotlib	Plotting
numpy	Numerical computation
h5py	HDF5 file I/O for TLS results
reproject	Archival image reprojection
loguru	Logging