sdss-cerebro 1.0.0

Telemetry management and time series for SDSS-V

cerebro

A library to gather time-series data from different sources and store them, with focus on InfluxDB databases. Documentation and concepts are defined here.

Installation

In general you should be able to install cerebro by doing

pip install sdss-cerebro

To build from source, use

git clone [e-mail]:sdss/cerebro
cd cerebro
pip install .

Use

cerebro is meant to run as a daemon. The simplest way to run it is simply

cerebro start

This will run all the sources and use all the observers. You can define a specific profile to use

cerebro --profile lvm-lab start

or a series of sources

cerebro --sources lvm_govee_clean_room,lvm_sens4_r1 start

Normally cerebro will run in detached/daemon mode. It's also possible to pass the flag --debug (cerebro start --debug) to run the code in the foreground.

Run cerebro --help to get all the options available.

Development

cerebro uses poetry for dependency management and packaging. To work with an editable install it's recommended that you setup poetry and install cerebro in a virtual environment by doing

poetry install

Pip does not support editable installs with PEP-517 yet. That means that running pip install -e . will fail because poetry doesn't use a setup.py file. As a workaround, you can use the create_setup.py file to generate a temporary setup.py file. To install cerebro in editable mode without poetry, do

pip install poetry
python create_setup.py
pip install -e .

The style code is black.