https://github.com/astrolabsoftware/fink-filters

Define your filters to create your alert stream in Fink!
https://github.com/astrolabsoftware/fink-filters

astronomy broker extension pyspark python

Last synced: 4 months ago
JSON representation

Define your filters to create your alert stream in Fink!

• Host: GitHub
• URL: https://github.com/astrolabsoftware/fink-filters
• Owner: astrolabsoftware
• License: apache-2.0
• Created: 2019-11-14T13:17:23.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2026-01-12T20:02:57.000Z (5 months ago)
• Last Synced: 2026-01-13T15:56:36.041Z (5 months ago)
• Topics: astronomy, broker, extension, pyspark, python
• Language: Python
• Homepage: https://fink-broker.readthedocs.io/en/latest/broker/filters/
• Size: 67.7 MB
• Stars: 1
• Watchers: 2
• Forks: 11
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![pypi](https://img.shields.io/pypi/v/fink-filters.svg)](https://pypi.python.org/pypi/fink-filters)

[![Sentinel ZTF](https://github.com/astrolabsoftware/fink-filters/actions/workflows/run_test_ztf.yml/badge.svg)](https://github.com/astrolabsoftware/fink-filters/actions/workflows/run_test_ztf.yml)

[![Sentinel Rubin](https://github.com/astrolabsoftware/fink-filters/actions/workflows/run_test_rubin.yml/badge.svg)](https://github.com/astrolabsoftware/fink-filters/actions/workflows/run_test_rubin.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 [https://fink-broker.readthedocs.io/en/latest/science/filters](https://fink-broker.readthedocs.io/en/latest/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`.

## Rubin

For Rubin, 1 filter = 1 class = 1 HBase table (query). The name of the filter is also the same name for the class, and the same name for the Kafka topic.

### Test data

Testing the filters & blocks require science data. Fire a Fink container, process data inside, and transfer it here (`datatest` folder).