# cerebro
[](https://sdss-cerebro.readthedocs.io/en/latest/?badge=latest)
[](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": "https://github.com/sdss/cerebro",
"name": "sdss-cerebro",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<3.13",
"maintainer_email": "",
"keywords": "astronomy,software",
"author": "Jos\u00e9 S\u00e1nchez-Gallego",
"author_email": "gallegoj@uw.edu",
"download_url": "https://files.pythonhosted.org/packages/2f/2a/0dee9e68823a0c5fe227f0a67cc3159b6cd2fceeddc6442de7c3e6a5fcac/sdss_cerebro-1.2.1.tar.gz",
"platform": null,
"description": "# cerebro\n\n\n[](https://sdss-cerebro.readthedocs.io/en/latest/?badge=latest)\n[](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\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Telemetry management and time series for SDSS-V",
"version": "1.2.1",
"project_urls": {
"Documentation": "https://sdss-cerebro.readthedocs.io/en/latest/",
"Homepage": "https://github.com/sdss/cerebro",
"Repository": "https://github.com/sdss/cerebro"
},
"split_keywords": [
"astronomy",
"software"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b29be3112397823a1827fcec20711d87b0f985170d43fdfb911c68cedac50c6",
"md5": "334456464ba9291c3f440b0d141e155c",
"sha256": "94458dd7613d8b5735429a5c87e87c8b82f5c55ff792066b545a0da5ceff6d83"
},
"downloads": -1,
"filename": "sdss_cerebro-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "334456464ba9291c3f440b0d141e155c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<3.13",
"size": 34524,
"upload_time": "2024-01-19T23:31:45",
"upload_time_iso_8601": "2024-01-19T23:31:45.927020Z",
"url": "https://files.pythonhosted.org/packages/3b/29/be3112397823a1827fcec20711d87b0f985170d43fdfb911c68cedac50c6/sdss_cerebro-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2f2a0dee9e68823a0c5fe227f0a67cc3159b6cd2fceeddc6442de7c3e6a5fcac",
"md5": "5f12b37d663a03e1d5a0ab4024e53781",
"sha256": "55f6a5ed4ec11bc4364c76cb3d103eda527f66b8b52d6e23043b0b1514c82a5a"
},
"downloads": -1,
"filename": "sdss_cerebro-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "5f12b37d663a03e1d5a0ab4024e53781",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<3.13",
"size": 25788,
"upload_time": "2024-01-19T23:31:47",
"upload_time_iso_8601": "2024-01-19T23:31:47.557746Z",
"url": "https://files.pythonhosted.org/packages/2f/2a/0dee9e68823a0c5fe227f0a67cc3159b6cd2fceeddc6442de7c3e6a5fcac/sdss_cerebro-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-19 23:31:47",
"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"
}
JSON
