Skip to main content

User-defined science module for the Fink broker.

Project description

pypi Sentinel PEP8 codecov

Fink Science

This repository contains science modules used to generate added values to alert collected by the Fink broker.

ZTF alert stream

It currently contains:

Source Field in Fink alerts Type Contents
fink_science/xmatch cdsxmatch++ string Counterpart (cross-match) from any CDS catalog or database using the CDS xmatch service. Contains also crossmatch to the General Catalog of Variable Stars and the International Variable Star Index, 3HSP, 4LAC DR3.
fink_science/random_forest_snia rf_snia_vs_nonia float Probability to be a rising SNe Ia based on Random Forest classifier (1 is SN Ia). Based on https://arxiv.org/abs/2111.11438
fink_science/snn snn_snia_vs_nonia float Probability to be a SNe Ia based on SuperNNova classifier (1 is SN Ia). Based on https://arxiv.org/abs/1901.06384
fink_science/snn snn_sn_vs_all float Probability to be a SNe based on SuperNNova classifier (1 is SNe). Based on https://arxiv.org/abs/1901.06384
fink_science/microlensing mulens float Probability score to be a microlensing event by LIA
fink_science/asteroids roid int Determine if the alert is a Solar System object
fink_science/kilonova rf_kn_vs_nonkn float probability of an alert to be a kilonova using a Random Forest Classifier (binary classification).
fink_science/nalerthist nalerthist int Number of detections contained in each alert (current+history). Upper limits are not taken into account.
fink_science/ad_features lc_* dict[int, array] Numerous light curve features used in astrophysics.
fink_science/agn rf_agn_vs_nonagn float Probability to be an AGN based on Random Forest classifier (1 is AGN).
fink_science/anomaly_detection anomaly_score float Anomaly score (lower values mean more anomalous observations)

You will find README in each subfolder describing the module.

ELASTiCC stream (Rubin-like simulated data)

These modules are being tested for Rubin era on the LSST-DESC ELASTiCC data challenge:

Source Field in Fink alerts Type Contents
fink_science/agn_elasticc rf_agn_vs_nonagn float Probability to be an AGN based on Random Forest classifier (1 is AGN).
fink_science/random_forest_snia rf_snia_vs_nonia float Probability to be a rising SNe Ia based on Random Forest classifier (1 is SN Ia). Based on https://arxiv.org/abs/2111.11438
fink_science/snn snn_snia_vs_nonia float Probability to be a SNe Ia based on SuperNNova classifier (1 is SN Ia). Based on https://arxiv.org/abs/1901.06384
fink_science/snn broad array[float] Broad classifier based on SNN. Returns [class, max(prob)].
fink_science/cats fine array[float] Fine classifier based on the CBPF Algorithm for Transient Search. Returns [class, max(prob)].

Under development

Source Field in Fink alerts Type Contents
fink_science/t2 t2 array[float] Classifier based on Transformers. Based on https://arxiv.org/abs/2105.06178

How to contribute

Learn how to design your science module, and integrate it inside the Fink broker.

Installation

If you want to install the package (broker deployment), you can just pip it:

pip install fink_science

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

fink-science-3.11.0.tar.gz (54.9 MB view details)

Uploaded Source

Built Distribution

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

fink_science-3.11.0-py3-none-any.whl (55.4 MB view details)

Uploaded Python 3

File details

Details for the file fink-science-3.11.0.tar.gz.

File metadata

  • Download URL: fink-science-3.11.0.tar.gz
  • Upload date:
  • Size: 54.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for fink-science-3.11.0.tar.gz
Algorithm Hash digest
SHA256 fe8afcb036478248734c4cfcbe1074d6a6ca8ba432785c2a8c3344bb1339c5f8
MD5 3739c128b9379b06ee765b86c1bed544
BLAKE2b-256 d8521c0f7fc61677340a4ceed41b8602a48791865402523de8861fb2b706277d

See more details on using hashes here.

File details

Details for the file fink_science-3.11.0-py3-none-any.whl.

File metadata

  • Download URL: fink_science-3.11.0-py3-none-any.whl
  • Upload date:
  • Size: 55.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for fink_science-3.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec660344400efee53c34887ee2e8e3061c36ec2e4c7989899d33d18b74250151
MD5 ec9343d14a459c680161bf7efea85a87
BLAKE2b-256 43c21484aa68cb1887a45a8cd0879d7fd154e3f7c397a16582604a5e9e38e926

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