Listen to TDEmocracy!

This repository contains the data model used in the stream of candidate nuclear transients for the TDEmocracy project.

Prerequisites

You need an account at the SCIMMA Hopskotch service. Please contact the TDEmocracy lead to have your account added to the Ampel-TDEmocracy group. You can store your username and password in your environment variables TDEMOCRACY_USERNAME and TDEMOCRACY_PASSWORD or in a .env file in the root of the repository.

Installation

You can easily install the package via pip:

pip install tdemocracy

If you want the source editable code to make contributions pull the repository and install the dependencies with poetry:

git clone https://github.com/JannisNe/tdemocracy.git
cd tdemocracy
poetry install

Usage:

from tdemocracy.listen import listen_to_nuclear_stream

for report in listen_to_nuclear_stream():
    # do something with the report
    ...

Find more detailed documentation here.

Repository initiated with fpgmaas/cookiecutter-poetry.