Skip to main content

No project description provided

Project description

Unit Tests

reLAISS Logo

A flexible library for similarity searches of supernovae and their host galaxies.

reLAISS lets you retrieve nearest‑neighbour supernovae (or spot outliers) by combining ZTF $g/r$ light‑curve morphology with Pan‑STARRS host‑galaxy colours. A pre‑built reference index allows users find similar events to a queried object in seconds. reLAISS is designed to be modular; feel free to customize for your own science!

Install

Installation is easy: in a fresh conda environment, run pip install relaiss. If you want even faster performance, you can install both ngt and its python bindings from source; instructions can be found here.

Code Demo

import relaiss as rl

client = rl.ReLAISS()

# load reference data
client.load_reference(
    path_to_sfd_folder='./sfddata-master',  # Directory for SFD dust maps
    weight_lc=3, # Upweight lightcurve features for neighbor search
)

# Find the 5 closest matches to a ZTF transient
neigh = client.find_neighbors(
        ztf_object_id='ZTF21abbzjeq',  # Using the test transient
        n=5,  # number of neighbors to retrieve
        plot=True, # plot and save figures
        save_figures=True,
        path_to_figure_directory='./figures'
    )

# print closest neighbors and their distances
print(neigh[["iau_name", "dist"]])

Citation

If you use reLAISS for your research, please cite the following two works:

@article{Reynolds_2025,
doi = {10.3847/2515-5172/adef56},
url = {https://dx.doi.org/10.3847/2515-5172/adef56},
year = {2025},
month = {jul},
publisher = {The American Astronomical Society},
volume = {9},
number = {7},
pages = {189},
author = {Reynolds, E. and Gagliano, A. and Villar, V. A.},
title = {reLAISS: A Python Package for Flexible Similarity Searches of Supernovae and Their Host Galaxies},
journal = {Research Notes of the AAS},
}


@ARTICLE{2024ApJ...974..172A,
       author = {{Aleo}, P.~D. and {Engel}, A.~W. and {Narayan}, G. and {Angus}, C.~R. and {Malanchev}, K. and {Auchettl}, K. and {Baldassare}, V.~F. and {Berres}, A. and {de Boer}, T.~J.~L. and {Boyd}, B.~M. and {Chambers}, K.~C. and {Davis}, K.~W. and {Esquivel}, N. and {Farias}, D. and {Foley}, R.~J. and {Gagliano}, A. and {Gall}, C. and {Gao}, H. and {Gomez}, S. and {Grayling}, M. and {Jones}, D.~O. and {Lin}, C. -C. and {Magnier}, E.~A. and {Mandel}, K.~S. and {Matheson}, T. and {Raimundo}, S.~I. and {Shah}, V.~G. and {Soraisam}, M.~D. and {de Soto}, K.~M. and {Vicencio}, S. and {Villar}, V.~A. and {Wainscoat}, R.~J.},
        title = "{Anomaly Detection and Approximate Similarity Searches of Transients in Real-time Data Streams}",
      journal = {\apj},
     keywords = {Supernovae, Transient detection, Astronomical methods, Time domain astronomy, Time series analysis, Astrostatistics techniques, Classification, Light curves, Random Forests, 1668, 1957, 1043, 2109, 1916, 1886, 1907, 918, 1935, Astrophysics - High Energy Astrophysical Phenomena, Astrophysics - Instrumentation and Methods for Astrophysics},
         year = 2024,
        month = oct,
       volume = {974},
       number = {2},
          eid = {172},
        pages = {172},
          doi = {10.3847/1538-4357/ad6869},
archivePrefix = {arXiv},
       eprint = {2404.01235},
 primaryClass = {astro-ph.HE},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2024ApJ...974..172A},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Project details


Download files

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

Source Distribution

relaiss-1.2.4.tar.gz (4.6 MB view details)

Uploaded Source

Built Distribution

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

relaiss-1.2.4-py3-none-any.whl (54.5 kB view details)

Uploaded Python 3

File details

Details for the file relaiss-1.2.4.tar.gz.

File metadata

  • Download URL: relaiss-1.2.4.tar.gz
  • Upload date:
  • Size: 4.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for relaiss-1.2.4.tar.gz
Algorithm Hash digest
SHA256 3a2596650eb97225faa0749b8db694bb34c86a438a9b8cd0666dfd737d841a8e
MD5 6ed563233be5ca961d53648005edc6d2
BLAKE2b-256 8307e77a3bb9c6a07fbb0dd961bc37e1e320eccef179a19e33398d91cf53cb9a

See more details on using hashes here.

File details

Details for the file relaiss-1.2.4-py3-none-any.whl.

File metadata

  • Download URL: relaiss-1.2.4-py3-none-any.whl
  • Upload date:
  • Size: 54.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for relaiss-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cd5051ee407721aacaf6aba300e0d8ef38378e90bf5f977b69238a6c7cba8ee1
MD5 03d69007e2542f86891277639612acb9
BLAKE2b-256 3a158beafbf905237a0192d941331ba987af048b1ba3d9e7e0207c774da94cfb

See more details on using hashes here.

Supported by

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