PREFACE Documentation
=====================

**P**\ rioritization and **R**\ anking of **E**\ xoplanets **F**\ or **A**\ stronomical
**C**\ haracterization and **E**\ xploration (**PREFACE**) is a Python package containing
an end-to-end pipeline for selection of promising exoplanet transmission spectroscopy observations
based on their expected scientific return and observational feasibility.

PREFACE combines telescope characteristics, target properties, observing windows,
detector effects, airmass, and optional moonlight modelling to produce numerically
ranked observing opportunities for transit follow-up campaigns.

.. toctree::
   :maxdepth: 2
   :caption: Contents

   installation
   quickstart
   configuration
   outputs
   workflow
   utilities
   api