| Name | event-model JSON |
| Version |
1.22.1
JSON |
| download |
| home_page | None |
| Summary | Data model used by the bluesky ecosystem. |
| upload_time | 2024-10-28 13:20:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2015, Brookhaven National Laboratory Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img src="https://raw.githubusercontent.com/bluesky/event-model/refs/heads/main/docs/images/event-model-logo.svg"
style="background: none" width="120px" height="120px" align="center" alt="logo">
[](https://github.com/bluesky/event-model/actions/workflows/ci.yml)
[](https://codecov.io/gh/bluesky/event-model)
[](https://pypi.org/project/event-model)
[](https://opensource.org/licenses/Apache-2.0)
Data model used by the bluesky ecosystem.
# Event Model
A primary design goal of bluesky is to enable better research by recording
rich metadata alongside measured data for use in later analysis. Documents are
how we do this.
This repository contains the formal schemas for bluesky's streaming data model
and some Python tooling for composing, validating, and transforming documents
in the model.
## Where is my data?
For the full details and schema please see the `data_model` section. This is a very quick guide to where
you should look for / put different kinds of information
* Information about your sample that you know before the measurement → *Start* Document
* What experiment you intended to do → *Start* Document
* Who you are / where you are → *Start* Document
* References to external databases → *Start* Document
* The Data™ → *Event* Document
* Detector calibrations, dark frames, flat fields , or masks → *Event* Document (probably in its own stream)
* The shape / data type / units of The Data™ → *Event Descriptor* Document in the *data_keys* entry
* Anything you read from the controls system that is not device configuration → *Event* Document
* Device configuration data → *Event Descriptor* Document in the *configuration* entry
<!-- README only content. Anything below this line won't be included in index.md -->
See https://bluesky.github.io/event-model for more detailed documentation.
Raw data
{
"_id": null,
"home_page": null,
"name": "event-model",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Brookhaven National Lab <dallan@bnl.gov>",
"download_url": "https://files.pythonhosted.org/packages/36/b6/960b80b61aeb370bc6446c76d30544ae655c325b8724a31bea15940565e7/event_model-1.22.1.tar.gz",
"platform": null,
"description": "<img src=\"https://raw.githubusercontent.com/bluesky/event-model/refs/heads/main/docs/images/event-model-logo.svg\"\n style=\"background: none\" width=\"120px\" height=\"120px\" align=\"center\" alt=\"logo\">\n\n[](https://github.com/bluesky/event-model/actions/workflows/ci.yml)\n[](https://codecov.io/gh/bluesky/event-model)\n[](https://pypi.org/project/event-model)\n[](https://opensource.org/licenses/Apache-2.0)\n\nData model used by the bluesky ecosystem.\n\n# Event Model\n\nA primary design goal of bluesky is to enable better research by recording\nrich metadata alongside measured data for use in later analysis. Documents are\nhow we do this.\n\nThis repository contains the formal schemas for bluesky's streaming data model\nand some Python tooling for composing, validating, and transforming documents\nin the model.\n\n## Where is my data?\n\nFor the full details and schema please see the `data_model` section. This is a very quick guide to where\nyou should look for / put different kinds of information\n\n* Information about your sample that you know before the measurement \u2192 *Start* Document\n* What experiment you intended to do \u2192 *Start* Document\n* Who you are / where you are \u2192 *Start* Document\n* References to external databases \u2192 *Start* Document\n* The Data\u2122 \u2192 *Event* Document\n* Detector calibrations, dark frames, flat fields , or masks \u2192 *Event* Document (probably in its own stream)\n* The shape / data type / units of The Data\u2122 \u2192 *Event Descriptor* Document in the *data_keys* entry\n* Anything you read from the controls system that is not device configuration \u2192 *Event* Document\n* Device configuration data \u2192 *Event Descriptor* Document in the *configuration* entry\n\n<!-- README only content. Anything below this line won't be included in index.md -->\n\nSee https://bluesky.github.io/event-model for more detailed documentation.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2015, Brookhaven National Laboratory Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Data model used by the bluesky ecosystem.",
"version": "1.22.1",
"project_urls": {
"GitHub": "https://github.com/bluesky/event-model"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "35395c0896af4adf69223d9a7a9f4942c8e85623462e903a597907633467b685",
"md5": "a781ff850cbb2a3c1c588c616b1da7fe",
"sha256": "f9dd1a41ab4f09bda0de182c9d30c5c464357c6b5a699d4cd0b52e4e88cf8cff"
},
"downloads": -1,
"filename": "event_model-1.22.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a781ff850cbb2a3c1c588c616b1da7fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 66076,
"upload_time": "2024-10-28T13:20:31",
"upload_time_iso_8601": "2024-10-28T13:20:31.834745Z",
"url": "https://files.pythonhosted.org/packages/35/39/5c0896af4adf69223d9a7a9f4942c8e85623462e903a597907633467b685/event_model-1.22.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "36b6960b80b61aeb370bc6446c76d30544ae655c325b8724a31bea15940565e7",
"md5": "b93732aabb1c90d15fc6a6eaf0331a36",
"sha256": "9861c24aafb5f06a9295d43bcf9b7e071eacbf92c214b409de221f1b6470e059"
},
"downloads": -1,
"filename": "event_model-1.22.1.tar.gz",
"has_sig": false,
"md5_digest": "b93732aabb1c90d15fc6a6eaf0331a36",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 178156,
"upload_time": "2024-10-28T13:20:33",
"upload_time_iso_8601": "2024-10-28T13:20:33.693563Z",
"url": "https://files.pythonhosted.org/packages/36/b6/960b80b61aeb370bc6446c76d30544ae655c325b8724a31bea15940565e7/event_model-1.22.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 13:20:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bluesky",
"github_project": "event-model",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "event-model"
}
