Skip to main content

Data model used by the bluesky ecosystem.

Project description

CI Coverage PyPI License

event-model

Data model used by the bluesky ecosystem.

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.

Source https://github.com/bluesky/event-model
PyPI pip install event-model
Documentation https://bluesky.github.io/event-model
Releases https://github.com/bluesky/event-model/releases

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

See https://bluesky.github.io/event-model for more detailed documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

event_model-1.23.tar.gz (184.9 kB view details)

Uploaded Source

Built Distribution

event_model-1.23-py3-none-any.whl (76.8 kB view details)

Uploaded Python 3

File details

Details for the file event_model-1.23.tar.gz.

File metadata

  • Download URL: event_model-1.23.tar.gz
  • Upload date:
  • Size: 184.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for event_model-1.23.tar.gz
Algorithm Hash digest
SHA256 7481cc97151b3ac77b5f5c6a11daf24c9c5d56bf58c88f4318f393e9a804f598
MD5 8e4fcf870c5651c21655484647dee8e2
BLAKE2b-256 b3ecc6e26b71980ae925a84c4b4da351d4a1f84fc6060c31d0a10ffc886c2633

See more details on using hashes here.

File details

Details for the file event_model-1.23-py3-none-any.whl.

File metadata

  • Download URL: event_model-1.23-py3-none-any.whl
  • Upload date:
  • Size: 76.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for event_model-1.23-py3-none-any.whl
Algorithm Hash digest
SHA256 223def5ab479db058243085a7860786013d21f58a22d607cbcb32e237e3a2f1f
MD5 ce9b29e8ae5236a56711b81c06c98c4a
BLAKE2b-256 66ee97d558331ea905acad0b7c55a894e50884c02ccac87ebab583d50fac528b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page