/fink-client

Light-weight client to manipulate alerts from Fink

Primary LanguageJupyter NotebookApache License 2.0Apache-2.0

Quality Gate Status Maintainability Rating Build Status codecov Documentation Status

Fink client

fink-client is a light package to manipulate catalogs and alerts issued from the fink broker programmatically.

Installation

You need to have Python 3.5+ installed, and fink_client>=0.2 installed with dependencies:

# Install fink-client somewhere on your computer
git clone https://github.com/astrolabsoftware/fink-client
cd fink-client
pip install --upgrade pip setuptools wheel
pip install -r requirements.txt

Then, assuming you are using bash shell, update your ~/.bash_profile with the path to the library and binaries:

# Add these lines at the end of your ~/.bash_profile
export FINK_CLIENT_HOME=${PWD}
export PYTHONPATH=${FINK_CLIENT_HOME}:$PYTHONPATH
export PATH=${FINK_CLIENT_HOME}/bin:$PATH

Finally source the file to activate the changes:

source ~/.bash_profile

You can also run integration test (docker-compose required):

bin/fink_client_test.sh

If you don't see any error and all the test results are ok, you have installed it correctly.

Usage

Learn how to use fink-client by following the dedicated tutorial.