uvex_logo

UVEX Transients

End-to-end simulations of transients from UVEX all-sky surveys.

PyPI version Supported Python versions Docstring style: numpydoc Ruff pre-commit Commit style: Conventional + Gitmoji Commit style: Conventional Commits Latest Docs GitHub Contributors Last Commit Powered by Astropy Powered by Numba Powered by m4opt

Overview#

UVEX Transients is a Python toolkit for simulating transient science with UVEX. It provides everything needed to simulate the discovery and follow-up of transient populations with UVEX, across both target-of-opportunity (TOO) observations and UVEX’s planned surveys. Users can simulate transient population yields from survey schedules, generate light curves from realistic transients, and explore the impact of survey design choices on transient science. Custom transient models and classes are easy to implement, and the simulation framework is flexible enough to accommodate new survey strategies.

Key capabilities

Real survey schedules

Validates and simulates against real spacecraft schedules, not idealized cadences.

Synthetic photometry

A flexible, pluggable photometry backend (m4opt) computes band-integrated fluxes and detection significance.

Realistic instrument modeling

Spacecraft position, sky backgrounds, detector parameters, bandpasses, and foreground extinction are all treated in detail.

End-to-end yield simulations

Turns a sampled transient population into detections and light curves in a single pipeline.


Installation#

Get started in seconds!

Install from source:

git clone https://github.com/TransientsExtragalactic/uvex-transients
cd uvex-transients && pip install -e .

Resources#

User Guide

New to UVEX Transients? The user guide walks through the four layers of the package (models, transients, surveys, and simulation), how they fit together, and how to drive them all from the command line.

Transients

Curious what a simulated kilonova, TDE, LFBOT, or Type IIP supernova actually looks like? Each transient page covers the physical motivation, adopted volumetric rate, SED model and parameter priors, and a gallery of simulated light curves.

Examples

Ready to run something end to end? The example gallery walks through building survey schedules, simulating transient populations, and writing your own custom transient class.

API Reference

Doing a deep dive into our code? Looking to contribute to development? The API reference is a comprehensive resource complete with source code and type hinting so that you can find every detail you might need.

Report

Curious what UVEX will actually see? The report page tabulates detected event counts and detection probabilities, and plots expected yields vs. detection threshold, for every transient class – generated automatically from the latest published release.

Contents#


Indices and tables#