Metadata-Version: 2.1
Name: fink-science
Version: 0.3.1
Summary: User-defined science module for the Fink broker.
Home-page: https://fink-broker.readthedocs.io/en/latest/
Author: JulienPeloton
Author-email: peloton@lal.in2p3.fr
License: UNKNOWN
Project-URL: Documentation, https://fink-broker.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/astrolabsoftware/fink-science
Description: [![pypi](https://img.shields.io/pypi/v/fink-science.svg)](https://pypi.python.org/pypi/fink-science) [![Build Status](https://travis-ci.org/astrolabsoftware/fink-science.svg?branch=master)](https://travis-ci.org/astrolabsoftware/fink-science) [![codecov](https://codecov.io/gh/astrolabsoftware/fink-science/branch/master/graph/badge.svg)](https://codecov.io/gh/astrolabsoftware/fink-science)
        
        # Fink Science
        
        This repository contains science modules used to generate added values to alert collected by the [Fink broker](https://github.com/astrolabsoftware/fink-broker). It currently contains:
        
        - `xmatch`: returns the SIMBAD closest counterpart of an alert, based on position.
        - `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](https://github.com/supernnova/SuperNNova)
        - `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](https://github.com/dgodinez77/LIA).
        - `asteroids`: Determine if the alert is an asteroid (experimental).
        
        You will find README in each subfolder describing the module.
        
        ## How to contribute
        
        Learn how to [design](https://fink-broker.readthedocs.io/en/latest/tutorials/create-science-module/) 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
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Description-Content-Type: text/markdown
