API

This page provides the complete reference for all public classes, functions, and modules in the UVEX Transients codebase.

Models

Spectral and light-curve models for individual transient classes, built on a common core SED framework.

uvex_transients.models

Spectral modeling infrastructure for generating synthetic photometry.

Transients

Transient population classes, pairing a model with the rate/metadata needed to run a Monte Carlo survey simulation.

uvex_transients.transients

Transient population base classes composing a TransientSED with rate/metadata.

Simulation

Monte Carlo sampling of transient populations against a survey schedule.

uvex_transients.simulation

Monte Carlo simulation of transient detectability against a survey schedule.

Surveys

Representation and validation of survey schedules.

uvex_transients.surveys

Survey schedule representation, validation, and I/O.

Command-Line Interface

The uvex-transients console script: a YAML-driven wrapper around uvex_transients.simulation.

uvex_transients.cli

Command-line interface for uvex_transients.

Utilities

uvex_transients.dust	Milky Way foreground dust extinction.
uvex_transients.utils	Package-wide configuration, logging, and random-number-generation helpers.