Skip to main content

Python Streaming Data Types

Utilities for working with the FlatBuffers schemas used at the European Spallation Source ERIC for data transport.

https://github.com/ess-dmsc/streaming-data-types

FlatBuffer Schemas

name description verifiable*
hs00 Histogram schema Y
ns10 NICOS cache entry schema Y
pl72 Run start N
6s4t Run stop N
f142 Log Data Y
ev42 Event Data Y
x5f2 Status messages Y

* whether it passes verification via the C++ FlatBuffers library.

hs00

Schema for histogram data. It is one of the more complicated to use schemas. It takes a Python dictionary as its input; this dictionary needs to have correctly named fields.

The input histogram data for serialisation and the output deserialisation data have the same dictionary "layout". Example for a 2-D histogram:

hist = {
    "source": "some_source",
    "timestamp": 123456,
    "current_shape": [2, 5],
    "dim_metadata": [
        {
            "length": 2,
            "unit": "a",
            "label": "x",
            "bin_boundaries": np.array([10, 11, 12]),
        },
        {
            "length": 5,
            "unit": "b",
            "label": "y",
            "bin_boundaries": np.array([0, 1, 2, 3, 4, 5]),
        },
    ],
    "last_metadata_timestamp": 123456,
    "data": np.array([[1, 2, 3, 4, 5], [6, 7, 8, 9, 10]]),
    "errors": np.array([[5, 4, 3, 2, 1], [10, 9, 8, 7, 6]]),
    "info": "info_string",
}

The arrays passed in for data, errors and bin_boundaries can be NumPy arrays or regular lists, but on deserialisation they will be NumPy arrays.

Release files for ess-streaming-data-types 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ess-streaming-data-types 0.6.0
File Size Uploaded
ess_streaming_data_types-0.6.0.tar.gz 22.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ess-streaming-data-types 0.6.0
File Interpreter ABI Platform
ess_streaming_data_types-0.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 73.1 kB

Release files / ess_streaming_data_types-0.6.0.tar.gz

Download URL ess_streaming_data_types-0.6.0.tar.gz
Size 22.0 kB
Tags Source
SHA-256 checksum
How to use checksums
af8af2cccde6858e824364de6e2313bcfa916a9e8021c90a4c23e4f7ba320289
BLAKE2b-256 checksum
How to use checksums
33edac29007fe33d41ec9011e1a720bb67ca2eca167b03b1afb9ec721b5c9750
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

Release files / ess_streaming_data_types-0.6.0-py3-none-any.whl

Download URL ess_streaming_data_types-0.6.0-py3-none-any.whl
Size 51.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d672096340832f15c317ea2ef268159c038f9cba6e0d5b66777af93d329fe0be
BLAKE2b-256 checksum
How to use checksums
b38196a7f00473bb5c6ff9aaa972786e882b7988323843c7e15e3a53fea9a3d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

Release history Release notifications | RSS feed

0.26.1

2 release files

0.26.0

2 release files

0.25.0

2 release files

0.24.0

2 release files

0.21.1

2 release files

0.19.0

2 release files

0.18.0

2 release files

0.17.0

2 release files

0.15.1

2 release files

0.15.0

2 release files

0.14.0

2 release files

0.13.1

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.10.1

2 release files

0.9.6

2 release files

0.9.5

2 release files

0.9.4

2 release files

0.9.3

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.1

2 release files

0.7.0

2 release files

This release

0.6.0 This release

2 release files

0.5.0

2 release files

0.4.1

3 release files

0.4.0

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page