https://github.com/astrolabsoftware/fink-alert-simulator

Simulate alert streams for the Fink broker
https://github.com/astrolabsoftware/fink-alert-simulator

apache-avro apache-kafka astronomy streaming

Last synced: 3 days ago
JSON representation

Simulate alert streams for the Fink broker

• Host: GitHub
• URL: https://github.com/astrolabsoftware/fink-alert-simulator
• Owner: astrolabsoftware
• License: apache-2.0
• Created: 2019-11-25T11:04:32.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-22T08:59:39.000Z (24 days ago)
• Last Synced: 2024-10-23T13:16:12.717Z (23 days ago)
• Topics: apache-avro, apache-kafka, astronomy, streaming
• Language: Python
• Homepage: https://fink-broker.readthedocs.io
• Size: 21.5 MB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fink alert simulator

`fink-alert-simulator` is a package to inject alert data to Apache Kafka to feed brokers listening to Kafka streams. The main purposes are testing the broker and replaying historical alert data. This package belongs to the [fink broker](https://github.com/astrolabsoftware/fink-broker) ecosystem.

## Installation

Fork and/or clone the repo, and update your `PYTHONPATH` and `PATH` to use the tools:

```bash

# in your ~/.bash_profile

export FINK_ALERT_SIMULATOR=/path/to/fink-alert-simulator

export PYTHONPATH=$FINK_ALERT_SIMULATOR:$PYTHONPATH

export PATH=$FINK_ALERT_SIMULATOR/bin:$PATH

```

## Usage

Simply use

```bash

fink_simulator [options] [-h]

```

Note that you would need to have access to a Kafka cluster to publish alerts, otherwise you can use the docker version for local tests (you would need docker-compose installed). Learn more on how to use fink-alert-simulator by following the dedicated [tutorial](https://fink-broker.readthedocs.io/en/latest/tutorials/simulator/).