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. It currently contains:

  • xmatch: perform a crossmatch of the stream with external catalogs
  • random_forest_snia: returns the probability of an alert to be a SNe Ia using a Random Forest Classifier (binary classification)
  • snn: returns the probability of an alert to be a SNe Ia using SuperNNova. Two pre-trained models:
    • snn_snia_vs_nonia: Ia vs core-collapse SNe
    • snn_sn_vs_all: SNe vs. anything else (variable stars and other categories in the training)
  • microlensing: returns the predicted class (among microlensing, variable star, cataclysmic event, and constant event) & probability of an alert to be a microlensing event in each band using LIA.
  • asteroids: Determine if the alert is a Solar System Object (experimental).
  • nalerthist: Number of detections contained in each alert (current+history). Upper limits are not taken into account.
  • kilonova: returns the probability of an alert to be a kilonova using a Random Forest Classifier (binary classification).

You will find README in each subfolder describing the module.

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-0.4.8.tar.gz (30.0 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-0.4.8-py3-none-any.whl (30.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fink-science-0.4.8.tar.gz
  • Upload date:
  • Size: 30.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.8.0 tqdm/4.60.0 CPython/3.7.1

File hashes

Hashes for fink-science-0.4.8.tar.gz
Algorithm Hash digest
SHA256 089e903ba541be0a7a9be73e79da069f4772d3d8b36e70e20a21c7506a7504af
MD5 45bf86a3d0777a9a87daa612954be665
BLAKE2b-256 7285e78f5df05006a0b5ebc2f438e94027052350c87f4dc6509c5fe172fc1cf7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fink_science-0.4.8-py3-none-any.whl
  • Upload date:
  • Size: 30.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.8.0 tqdm/4.60.0 CPython/3.7.1

File hashes

Hashes for fink_science-0.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 307a06c06c5b5db1d0480834622fc945f6b3f3d6b274f3c6a75d6ef15b4a906f
MD5 2c0ebe9a8dbb06e1391cf656de564440
BLAKE2b-256 67e5139031aad769b3595dc9c142ce1ebeff09c349b98c38917b0549bce4fcb2

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