fink-client 11.0

Light-weight client to manipulate alerts from Fink

Fink client

fink-client is a light package around Apache Kafka tools to manipulate catalogs and alerts issued from the fink broker programmatically. It is used in the context of 3 major Fink services: Livestream, Data Transfer, and Xmatch.

Installation

fink_client requires a version of Python 3.9+. You can easily install it via pip:

pip install fink-client --upgrade

Documentation

Depending on the survey used, you will find documentation at:

Service	Documentation links
Livestream	LSST / ZTF
Data Transfer	LSST / ZTF
Xmatch	LSST (to come) / ZTF

Registration

In order to connect and poll alerts from Fink, you need to get your credentials:

1. Subscribe to one or more Fink streams by filling this form.
2. After filling the form, we will send your credentials. Register them on your laptop by simply running:

fink_client_register -survey SURVEY -username USERNAME -group_id GROUP_ID -servers SERVERS ...

Note that SURVEY is among ztf or lsst. In case of doubt, run fink_client_register -h. You can also inspect the configuration file on disk:

cat ~/.finkclient/ztf_credentials.yml
cat ~/.finkclient/lsst_credentials.yml

Note for users migration from v9.x to v10.x: your credentials remain valid, but you have to register again via the command line to generate correct credential files.

Contributing

For development, we recommend the use of a virtual environment:

git clone https://github.com/astrolabsoftware/fink-client.git
cd fink-client
python -m venv .fc_env
source .fc_env/bin/activate
pip install -r requirements.txt
pip install .

Feel free to open a Pull Request for bug fixes or new features.