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.
fink_client requires a version of Python 3.9+. You can easily install it via pip:
pip install fink-client --upgradeDepending on the survey used, you will find documentation at:
| Service | Documentation links |
|---|---|
| Livestream | LSST / ZTF |
| Data Transfer | LSST / ZTF |
| Xmatch | LSST (incl. in Data Transfer) / ZTF |
In order to connect and poll alerts from Fink, you need to get your credentials:
- Subscribe to one or more Fink streams by filling this form.
- After filling the form, we will send your credentials. Register them on your machine following the ZTF or LSST documentation.
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.