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 (incl. in Data Transfer) / ZTF |
Registration
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 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.
1 maintainer
Metadata
1 maintainer
Release files for fink-client 12.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fink_client-12.0.0.tar.gz | 39.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fink_client-12.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 90.7 kB
Release files / fink_client-12.0.0.tar.gz
| Download URL | fink_client-12.0.0.tar.gz |
|---|---|
| Size | 39.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
70edec5d6cffe9f82fa73fc1c0d8dec0c8d6c5c2bb9f1d32d5d82385015f286d
|
|
BLAKE2b-256 checksum How to use checksums |
ad7be615a6a9cda3a8e1bbefb3066f3c1b0649c29f1193d391d6b0fecfb52440
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
Release files / fink_client-12.0.0-py3-none-any.whl
| Download URL | fink_client-12.0.0-py3-none-any.whl |
|---|---|
| Size | 50.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1f65d94ca91d6620e5c2f22022d7254596dffd2dadb09295c80e6b348037c3c2
|
|
BLAKE2b-256 checksum How to use checksums |
6432ad11e092240ef04e9dcc6f1d44e533eb574a9757c937a92ea223209c412e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
