sdss-cerebro


Namesdss-cerebro JSON
Version 1.3.2 PyPI version JSON
download
home_pageNone
SummaryTelemetry management and time series for SDSS-V
upload_time2025-07-10 14:51:00
maintainerNone
docs_urlNone
authorNone
requires_python<4,>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # cerebro

![Versions](https://img.shields.io/badge/python->3.7-blue)
[![Documentation Status](https://readthedocs.org/projects/sdss-cerebro/badge/?version=latest)](https://sdss-cerebro.readthedocs.io/en/latest/?badge=latest)
[![Test Status](https://github.com/albireox/cerebro/workflows/Test/badge.svg)](https://github.com/sdss/sdss/actions)

A library to gather time-series data from different sources and store them, with focus on InfluxDB databases. Documentation and concepts are defined [here](https://sdss-cerebro.readthedocs.io/).

## Installation

In general you should be able to install `cerebro` by doing

```console
pip install sdss-cerebro
```

To build from source, use

```console
git clone git@github.com:sdss/cerebro
cd cerebro
pip install .
```

## Use

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

```console
cerebro start
```

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

```console
cerebro --profile lvm-lab start
```

or a series of sources

```console
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](http://poetry.eustace.io/) 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

```console
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

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

The style code is [black](https://black.readthedocs.io/en/stable/).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sdss-cerebro",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Jos\u00e9 S\u00e1nchez-Gallego <gallegoj@uw.edu>",
    "download_url": "https://files.pythonhosted.org/packages/f0/37/b76a3e05a76c59e5cb2a7b5809d1447dcf83d60bce3953036235c66b42f4/sdss_cerebro-1.3.2.tar.gz",
    "platform": null,
    "description": "# cerebro\n\n![Versions](https://img.shields.io/badge/python->3.7-blue)\n[![Documentation Status](https://readthedocs.org/projects/sdss-cerebro/badge/?version=latest)](https://sdss-cerebro.readthedocs.io/en/latest/?badge=latest)\n[![Test Status](https://github.com/albireox/cerebro/workflows/Test/badge.svg)](https://github.com/sdss/sdss/actions)\n\nA library to gather time-series data from different sources and store them, with focus on InfluxDB databases. Documentation and concepts are defined [here](https://sdss-cerebro.readthedocs.io/).\n\n## Installation\n\nIn general you should be able to install `cerebro` by doing\n\n```console\npip install sdss-cerebro\n```\n\nTo build from source, use\n\n```console\ngit clone git@github.com:sdss/cerebro\ncd cerebro\npip install .\n```\n\n## Use\n\n`cerebro` is meant to run as a daemon. The simplest way to run it is simply\n\n```console\ncerebro start\n```\n\nThis will run all the sources and use all the observers. You can define a specific profile to use\n\n```console\ncerebro --profile lvm-lab start\n```\n\nor a series of sources\n\n```console\ncerebro --sources lvm_govee_clean_room,lvm_sens4_r1 start\n```\n\nNormally `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.\n\nRun `cerebro --help` to get all the options available.\n\n## Development\n\n`cerebro` uses [poetry](http://poetry.eustace.io/) 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\n\n```console\npoetry install\n```\n\nPip 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\n\n```console\npip install poetry\npython create_setup.py\npip install -e .\n```\n\nThe style code is [black](https://black.readthedocs.io/en/stable/).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Telemetry management and time series for SDSS-V",
    "version": "1.3.2",
    "project_urls": {
        "Documentation": "https://sdss-cerebro.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/sdss/cerebro",
        "Repository": "https://github.com/sdss/cerebro"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0de41c5776bfa4b58439246c1976dd8bdece69947f1270870d84cd6539315987",
                "md5": "a985e85ab282231c624fbe9b8eb285fa",
                "sha256": "6780f910d0cd4411b8ba84809f13e552e1ada536cc03100ef0ea2ae02dde5824"
            },
            "downloads": -1,
            "filename": "sdss_cerebro-1.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a985e85ab282231c624fbe9b8eb285fa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.10",
            "size": 37854,
            "upload_time": "2025-07-10T14:50:59",
            "upload_time_iso_8601": "2025-07-10T14:50:59.358572Z",
            "url": "https://files.pythonhosted.org/packages/0d/e4/1c5776bfa4b58439246c1976dd8bdece69947f1270870d84cd6539315987/sdss_cerebro-1.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f037b76a3e05a76c59e5cb2a7b5809d1447dcf83d60bce3953036235c66b42f4",
                "md5": "653c604655bba832c24a8ebc6e54a75e",
                "sha256": "3953184235a3076f4a3635552fb6b9942424f04378b42eef10d87012c1b077b1"
            },
            "downloads": -1,
            "filename": "sdss_cerebro-1.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "653c604655bba832c24a8ebc6e54a75e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.10",
            "size": 27916,
            "upload_time": "2025-07-10T14:51:00",
            "upload_time_iso_8601": "2025-07-10T14:51:00.477869Z",
            "url": "https://files.pythonhosted.org/packages/f0/37/b76a3e05a76c59e5cb2a7b5809d1447dcf83d60bce3953036235c66b42f4/sdss_cerebro-1.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-10 14:51:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sdss",
    "github_project": "cerebro",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sdss-cerebro"
}
        
Elapsed time: 1.25096s