Skip to content

Commit

Permalink
Fix text in the manual
Browse files Browse the repository at this point in the history
  • Loading branch information
JulienPeloton committed Feb 9, 2022
1 parent 687327d commit 759aa79
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/livestream_manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,20 @@ You first need to register your credentials. Upon installation, run on a termina
fink_client_register \
-username <USERNAME> \ # given privately
-group_id <GROUP_ID> \ # given privately
-mytopics <topic1 topic2 etc> \ # given privately, space separated if several
-mytopics <topic1 topic2 etc> \ # see https://fink-broker.readthedocs.io/en/latest/topics/
-servers <SERVER> \ # given privately, comma separated if several
-maxtimeout 5 \ # in seconds
--verbose
```

where `<USERNAME>`, `<GROUP_ID>`, `topics` and `<SERVER>` have been sent to you privately. By default, the credentials are installed in the home:
where `<USERNAME>`, `<GROUP_ID>`, and `<SERVER>` 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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 759aa79

Please sign in to comment.