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.

Project links

Data verified by PyPI on Jul 15, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.5.2)

Owner

PyPI data
Data sourced directly from PyPI's database.

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for hombit from gravatar.com hombit Avatar for jeremykubica from gravatar.com jeremykubica Avatar for olynn from gravatar.com olynn

Credits

Author: LINCC Frameworks

GitHub Statistics

Data verified by PyPI on Jul 15, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.11

Provides Extra

dev all

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lightcurvelynx-0.5.1.tar.gz (12.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lightcurvelynx-0.5.1-py3-none-any.whl (284.8 kB view details)

Uploaded Python 3

File details

Details for the file lightcurvelynx-0.5.1.tar.gz.

File metadata

  • Download URL: lightcurvelynx-0.5.1.tar.gz
  • Upload date:
  • Size: 12.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lightcurvelynx-0.5.1.tar.gz
Algorithm Hash digest
SHA256 d6115cc831c7febc1b6e507dcab03ca394cd1041389b674a4d16bc5f8fff3a1b
MD5 387b8a855a92ab39cfdc24eb198df13f
BLAKE2b-256 058da0bf658eba72da8768541b79e5f7ef3f632e176398b535c02c35410ca53e

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightcurvelynx-0.5.1.tar.gz:

Publisher: publish-to-pypi.yml on lincc-frameworks/lightcurvelynx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightcurvelynx-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: lightcurvelynx-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 284.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lightcurvelynx-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 72859b547fb6aca9b028fbd91f9db5bbf59af03696a03b105d8d40355bcd4305
MD5 8d8da2269b1d92406e7d3c533fa6ce80
BLAKE2b-256 ede092fe2e1d3af203be44be954fe7897c7689a2c50e13233be2d635b5adc77f

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightcurvelynx-0.5.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on lincc-frameworks/lightcurvelynx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.5.2

2 files

This release

0.5.1 This release

2 files

0.5.0

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.15

2 files

0.3.14

2 files

0.3.13

2 files

0.3.12

2 files

0.3.11

2 files

0.3.10

2 files

0.3.9

2 files

0.3.8

2 files

0.3.7

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.0

2 files

0.0.9

2 files

0.0.8

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page