User Guide

Welcome to the UVEX Transients User Guide, a tutorial-style tour of the library, layer by layer. For exhaustive per-class and per-function detail, see the API instead.

The package is organized into four independent layers, plus utility modules such as dust and utils, and a command-line interface that ties all four layers together.

Models

Module: models

The SpectralModel SED framework every transient class builds on.

• Models
• Writing a Custom Model

Transients

Module: transients

Pairs a SpectralModel with rate/duration metadata and samples event parameters via ExtragalacticTransient.

• Transients
• Writing a Custom Transient

Surveys

Module: surveys

Represents and validates a SurveySchedule of spacecraft actions.

• Surveys

Simulation

Module: simulation

Ties the above layers together into a EventCatalog via SurveySimulator.

• Simulation
• Yield Statistics

Command-Line Interface

Module: cli

Drives the layers above from a single YAML run-config and the uvex-transients console script, no Python required.

• Command-Line Interface