Skip to main content

LightCurveLynx

A Fast and Nimble Package for Time Domain Astronomy

Template

PyPI Conda Version

GitHub Workflow Status Codecov Benchmarks Read the Docs status DOI

Introduction

Realistic light curve simulations are essential to many time-domain problems. Simulations are needed to evaluate observing strategy, characterize biases, and test pipelines. LightCurveLynx aims to provide a flexible, scalable, and user-friendly time-domain simulation software with realistic effects and survey strategies.

The software package consists of multiple stages:

  1. A flexible framework for consistently sampling model parameters (and hyperparameters),
  2. Realistic models of time varying phenomena (such as supernovae and AGNs),
  3. Effect models (such as dust extinction), and
  4. Survey characteristics (such as cadence, filters, and noise).

For an overview of the package, we recommend starting with introduction notebook.

Installation

Install from PyPI or conda-forge:

pip install lightcurvelynx
conda install conda-forge::lightcurvelynx

Since LightCurveLynx relies on a large number of existing packages, not all of the packages are installed in the default configuration. You can install most of the optional depenencies with the "dev" or "all" extras:

pip install 'lightcurvelynx[all]'

If you need a package that is not installed as part of the default or all configurations, LightCurveLynx will provide a message with the information on which packages you need to install and how to install them.

Example Usage

The tutorial notebooks documentation page provides a variety of usage examples and technical deep dives.

If you have questions, check out the FAQ page or the getting help page

Dev Guide - Getting Started

Before installing any dependencies or writing code, it's a great idea to create a virtual environment such as venv

>> python3 -m venv ~/envs/lightcurvelynx
>> source ~/envs/lightcurvelynx/bin/activate

Once you have created a new environment, you can install this project for local development using the following commands:

>> pip install -e .'[dev]'
>> pre-commit install

Notes:

  1. The single quotes around '[dev]' may not be required for your operating system.
  2. pre-commit install will initialize pre-commit for this local repository, so that a set of tests will be run prior to completing a local commit. For more information, see the Python Project Template documentation on pre-commit

If you are interested in contributing directly to the package, see our contribution guide.

Citations / Acknowledgements

If you use LightCurveLynx in your research, we ask that you cite the following papers:

  • Dai et. al. 2026 "LightCurveLynx: Forward Modeling of Time-Domain Surveys with Application to ZTF SN Ia DR2" (in review; see arxiv.org/abs/2604.07134 )
  • Kubica et. al. 2026 "LightCurveLynx: Fast and Nimble Time Domain Simulation for Astronomical Surveys" (in review )

LightCurveLynx relies on numerous open source packages to perform the computation. Please make sure to cite the packages that your study uses.

Advisories

This project is under active development and may see API changes.

Users should always carefully validate the science outputs for their use case. Please reach out to the team if you find any problems.

Acknowledgements

This project is supported by Schmidt Sciences.

Metadata

Release files for lightcurvelynx 0.6.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lightcurvelynx 0.6.3
File Size Uploaded
lightcurvelynx-0.6.3.tar.gz 12.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for lightcurvelynx 0.6.3
File Interpreter ABI Platform
lightcurvelynx-0.6.3-py3-none-any.whl Python 3 none any Details

Total release size: 13.1 MB

Release files / lightcurvelynx-0.6.3.tar.gz

Download URL lightcurvelynx-0.6.3.tar.gz
Size 12.8 MB
Tags Source
SHA-256 checksum
How to use checksums
eeccd86c28eb3bce525123968dd53ec519026b9b70d0bc1d81b3c38cd8cee5f8
BLAKE2b-256 checksum
How to use checksums
79123a6b5ef97456f6a11439298defd7dd369340b67fa5e064750843271156d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 28, 2026.

Transparency log

Release files / lightcurvelynx-0.6.3-py3-none-any.whl

Download URL lightcurvelynx-0.6.3-py3-none-any.whl
Size 305.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b0aca60bf9f6876af9fdd10e52d39bc44a3e9f5c76e4b486c27af193abd9f79e
BLAKE2b-256 checksum
How to use checksums
dcd0cb1c6e285bec6d0a25f2bcf5acfa97eedf85e5aeaf3408c78a558f9a9b91
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 28, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.6.3 This release

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.15

2 release files

0.3.14

2 release files

0.3.13

2 release files

0.3.10

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.0

2 release files

0.0.9

2 release files

0.0.8

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page