Skip to main content

Data model used by the bluesky ecosystem.

Project description

logo

CI Coverage PyPI License

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

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.22.1rc1.tar.gz (178.1 kB view details)

Uploaded Source

Built Distribution

event_model-1.22.1rc1-py3-none-any.whl (66.1 kB view details)

Uploaded Python 3

File details

Details for the file event_model-1.22.1rc1.tar.gz.

File metadata

  • Download URL: event_model-1.22.1rc1.tar.gz
  • Upload date:
  • Size: 178.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for event_model-1.22.1rc1.tar.gz
Algorithm Hash digest
SHA256 a08eb4a74fab76fc94f1818d687a695afdbd6b001ce25755f7afb41d149532d7
MD5 34e1f08e2f5f1134654659edd06f481b
BLAKE2b-256 c3883ba15ed9d8f64295f2843534e69112b07b5db86cafa8f6556548e26fd0fe

See more details on using hashes here.

File details

Details for the file event_model-1.22.1rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for event_model-1.22.1rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 03368ba67ecc97de18d9b9aa5276e84d8a2014186f6542788cb77d076ac4e44e
MD5 522b6514b0be5ed1862ea51d8912c9ec
BLAKE2b-256 c67e3140837d3dbb5bdb714b564b3df002e20ea53e38f2d24f530a0871c85326

See more details on using hashes here.

Supported by

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