From 759aa793e4cf758f844def7b83d1d077c61a1cb5 Mon Sep 17 00:00:00 2001 From: Julien Date: Wed, 9 Feb 2022 12:32:53 +0100 Subject: [PATCH] Fix text in the manual --- docs/livestream_manual.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/livestream_manual.md b/docs/livestream_manual.md index 3641d8b..9c5f420 100644 --- a/docs/livestream_manual.md +++ b/docs/livestream_manual.md @@ -23,18 +23,20 @@ You first need to register your credentials. Upon installation, run on a termina fink_client_register \ -username \ # given privately -group_id \ # given privately - -mytopics \ # given privately, space separated if several + -mytopics \ # see https://fink-broker.readthedocs.io/en/latest/topics/ -servers \ # given privately, comma separated if several -maxtimeout 5 \ # in seconds --verbose ``` -where ``, ``, `topics` and `` have been sent to you privately. By default, the credentials are installed in the home: +where ``, ``, and `` have been sent to you privately. By default, the credentials are installed in the home: ```bash cat ~/.finkclient/credentials.yml ``` +For the list of available topics, see [https://fink-broker.readthedocs.io/en/latest/topics/](https://fink-broker.readthedocs.io/en/latest/topics/). + ## First steps: testing the connection Processed alerts are stored 1 week on our servers, which means if you forget to poll data, you'll be able to retrieve it up to one week after emission. This also means on your first connection, you will have one week of alert to retrieve. Before you get all of them, let's retrieve the first available one to check the connection. On a terminal, run the following @@ -161,7 +163,7 @@ if __name__ == "__main__": poll_single_alert(myconfig, topics) ``` -You only need to update the `myconfig` dictionnary with the connection information sent to you privately, and the `topics` list with the topics you requested. Save the file, and in a terminal walk to where the file has been saved and execute it: +You only need to update the `myconfig` dictionnary with the connection information sent to you privately, and the `topics` list with the topics you want to access. Save the file, and in a terminal walk to where the file has been saved and execute it: ```bash python my_consumer.py