Metadata-Version: 2.1
Name: fink-filters
Version: 7.33
Summary: User-defined filters for the Fink broker.
Home-page: https://fink-broker.readthedocs.io/en/latest/
Author: JulienPeloton
Author-email: peloton@lal.in2p3.fr
Project-URL: Documentation, https://fink-broker.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/astrolabsoftware/fink-filters
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
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
License-File: LICENSE

[![pypi](https://img.shields.io/pypi/v/fink-filters.svg)](https://pypi.python.org/pypi/fink-filters)
[![Sentinel](https://github.com/astrolabsoftware/fink-filters/actions/workflows/run_test.yml/badge.svg)](https://github.com/astrolabsoftware/fink-filters/actions/workflows/run_test.yml)
[![PEP8](https://github.com/astrolabsoftware/fink-filters/workflows/PEP8/badge.svg)](https://github.com/astrolabsoftware/fink-filters/actions?query=workflow%3APEP8)
[![codecov](https://codecov.io/gh/astrolabsoftware/fink-filters/branch/master/graph/badge.svg)](https://codecov.io/gh/astrolabsoftware/fink-filters)

# Fink filters

This repository contains filters used to flag particular parts of the full stream to be distributed to Fink users. More information about available topics and how to create your filter at 

- ZTF: [https://doc.ztf.fink-broker.org/en/latest/broker/filters/](https://doc.ztf.fink-broker.org/en/latest/broker/filters/)
- LSST: [https://doc.lsst.fink-broker.org/science/filters/](https://doc.lsst.fink-broker.org/science/filters/)

## Installation

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

```bash
pip install fink_filters --upgrade
```

## Taxonomy

There are two types of filters: filters that run on the live stream, and filters that are applied after the observing night (e.g. because they need to aggregate data before, or compute statistics). For each survey, the first kind can be found in the folder `livestream`.
