diff --git a/main/.buildinfo b/main/.buildinfo index 74b38f9b..4e06c659 100644 --- a/main/.buildinfo +++ b/main/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 86170b6e0aa53cb350a12d27d17a5763 +config: 46dd32c70dd4decaab508d96099b3ede tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle index b0bb7667..f652b718 100644 Binary files a/main/.doctrees/environment.pickle and b/main/.doctrees/environment.pickle differ diff --git a/main/.doctrees/user/reference/release-history.doctree b/main/.doctrees/user/reference/release-history.doctree index 6f3d83d7..91abda8d 100644 Binary files a/main/.doctrees/user/reference/release-history.doctree and b/main/.doctrees/user/reference/release-history.doctree differ diff --git a/main/_modules/event_model.html b/main/_modules/event_model.html index 7b4e0139..2a125ccd 100644 --- a/main/_modules/event_model.html +++ b/main/_modules/event_model.html @@ -7,7 +7,7 @@ - event_model — event-model 1.19.9.dev6+ga4829b8 documentation + event_model — event-model 1.19.9.dev8+gab5dde3 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/_modules/index.html b/main/_modules/index.html index 778ad650..e09e6bb4 100644 --- a/main/_modules/index.html +++ b/main/_modules/index.html @@ -7,7 +7,7 @@ - Overview: module code — event-model 1.19.9.dev6+ga4829b8 documentation + Overview: module code — event-model 1.19.9.dev8+gab5dde3 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/_sources/user/reference/release-history.rst.txt b/main/_sources/user/reference/release-history.rst.txt index 85abb95f..495627e4 100644 --- a/main/_sources/user/reference/release-history.rst.txt +++ b/main/_sources/user/reference/release-history.rst.txt @@ -2,6 +2,13 @@ Release History *************** +v1.19.9 (2023-11-22) +==================== + +Changed +------- + +* Dropped support for `jsonschema 2.*`. v1.19.2 (2023-02-24) ==================== diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js index c1758d9f..1ab3d0b7 100644 --- a/main/_static/documentation_options.js +++ b/main/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '1.19.9.dev6+ga4829b8', + VERSION: '1.19.9.dev8+gab5dde3', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/main/developer/explanations/decisions.html b/main/developer/explanations/decisions.html index 59f461e6..72e2bf7c 100644 --- a/main/developer/explanations/decisions.html +++ b/main/developer/explanations/decisions.html @@ -8,7 +8,7 @@ - Architectural Decision Records — event-model 1.19.9.dev6+ga4829b8 documentation + Architectural Decision Records — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/explanations/decisions/0001-record-architecture-decisions.html b/main/developer/explanations/decisions/0001-record-architecture-decisions.html index a7df5c35..162f5c45 100644 --- a/main/developer/explanations/decisions/0001-record-architecture-decisions.html +++ b/main/developer/explanations/decisions/0001-record-architecture-decisions.html @@ -8,7 +8,7 @@ - 1. Record architecture decisions — event-model 1.19.9.dev6+ga4829b8 documentation + 1. Record architecture decisions — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/explanations/decisions/0002-switched-to-using-a-python-skeleton.html b/main/developer/explanations/decisions/0002-switched-to-using-a-python-skeleton.html index f7a992e3..9f395b28 100644 --- a/main/developer/explanations/decisions/0002-switched-to-using-a-python-skeleton.html +++ b/main/developer/explanations/decisions/0002-switched-to-using-a-python-skeleton.html @@ -8,7 +8,7 @@ - 2. Switched to using a python skeleton — event-model 1.19.9.dev6+ga4829b8 documentation + 2. Switched to using a python skeleton — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/how-to/build-docs.html b/main/developer/how-to/build-docs.html index 165f8829..aacf9d6c 100644 --- a/main/developer/how-to/build-docs.html +++ b/main/developer/how-to/build-docs.html @@ -8,7 +8,7 @@ - Build the docs using sphinx — event-model 1.19.9.dev6+ga4829b8 documentation + Build the docs using sphinx — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/how-to/contribute.html b/main/developer/how-to/contribute.html index f4f840bf..52158a3f 100644 --- a/main/developer/how-to/contribute.html +++ b/main/developer/how-to/contribute.html @@ -8,7 +8,7 @@ - Contributing to the project — event-model 1.19.9.dev6+ga4829b8 documentation + Contributing to the project — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/how-to/lint.html b/main/developer/how-to/lint.html index 0342eb4f..52932da7 100644 --- a/main/developer/how-to/lint.html +++ b/main/developer/how-to/lint.html @@ -8,7 +8,7 @@ - Run linting using pre-commit — event-model 1.19.9.dev6+ga4829b8 documentation + Run linting using pre-commit — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/how-to/make-release.html b/main/developer/how-to/make-release.html index f7cb88d4..9636047c 100644 --- a/main/developer/how-to/make-release.html +++ b/main/developer/how-to/make-release.html @@ -8,7 +8,7 @@ - Make a release — event-model 1.19.9.dev6+ga4829b8 documentation + Make a release — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/how-to/pin-requirements.html b/main/developer/how-to/pin-requirements.html index 6b5f46fb..53129cb6 100644 --- a/main/developer/how-to/pin-requirements.html +++ b/main/developer/how-to/pin-requirements.html @@ -8,7 +8,7 @@ - Pinning Requirements — event-model 1.19.9.dev6+ga4829b8 documentation + Pinning Requirements — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/how-to/run-tests.html b/main/developer/how-to/run-tests.html index a6521d7a..c1772310 100644 --- a/main/developer/how-to/run-tests.html +++ b/main/developer/how-to/run-tests.html @@ -8,7 +8,7 @@ - Run the tests using pytest — event-model 1.19.9.dev6+ga4829b8 documentation + Run the tests using pytest — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/how-to/static-analysis.html b/main/developer/how-to/static-analysis.html index 3f3da7a1..431a918c 100644 --- a/main/developer/how-to/static-analysis.html +++ b/main/developer/how-to/static-analysis.html @@ -8,7 +8,7 @@ - Run static analysis using mypy — event-model 1.19.9.dev6+ga4829b8 documentation + Run static analysis using mypy — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/how-to/update-tools.html b/main/developer/how-to/update-tools.html index 0d471e5c..8a37d0a5 100644 --- a/main/developer/how-to/update-tools.html +++ b/main/developer/how-to/update-tools.html @@ -8,7 +8,7 @@ - Update the tools — event-model 1.19.9.dev6+ga4829b8 documentation + Update the tools — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/index.html b/main/developer/index.html index 3068aef2..be94ec4a 100644 --- a/main/developer/index.html +++ b/main/developer/index.html @@ -8,7 +8,7 @@ - Developer Guide — event-model 1.19.9.dev6+ga4829b8 documentation + Developer Guide — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/reference/standards.html b/main/developer/reference/standards.html index 4beac7db..87dacb08 100644 --- a/main/developer/reference/standards.html +++ b/main/developer/reference/standards.html @@ -8,7 +8,7 @@ - Standards — event-model 1.19.9.dev6+ga4829b8 documentation + Standards — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/developer/tutorials/dev-install.html b/main/developer/tutorials/dev-install.html index 0e9e3f93..f80db4cc 100644 --- a/main/developer/tutorials/dev-install.html +++ b/main/developer/tutorials/dev-install.html @@ -8,7 +8,7 @@ - Developer install — event-model 1.19.9.dev6+ga4829b8 documentation + Developer install — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/genindex.html b/main/genindex.html index a9d21aae..1b5c5804 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -7,7 +7,7 @@ - Index — event-model 1.19.9.dev6+ga4829b8 documentation + Index — event-model 1.19.9.dev8+gab5dde3 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/index.html b/main/index.html index b6fa61db..26903372 100644 --- a/main/index.html +++ b/main/index.html @@ -8,7 +8,7 @@ - Event Model — event-model 1.19.9.dev6+ga4829b8 documentation + Event Model — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/search.html b/main/search.html index 50b65d1c..d2f39625 100644 --- a/main/search.html +++ b/main/search.html @@ -6,7 +6,7 @@ - Search - event-model 1.19.9.dev6+ga4829b8 documentation + Search - event-model 1.19.9.dev8+gab5dde3 documentation @@ -37,7 +37,7 @@ - + diff --git a/main/searchindex.js b/main/searchindex.js index 474b2b0e..bb00dbc4 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["developer/explanations/decisions", "developer/explanations/decisions/0001-record-architecture-decisions", "developer/explanations/decisions/0002-switched-to-using-a-python-skeleton", "developer/how-to/build-docs", "developer/how-to/contribute", "developer/how-to/lint", "developer/how-to/make-release", "developer/how-to/pin-requirements", "developer/how-to/run-tests", "developer/how-to/static-analysis", "developer/how-to/update-tools", "developer/index", "developer/reference/standards", "developer/tutorials/dev-install", "genindex", "index", "user/explanations/data-model", "user/explanations/docs-structure", "user/explanations/event-descriptors", "user/explanations/external", "user/how-to/use-cases", "user/index", "user/reference/api", "user/reference/release-history", "user/tutorials/installation"], "filenames": ["developer/explanations/decisions.rst", "developer/explanations/decisions/0001-record-architecture-decisions.rst", "developer/explanations/decisions/0002-switched-to-using-a-python-skeleton.rst", "developer/how-to/build-docs.rst", "developer/how-to/contribute.rst", "developer/how-to/lint.rst", "developer/how-to/make-release.rst", "developer/how-to/pin-requirements.rst", "developer/how-to/run-tests.rst", "developer/how-to/static-analysis.rst", "developer/how-to/update-tools.rst", "developer/index.rst", "developer/reference/standards.rst", "developer/tutorials/dev-install.rst", "genindex.rst", "index.rst", "user/explanations/data-model.rst", "user/explanations/docs-structure.rst", "user/explanations/event-descriptors.rst", "user/explanations/external.rst", "user/how-to/use-cases.rst", "user/index.rst", "user/reference/api.rst", "user/reference/release-history.rst", "user/tutorials/installation.rst"], "titles": ["Architectural Decision Records", "1. Record architecture decisions", "2. Switched to using a python skeleton", "Build the docs using sphinx", "Contributing to the project", "Run linting using pre-commit", "Make a release", "Pinning Requirements", "Run the tests using pytest", "Run static analysis using mypy", "Update the tools", "Developer Guide", "Standards", "Developer install", "API Index", "Event Model", "Data Model", "About The Documentation", "Event Descriptors", "External Assets", "Event Model Patterns", "User Guide", "API Documentation", "Release History", "Installation"], "terms": {"we": [0, 1, 2, 4, 7, 12, 15, 16, 18, 19, 20, 22, 23], "major": 0, "adr": [0, 1], "describ": [0, 1, 12, 16, 18, 19, 22], "michael": [0, 1], "nygard": [0, 1], "below": [0, 19, 22], "i": [0, 4, 5, 7, 8, 9, 10, 11, 12, 16, 17, 18, 19, 20, 21, 22, 23, 24], "list": [0, 7, 12, 16, 18, 22, 23], "our": [0, 16, 18, 19], "current": [0, 10, 19, 22, 23, 24], "1": [0, 12, 16, 18, 20, 22], "2": [0, 12, 15, 16, 18, 20, 22], "switch": 0, "us": [0, 1, 7, 11, 12, 13, 15, 16, 19, 22, 23, 24], "python": [0, 6, 7, 10, 12, 13, 15, 16, 19, 22, 23], "skeleton": [0, 7, 10], "date": [1, 2], "2023": [1, 2], "02": 1, "18": 1, "accept": [1, 2, 16, 19, 23], "need": [1, 7, 12, 17, 18, 19, 22, 23, 24], "made": [1, 7, 20, 23], "thi": [1, 3, 5, 6, 7, 10, 12, 13, 15, 16, 17, 18, 19, 22, 23, 24], "project": [1, 3, 7, 8, 10, 11, 23], "see": [1, 3, 6, 12, 15, 16, 18, 19, 22, 23], "": [1, 15, 16, 18, 19, 22, 23], "articl": 1, "link": [1, 11, 16, 21, 23], "abov": [1, 5, 12, 16, 18], "To": [1, 6, 7, 10, 13, 19, 20, 22, 23], "creat": [1, 6, 7, 16, 19, 20, 22, 23], "new": [1, 2, 4, 6, 21, 22, 23], "copi": [1, 7, 22], "past": 1, "from": [1, 3, 5, 11, 12, 15, 16, 18, 19, 20, 21, 22, 23, 24], "exist": [1, 4, 19, 23, 24], "ones": [1, 16], "03": [2, 16, 19], "23": 2, "should": [2, 4, 7, 12, 13, 15, 16, 19, 22, 24], "follow": [2, 4, 6, 12, 13, 16, 19, 22], "develop": [2, 15], "featur": [2, 16, 18, 22, 23, 24], "singl": [2, 16, 20], "pyproject": [2, 7], "toml": [2, 7], "instead": [2, 4, 16, 23], "requir": [2, 11, 13, 16, 17, 20, 22, 23, 24], "txt": [2, 7, 23], "dev": [2, 11, 13], "black": [2, 5, 12], "isort": [2, 5, 12], "have": [2, 4, 5, 7, 12, 13, 16, 18, 19, 20, 22, 23], "git": [2, 5, 10, 13, 24], "version": [2, 7, 10, 16, 22, 23], "gener": [2, 6, 10, 16, 18, 19, 22], "setup": [2, 10, 13, 19, 23], "py": [2, 19, 23], "mypi": [2, 11, 12, 13], "pre": [2, 11, 12, 13, 23], "commit": [2, 7, 11, 12, 13], "dl": 2, "pip": [2, 7, 10, 13, 15, 24], "ci": 2, "workflow": [2, 23], "chang": [2, 3, 4, 5, 7, 10, 15, 16, 18, 19, 20, 22], "even": [2, 12], "job": 2, "provid": [2, 7, 10, 12, 16, 18, 19, 20, 22, 23], "same": [2, 4, 6, 7, 18, 19, 20, 22, 23], "older": 2, "check": [2, 4, 5, 8, 9, 10, 12, 13, 19, 22, 23], "you": [3, 4, 5, 6, 7, 8, 9, 12, 13, 15, 19, 20, 22, 24], "can": [3, 4, 5, 7, 8, 9, 12, 13, 16, 18, 19, 20, 22, 23, 24], "base": [3, 16, 20, 22, 23], "directori": [3, 12], "run": [3, 4, 10, 11, 12, 13, 18, 19, 20, 22, 23], "tox": [3, 5, 8, 9, 13], "e": [3, 5, 7, 8, 9, 12, 13, 16, 19, 22, 23], "static": [3, 11, 12, 13, 16], "which": [3, 10, 12, 13, 16, 18, 19, 22, 23], "includ": [3, 12, 16, 19, 21, 22, 23], "api": [3, 12, 21, 23], "pull": [3, 4, 10, 16], "docstr": [3, 12], "code": [3, 5, 13, 15, 16, 22, 23], "document": [3, 4, 11, 18, 20, 21, 23], "standard": [3, 4, 11, 16], "The": [3, 4, 7, 12, 15, 16, 18, 20, 21, 22, 23, 24], "built": [3, 22, 23], "html": [3, 22], "open": [3, 4, 19], "local": [3, 13, 16], "web": 3, "browser": 3, "firefox": 3, "index": [3, 16, 19, 21], "also": [3, 4, 5, 8, 11, 12, 16, 18, 19, 21, 22, 24], "an": [3, 5, 7, 10, 12, 16, 18, 19, 20, 22, 23], "process": [3, 12, 16, 18, 20, 22], "watch": 3, "your": [3, 4, 5, 7, 15], "rebuild": 3, "whenev": 3, "reload": 3, "ani": [3, 4, 5, 7, 10, 16, 19, 22, 23, 24], "page": [3, 6, 7, 12, 22, 23], "view": [3, 19, 23], "localhost": 3, "http": [3, 6, 10, 15, 22, 24], "8000": 3, "If": [3, 4, 5, 19, 22, 23, 24], "ar": [3, 4, 7, 12, 15, 16, 17, 18, 19, 20, 22, 23], "make": [3, 4, 11, 16, 19, 20, 22, 23], "sourc": [3, 9, 13, 15, 16, 18, 19, 22, 23, 24], "too": 3, "tell": [3, 5, 19], "event_model": [3, 19, 22, 24], "most": [4, 16, 17, 22], "welcom": 4, "all": [4, 5, 7, 12, 16, 18, 19, 20, 22, 23], "request": [4, 10], "handl": [4, 5, 16, 19], "through": [4, 13, 20, 22, 23], "github": [4, 6, 10, 13, 23, 24], "pleas": [4, 6, 12, 15, 20], "befor": [4, 15, 16, 19, 22, 23], "file": [4, 5, 9, 16, 19, 22], "one": [4, 7, 12, 16, 17, 18, 19, 20, 22, 23], "great": 4, "idea": [4, 7], "involv": [4, 18, 23], "big": 4, "ticket": 4, "want": [4, 16, 22, 23], "sure": [4, 22], "don": [4, 18], "t": [4, 12, 17, 18, 19, 22], "spend": 4, "time": [4, 5, 7, 16, 18, 19, 20, 22], "someth": [4, 10, 19], "might": [4, 16, 18, 19, 20], "fit": 4, "scope": [4, 16], "offer": 4, "place": [4, 7, 16, 19, 22, 23], "ask": [4, 19], "question": [4, 19, 23], "share": [4, 19, 22], "end": [4, 16], "obviou": 4, "when": [4, 7, 12, 16, 19, 20, 22, 23], "close": [4, 10, 12, 19, 22], "rais": [4, 12, 19, 22, 23], "while": 4, "100": 4, "doe": [4, 22, 23], "librari": [4, 7, 21], "bug": [4, 23], "free": [4, 22], "significantli": [4, 16], "reduc": 4, "number": [4, 6, 7, 16, 18, 19, 20, 22, 23], "easili": 4, "caught": 4, "remain": [4, 22], "improv": [4, 17], "contain": [4, 7, 12, 15, 16, 19, 20, 22, 23], "inform": [4, 15, 16, 17, 18, 19, 20, 22, 23], "set": [4, 7, 12, 16, 22, 23], "up": [4, 11, 19, 22, 23], "environ": [4, 7, 13, 19], "test": [4, 7, 11, 22, 23], "what": [4, 15, 16, 19, 20], "flake8": [5, 12], "under": [5, 12], "command": 5, "Or": [5, 22], "instal": [5, 7, 11, 15, 19, 21, 23], "hook": [5, 19], "each": [5, 7, 16, 18, 19, 20, 22, 23], "do": [5, 7, 9, 15, 16, 18, 19, 20, 22, 23], "just": [5, 20], "It": [5, 7, 8, 9, 16, 19, 22, 23, 24], "possibl": [5, 7], "automat": 5, "enabl": [5, 15, 16, 23], "clone": [5, 22, 23], "repositori": [5, 7, 12, 15], "result": [5, 19], "being": [5, 16, 20, 23], "everi": [5, 7, 16, 18, 23], "repo": [5, 7], "user": [5, 15, 16, 20, 22], "now": [5, 13, 19, 23, 24], "report": [5, 8], "reformat": 5, "likewis": [5, 23], "get": [5, 6, 7, 11, 13, 16, 22, 23], "those": [5, 12, 16, 20, 22], "manual": [5, 22], "checklist": 6, "choos": 6, "pep440": 6, "compliant": [6, 22], "pep": 6, "org": 6, "0440": 6, "go": [6, 7], "draft": 6, "click": [6, 7], "tag": 6, "suppli": 6, "chose": 6, "note": [6, 12, 16, 20, 21], "review": 6, "edit": 6, "titl": [6, 12, 16], "publish": [6, 7, 23], "push": [6, 7], "main": 6, "branch": 6, "ha": [6, 7, 10, 16, 18, 19, 22, 23, 24], "effect": 6, "except": [6, 22, 23], "option": [6, 12, 16, 18, 19, 20, 22, 23], "By": [7, 22], "design": [7, 15, 16, 19, 20], "onli": [7, 16, 19, 22, 23], "defin": [7, 12, 16, 20], "tabl": [7, 16], "In": [7, 18, 19, 20, 22, 23], "some": [7, 12, 15, 16, 19, 22, 23], "For": [7, 12, 15, 16, 18, 20, 23], "best": [7, 20, 23], "leav": 7, "minimum": 7, "so": [7, 13, 16, 22, 23, 24], "widest": 7, "rang": [7, 16], "applic": [7, 19, 22], "build": [7, 11, 12], "latest": [7, 10], "compat": [7, 16, 22, 23], "avail": [7, 23], "after": [7, 12, 16, 19, 22], "approach": [7, 17], "mean": [7, 10, 12, 16, 18, 23], "futur": [7, 16, 22, 23], "mai": [7, 12, 16, 19, 22, 23], "break": 7, "becaus": [7, 12, 18, 19, 22, 23], "updat": [7, 11], "releas": [7, 11, 15, 16, 19, 21, 22, 24], "correct": [7, 23], "wai": [7, 16, 19, 21, 22, 23], "fix": [7, 16], "issu": [7, 9], "work": [7, 21, 23], "out": [7, 12, 19, 20, 23], "resolv": [7, 22], "problem": 7, "howev": 7, "quit": [7, 16, 20], "hard": 7, "consum": [7, 16, 19, 20, 22], "simpli": [7, 22], "try": [7, 22, 23], "minor": 7, "reason": [7, 16, 19, 22], "mechan": [7, 19, 22], "previou": [7, 19, 23], "success": [7, 16, 22], "quick": [7, 15], "guarante": [7, 22], "asset": [7, 16, 21], "exampl": [7, 12, 18, 19, 20, 22, 23], "take": [7, 13, 16, 19, 20, 22, 23], "look": [7, 8, 15, 16, 18, 19], "python3": [7, 10, 13, 24], "cli": 7, "here": [7, 12, 16, 18, 19, 20, 21, 22], "diamondlightsourc": 7, "There": [7, 12, 17, 22], "show": [7, 16, 20], "virtual": 7, "multipl": [7, 10, 12, 16, 18, 19, 20, 22, 23], "differ": [7, 15, 16, 17, 18, 20, 22, 23], "freez": 7, "full": [7, 15], "sub": 7, "download": 7, "them": [7, 8, 9, 16, 19, 20, 22, 23], "ran": 7, "lowest": 7, "more": [7, 10, 12, 16, 17, 18, 19, 20, 21, 22, 23], "like": [7, 8, 12, 16, 18, 19, 22, 23], "matrix": 7, "ubuntu": 7, "3": [7, 12, 13, 16, 18, 20, 22, 24], "8": [7, 13, 24], "lockfil": 7, "root": [7, 16, 19, 22], "renam": 7, "pass": [7, 12, 16, 22, 23], "exactli": [7, 22], "packag": [7, 13, 22, 23], "onc": [7, 22], "been": [7, 16, 19, 22, 23, 24], "good": [7, 17], "back": [7, 12, 15, 16, 18, 19, 20, 23], "unlock": 7, "earli": 7, "indic": [7, 10, 16, 19], "incom": [7, 22], "restor": 7, "done": [8, 9, 12, 22, 23], "find": [8, 19], "function": [8, 12, 16, 17, 22, 23], "error": [8, 16, 19, 23], "coverag": 8, "commandlin": [8, 24], "cov": 8, "xml": 8, "type": [9, 12, 13, 15, 18, 19, 20, 22, 23, 24], "definit": [9, 16, 20], "without": [9, 16], "highlight": 9, "potenti": [9, 20, 22, 23], "where": [9, 10, 16, 18, 19], "match": [9, 19], "modul": [10, 12, 19, 22], "merg": 10, "structur": [10, 16, 20], "keep": [10, 19, 22], "techniqu": [10, 12, 20], "sync": 10, "between": [10, 18, 19, 20, 22], "rebas": 10, "fals": [10, 16, 19, 22, 23], "com": [10, 13, 24], "blueski": [10, 13, 16, 19, 23, 24], "conflict": 10, "area": [10, 19], "detail": [10, 12, 15, 18, 19, 22, 23], "split": [11, 15, 21], "four": [11, 17, 21], "categori": [11, 18, 21], "access": [11, 16, 19, 21], "side": [11, 19, 21], "bar": [11, 21], "contribut": [11, 15, 20], "doc": [11, 12, 13, 22], "sphinx": [11, 12, 13], "pytest": [11, 13], "analysi": [11, 12, 13, 15, 16, 20, 22], "lint": [11, 12, 13], "tool": [11, 12, 15, 16, 20, 22], "pin": 11, "practic": [11, 21], "step": [11, 13, 16, 20, 21], "dai": [11, 22], "task": 11, "architectur": 11, "decis": [11, 20], "record": [11, 15, 16, 18, 23], "why": [11, 16, 19, 21], "technic": [11, 17, 21], "materi": [11, 21], "conform": [12, 22], "format": [12, 16, 19], "style": 12, "import": [12, 19, 22], "order": [12, 16, 17, 20], "how": [12, 16, 17, 19, 20, 22, 23], "guid": [12, 15, 17], "napoleon": 12, "extens": [12, 22], "As": [12, 16, 19, 22], "numpydoc": 12, "consid": [12, 16, 18, 20, 22], "hint": [12, 16, 19, 22], "signatur": [12, 19, 22], "def": [12, 19], "foo": 12, "var1": 12, "var2": 12, "arg": [12, 16, 22], "long_var_nam": 12, "hi": 12, "only_seldom_used_keyword": 12, "0": [12, 16, 18, 19, 20, 22], "kwarg": [12, 16, 22], "r": 12, "summar": 12, "line": [12, 16], "sever": [12, 19, 22, 23], "sentenc": 12, "extend": 12, "descript": [12, 16, 18], "refer": [12, 15, 16, 17, 18, 19, 22, 23], "variabl": [12, 18], "tick": 12, "g": [12, 16, 19, 22], "var": 12, "paramet": [12, 16, 18, 19, 22, 23], "array_lik": 12, "object": [12, 16, 19, 22, 23], "nest": [12, 16, 22], "etc": [12, 16, 20], "convert": [12, 22, 23], "arrai": [12, 16, 18, 19, 22, 23], "int": [12, 22], "either": [12, 20, 23], "actual": [12, 16, 22, 23], "n": [12, 16], "ndarrai": [12, 22], "iter": [12, 22], "other": [12, 16, 19, 22], "argument": [12, 16, 19, 22, 23], "ho": 12, "choic": [12, 20], "bracket": 12, "default": [12, 19, 22, 23], "first": [12, 13, 16, 18, 22], "return": [12, 18, 19, 22, 23], "explan": [12, 17], "anonym": 12, "valu": [12, 16, 18, 19, 22], "name": [12, 16, 18, 19, 20, 23], "type_without_descript": 12, "infrequ": 12, "section": [12, 15, 16, 18, 19], "prevent": [12, 22, 23], "clutter": 12, "dict": [12, 18, 19, 22], "keyword": [12, 22], "appear": [12, 19], "specifi": [12, 16, 18, 22], "badexcept": 12, "shouldn": 12, "numpi": [12, 22, 23], "relationship": [12, 20], "could": [12, 16, 20, 22], "fairli": 12, "long": [12, 16, 22, 23], "case": [12, 16, 19, 23], "wrap": 12, "dot": 12, "linalg": 12, "norm": 12, "ey": 12, "about": [12, 15, 16, 18, 19, 21, 23], "implement": [12, 16, 19, 20, 22, 23], "algorithm": 12, "paragraph": 12, "math": 12, "x": [12, 16, 18, 23], "j": 12, "omega": 12, "And": [12, 16], "greek": 12, "symbol": 12, "inlin": 12, "cite": 12, "relev": [12, 19, 23], "literatur": 12, "_": 12, "o": [12, 22, 23], "mcnoleg": 12, "integr": [12, 19], "gi": 12, "remot": 12, "sens": [12, 16], "expert": 12, "system": [12, 15, 16, 19, 20, 22], "adapt": [12, 23], "co": 12, "krige": 12, "environment": 12, "habitat": 12, "model": [12, 13, 18, 19, 21, 22, 23, 24], "highland": 12, "haggi": 12, "orient": 12, "fuzzi": 12, "logic": [12, 23], "neural": 12, "network": [12, 16, 19], "comput": [12, 16, 22, 23], "geoscienc": 12, "vol": 12, "22": 12, "pp": 12, "585": 12, "588": 12, "1996": 12, "These": [12, 13, 22, 23], "written": [12, 16], "doctest": 12, "illustr": 12, "print": [12, 22, 23], "4": [12, 20], "5": [12, 18, 19], "6": [12, 23], "nb": 12, "b": [12, 22], "blank": 12, "method": [12, 18, 19, 22, 23], "extract": 12, "underlin": 12, "convent": 12, "headl": 12, "head": [12, 16], "instruct": [13, 16], "minim": [13, 16], "event": [13, 19, 21, 22, 23, 24], "venv": [13, 24], "later": [13, 15, 16, 19, 22, 23, 24], "cd": 13, "m": [13, 24], "bin": [13, 24], "activ": [13, 24], "graph": 13, "tree": 13, "pipdeptre": 13, "termin": [13, 24], "p": 13, "parallel": 13, "pypi": [15, 23], "blueskyproject": [15, 22], "io": [15, 22], "A": [15, 16, 18, 19, 20, 22, 23], "primari": [15, 16, 19, 20], "goal": [15, 16], "better": [15, 16, 23], "research": [15, 16], "rich": [15, 16], "metadata": [15, 16, 18, 22, 23], "alongsid": [15, 16], "measur": [15, 16], "formal": [15, 16], "schema": [15, 16, 23], "stream": [15, 19, 20, 22, 23], "compos": [15, 16, 22, 23], "valid": [15, 16, 22, 23], "transform": [15, 16, 22], "veri": [15, 16, 19, 20], "put": [15, 19, 20], "kind": 15, "sampl": [15, 16, 20], "know": [15, 16, 19, 23], "start": [15, 18, 21, 22, 23], "experi": [15, 16, 18], "intend": [15, 16, 22, 23], "who": [15, 16], "extern": [15, 16, 18, 21, 22, 23], "databas": [15, 20, 22], "detector": [15, 16, 18, 19], "calibr": 15, "dark": 15, "frame": 15, "flat": 15, "field": [15, 16, 18, 19, 20, 22, 23], "mask": 15, "probabl": 15, "its": [15, 18, 19, 20, 22, 23, 24], "own": [15, 20], "shape": [15, 16, 18, 19, 23], "unit": [15, 16, 18, 19], "descriptor": [15, 19, 20, 22, 23], "data_kei": [15, 16, 18, 19, 22], "entri": [15, 16], "anyth": 15, "read": [15, 16, 18, 19, 20, 23], "control": 15, "devic": [15, 16, 18], "configur": [15, 16, 19, 22, 23], "term": [16, 18], "dictionari": [16, 22], "runengin": [16, 18, 22, 23], "emit": [16, 22, 23], "dure": [16, 18, 19, 22], "plan": 16, "execut": [16, 23], "organ": 16, "support": [16, 23], "complex": [16, 18], "asynchron": 16, "collect": [16, 22], "sophist": 16, "live": [16, 22], "prompt": 16, "post": [16, 20], "facto": 16, "outsid": [16, 19], "subscrib": [16, 22, 23], "visual": 16, "save": 16, "outlin": 16, "themselv": 16, "aim": 16, "give": [16, 19], "familiar": 16, "compon": 16, "eight": 16, "repres": [16, 17, 20], "map": [16, 18, 19, 20, 22], "json": [16, 19, 22], "languag": 16, "class": [16, 19, 22, 23], "flexibl": 16, "everyth": [16, 22], "simul": 16, "acquisit": 16, "begin": 16, "row": [16, 23], "associ": [16, 18, 22], "timestamp": [16, 18, 20, 22], "seri": [16, 19], "envis": 16, "richli": 16, "column": [16, 23], "encompass": 16, "physic": 16, "hardwar": [16, 18], "pointer": 16, "predict": 16, "dimension": 16, "specif": [16, 18, 19, 22, 23], "slice": [16, 19], "within": [16, 20], "restrict": 16, "length": 16, "dimens": [16, 18, 23], "known": 16, "point": [16, 18, 19, 20], "exit": [16, 22], "statu": [16, 23], "succeed": 16, "abort": [16, 22], "fail": [16, 22], "due": [16, 23], "uniqu": [16, 18, 22], "identifi": [16, 18, 20, 22], "run_start": [16, 18, 19, 20], "thu": [16, 19], "liter": [16, 19, 22, 23], "store": [16, 18, 19, 20, 23], "yet": [16, 19], "load": [16, 19, 22], "manag": [16, 22, 23], "final": [16, 22], "form": 16, "effici": [16, 19, 20], "transport": 16, "vector": 16, "represent": [16, 22], "equival": 16, "eventpag": [16, 19, 22, 23], "alwai": [16, 18, 19, 23], "loss": 16, "vice": 16, "versa": 16, "left": [16, 19, 23], "instrument": 16, "team": 16, "individu": [16, 22], "scientist": 16, "given": [16, 18, 19, 22, 23], "sequenc": [16, 22, 23], "short": 16, "sai": 16, "count": [16, 22], "multi": 16, "procedur": 16, "raster": 16, "scan": [16, 19, 20], "togeth": [16, 18, 20], "nontrivi": 16, "satisfi": 16, "typic": [16, 18, 19, 21, 22], "encod": [16, 22], "again": [16, 18, 20], "mark": 16, "compris": 16, "seem": 16, "natur": [16, 20], "block": [16, 23], "than": [16, 19, 23], "allow": [16, 18, 19, 23], "u": [16, 19], "comment": [16, 19, 22], "1550069716": 16, "5092213": 16, "unix": [16, 22], "epoch": [16, 22], "second": [16, 22], "sinc": 16, "jan": 16, "1970": 16, "uid": [16, 18, 19, 20, 22, 23], "10bf6945": [16, 19], "4afd": [16, 19], "43ca": [16, 19], "af36": [16, 19], "6ad8f3540bcd": [16, 19], "global": [16, 19], "id": [16, 18, 23], "data_sess": [16, 23], "vist54321": 16, "data_group": [16, 23], "bl42": 16, "proposal12345": 16, "random_walk": 16, "dt": 16, "motor": [16, 18], "num_interv": 16, "num_point": 16, "plan_arg": 16, "epicssign": 16, "read_pv": 16, "1550070001": 16, "828528": 16, "auto_monitor": 16, "string": [16, 18, 22], "write_pv": 16, "limit": 16, "put_complet": 16, "61472277847348": 16, "1550070000": 16, "807677": 16, "num": 16, "per_step": 16, "none": [16, 18, 22, 23], "plan_nam": 16, "plan_pattern": 16, "inner_product": 16, "plan_pattern_arg": 16, "plan_pattern_modul": 16, "plan_typ": 16, "scan_id": 16, "1550070004": 16, "9850419": 16, "ba1f9076": 16, "7925": 16, "4af8": 16, "916e": 16, "0e1eaa1b3c47": 16, "softwar": [16, 17, 24], "would": [16, 20, 22], "cours": [16, 19, 20], "translat": 16, "human": [16, 19], "readabl": 16, "aid": 16, "interact": 16, "vocabulari": 16, "varieti": 16, "suitcas": 16, "experimet": 16, "subject": [16, 19], "backward": [16, 22, 23], "incompat": [16, 22], "seach": 16, "target": 16, "calcul": [16, 22], "properti": 16, "item": [16, 19, 22], "callabl": [16, 19, 22], "perform": [16, 23], "calcal": 16, "datatyp": 16, "additionalproperti": 16, "patternproperti": 16, "ref": [16, 18], "level": [16, 20, 22, 23], "independ": 16, "ax": 16, "slow": 16, "fast": 16, "anyof": 16, "allof": 16, "config_devic": 16, "config": 16, "config_index": 16, "integ": [16, 22], "locat": [16, 19, 20], "come": [16, 19], "event_descriptor": [16, 22], "enum": [16, 22], "explicit": [16, 23], "interperet": 16, "spec": [16, 19, 22, 23], "group": 16, "facil": 16, "beamlin": [16, 20], "station": 16, "propos": 16, "safeti": 16, "session": 16, "mandat": 16, "scientif": 16, "visit": 16, "trial": 16, "data_typ": 16, "owner": 16, "part": [16, 19], "anoth": [16, 20], "state": [16, 19, 22], "kei": [16, 19, 22, 23], "layout": [16, 20], "cover": 16, "defer": 16, "camera_imag": 16, "dtype": [16, 18, 19], "512": [16, 19, 22], "pv": 16, "object_kei": [16, 18, 22], "foreign": [16, 19], "1550070954": 16, "276659": 16, "d08d2ada": 16, "5f4e": 16, "495b": 16, "8e73": 16, "ff36186e7183": 16, "lower_ctrl_limit": 16, "precis": [16, 18], "upper_ctrl_limit": 16, "994477": 16, "9221013521832928": 16, "812525": 16, "object_nam": [16, 19, 23], "1550070005": 16, "0109222": 16, "0ad55d9": 16, "1b31": 16, "4af2": 16, "865c": 16, "7ab7c8171303": 16, "captur": 16, "datakei": [16, 22, 23], "dim": [16, 23], "null": 16, "empti": [16, 22, 23], "scalar": [16, 19], "boolean": [16, 22], "pattern": [16, 21], "z": 16, "wa": [16, 23], "digit": 16, "decim": 16, "float": [16, 22], "ex": 16, "piec": 16, "engin": 16, "perobjecthint": [16, 22], "interest": [16, 20], "necessari": [16, 19], "interpret": 16, "friendli": 16, "baselin": 16, "signal": 16, "produc": [16, 18, 22], "creation": [16, 17, 19], "directli": [16, 19, 23], "512x512": 16, "fill": [16, 22, 23], "seq_num": [16, 18, 20, 22], "1550072091": 16, "2793343": 16, "2793014": 16, "8eac2f83": 16, "2b3e": 16, "4d67": 16, "ae2c": 16, "1d3aaff29ff5": 16, "via": [16, 18, 23], "datum_id": [16, 19], "272132cf": 16, "564f": 16, "428f": 16, "bf6b": 16, "149ee4287024": 16, "0189056": 16, "7b5343fe": 16, "dfd7": 16, "4884": 16, "bc18": 16, "a0b571ff60b7": 16, "perspect": 16, "were": [16, 19, 23], "simultan": 16, "occur": [16, 22, 23], "separ": [16, 19, 20, 22], "thrown": 16, "awai": 16, "thei": [16, 17, 18, 19, 22, 23], "overal": 16, "often": [16, 17, 18], "quanta": 16, "eventdescriptor": [16, 22, 23], "belong": [16, 19], "move": [16, 19, 20, 22], "seq": 16, "mayb": 16, "content": [16, 19], "event_pag": [16, 22, 23], "datafram": 16, "dataframeforfil": 16, "intent": [16, 20], "numer": 16, "bool": [16, 22], "homogen": 16, "never": 16, "terminologi": 16, "respect": [16, 19, 22], "simplifi": 16, "assumpt": 16, "justif": 16, "lead": 16, "arbitrarili": [16, 22], "turn": [16, 19], "until": [16, 19], "complet": [16, 22, 23], "commonli": 16, "exit_statu": [16, 22], "546cc556": 16, "5f69": 16, "46b5": 16, "bf36": 16, "587d8cfe67a9": 16, "1550072737": 16, "175858": 16, "61bb1db8": 16, "c95c": 16, "4144": 16, "845b": 16, "e248c06d80e1": 16, "num_ev": [16, 23], "1580172029": 16, "3419003": 16, "78c70c2c": 16, "2508": 16, "479e": 16, "9857": 16, "05553748022e": 16, "10": [16, 19], "run_stop": 16, "per": [16, 20], "pair": 16, "role": 16, "plai": 16, "referenc": [16, 19, 22], "larg": [16, 18, 19, 20, 22], "path_semant": [16, 19, 22], "posix": [16, 19, 22], "resource_kwarg": [16, 19, 22], "resource_path": [16, 19, 22], "path": [16, 19, 23, 24], "subdirectori": 16, "data_fil": 16, "some_spec": 16, "ad_hdf5": [16, 19], "gpf": [16, 19], "andor": [16, 19], "2020": [16, 19], "01": [16, 19], "8ff08ff9": [16, 19], "a2bf": [16, 19], "48c3": [16, 19], "8ff3": [16, 19], "dcac0f309d7d": [16, 19], "h5": [16, 19], "frame_per_point": [16, 19], "3b300e6f": [16, 19], "b431": [16, 19], "4750": [16, 19], "a635": [16, 19], "5630d15c81a8": [16, 19], "semant": [16, 19, 23], "rule": 16, "join": 16, "window": [16, 22], "addit": [16, 18, 19, 22, 23], "handler": [16, 22, 23], "filepath": [16, 19], "uri": 16, "subset": [16, 19], "datum_kwarg": [16, 19, 22, 23], "counter": [16, 22, 23], "akin": 16, "retriev": [16, 19, 20], "strucut": 16, "datum_pag": [16, 22, 23], "nativ": 16, "rag": [16, 23], "photon": 16, "mani": [16, 18, 19, 20, 23], "rel": [16, 19], "small": [16, 19, 20], "fluoresc": 16, "detector_1": 16, "stream_resourc": [16, 22], "86340942": 16, "9865": 16, "47f9": 16, "9a8d": 16, "bdaaab1bfce2": 16, "8c70b8c2": 16, "df32": 16, "40e3": 16, "9f50": 16, "29cda8142fa0": 16, "stream_datum": [16, 22], "streamrang": 16, "increment": 16, "last": [16, 19], "less": 16, "streamresourc": [16, 22], "hand": [16, 19, 20, 23], "correspond": [16, 22], "suggest": [16, 19, 22], "stream_nam": 16, "block_id": 16, "whether": [16, 19], "bulk_ev": [16, 22], "datumpag": [16, 22, 23], "datum_kwarg_list": 16, "bulk_datum": [16, 22], "grand": 17, "unifi": 17, "theori": 17, "david": 17, "la": 17, "secret": 17, "understood": 17, "write": 17, "isn": 17, "thing": [17, 20], "call": [17, 18, 22, 23], "tutori": 17, "purpos": [17, 20, 23], "understand": 17, "implic": 17, "help": [17, 19], "immens": 17, "topic": 17, "gave": 18, "overview": 18, "present": [18, 20], "discuss": [18, 20], "recal": 18, "temperatur": [18, 19], "x_setpoint": 18, "x_readback": 18, "05": 18, "1442521007": 18, "9258342": 18, "5029348": 18, "3438923": 18, "randomli": 18, "ten": 18, "sequenti": 18, "ident": [18, 23], "got": 18, "5x5": 18, "epic": 18, "imag": [18, 19], "arbitrari": 18, "obtain": 18, "excerpt": [18, 19], "k": 18, "mm": 18, "suppos": [18, 19], "came": 18, "temp_ctrl": 18, "anew": 18, "middl": 18, "exposur": 18, "usual": [18, 19], "delin": 18, "two": [18, 19, 20, 22, 23], "normal": 18, "read_configur": 18, "told": 18, "describe_configur": 18, "collat": 18, "happen": 18, "offset": 18, "534918": 18, "experiment": [18, 22, 23], "attribut": [18, 23], "taken": [18, 19, 20], "data": [19, 20, 21, 22, 23], "mixtur": 19, "size": 19, "suitabl": [19, 22], "mongodb": [19, 22], "text": 19, "aa10035d": 19, "1d2b": 19, "41d9": 19, "97e6": 19, "03e3fe62fa6c": 19, "219310e0": 19, "faa0": 19, "4990": 19, "84a0": 19, "95b508d4ae35": 19, "omit": 19, "breviti": 19, "placehold": 19, "consult": [19, 23], "Of": 19, "abl": 19, "guess": 19, "wouldn": 19, "program": 19, "goe": 19, "presenc": 19, "futu": 19, "must": [19, 22], "datum": [19, 22, 23], "stack": 19, "notic": 19, "still": [19, 23], "anywher": 19, "common": [19, 20], "hdf5": 19, "tiff": 19, "rather": [19, 23], "redundantli": 19, "ll": 19, "relat": [19, 22, 23], "lifecycl": [19, 22], "context": [19, 22], "depend": [19, 22, 23, 24], "over": [19, 22], "special": [19, 23], "databrok": [19, 23], "reader": 19, "exchang": 19, "pertin": 19, "handler_class": [19, 22], "full_path": [19, 22], "expect": [19, 22, 23], "instanc": [19, 22, 23], "handler_inst": [19, 22], "__init__": [19, 22], "__call__": [19, 22, 23], "myhandl": 19, "self": 19, "stash": 19, "chunk": 19, "some_array_lik": 19, "But": [19, 22], "f": [19, 22], "get_file_list": 19, "presum": 19, "filesystem": [19, 23], "cach": [19, 22, 23], "connect": 19, "filler": [19, 22, 23], "runrout": [19, 22, 23], "easier": [19, 23], "reus": [19, 23], "clean": 19, "proper": 19, "discov": 19, "core": 19, "handler_registri": [19, 22, 23], "discover_handl": 19, "search": 19, "output": [19, 22], "ad_cbf": 19, "area_detector_handl": 19, "pilatuscbfhandl": 19, "areadetectorhdf5handl": 19, "ad_hdf5_swmr": 19, "areadetectorhdf5swmrhandl": 19, "ad_hdf5_swmr_t": 19, "areadetectorhdf5swmrtimestamphandl": 19, "ad_hdf5_t": 19, "areadetectorhdf5timestamphandl": 19, "ad_sp": 19, "areadetectorspehandl": 19, "ad_tiff": 19, "areadetectortiffhandl": 19, "xsp3": 19, "_xspress3": 19, "xspress3hdf5handl": 19, "xsp3_fly": 19, "bulkxspress": 19, "rare": 19, "determin": [19, 23], "track": 19, "flight": 19, "alreadi": [19, 22], "_partially_": 19, "shown": 19, "registri": 19, "cannot": [19, 23], "undefinedassetspecif": [19, 22], "concern": 19, "alloc": 19, "inject": 19, "custom": [19, 22, 23], "cachetool": 19, "lrucach": 19, "lfucach": 19, "receiv": [19, 22], "prepopul": 19, "entir": 19, "lru": 19, "handler_cach": [19, 22], "32": 19, "f1": 19, "f2": 19, "both": [19, 20, 23], "therein": 19, "evict": 19, "recov": 19, "gracefulli": 19, "recreat": 19, "demand": 19, "conveni": [19, 22, 23], "dispos": 19, "rr": 19, "entrypoint": 19, "declar": 19, "entry_point": 19, "imm": 19, "immhandl": 19, "On": [19, 20], "right": 19, "particular": 20, "pro": 20, "con": 20, "further": [20, 22], "complic": 20, "optim": 20, "scenario": 20, "feedback": 20, "docstream": 20, "mongo": 20, "visualizt": 20, "granular": 20, "quickli": 20, "affect": 20, "much": 20, "larger": 20, "preferr": 20, "concept": 20, "chosen": 20, "around": [20, 23], "axi": 20, "volum": 20, "stitch": 20, "variou": [20, 23], "mosaic": 20, "altern": [20, 23], "let": [20, 22, 23], "boundari": [20, 22], "posit": 20, "With": [20, 23], "assign": 20, "4fa521e7": 20, "fcdc": 20, "4a68": 20, "9171": 20, "d4838d1fc9a2": 20, "1600995123": 20, "1785965": 20, "9b5dd575": 20, "b556": 20, "439a": 20, "ba71": 20, "357307caebb9": 20, "tile_0": 20, "a82a83b0": 20, "5959": 20, "4ca3": 20, "a7": 20, "7fb1d0f07994": 20, "tile_1": 20, "Then": 20, "carri": 20, "c4aa6916": 20, "3d84": 20, "446c": 20, "850a": 20, "95fb71cee6b6": 20, "1808913": 20, "somehow": 20, "tile_id": 20, "summari": 20, "advantag": 20, "tomograph": 20, "ad": 20, "hijack": 20, "challeng": 20, "prove": 20, "extrem": 20, "downstream": 20, "visul": 20, "bounari": 20, "usag": 21, "experienc": 21, "histori": 21, "intern": 22, "__version__": [22, 23], "str": 22, "pypa": 22, "setuptools_scm": 22, "documentnam": 22, "qualnam": 22, "stop": 22, "resourc": [22, 23], "schema_valid": [22, 23], "member": 22, "jsonschema": [22, 23], "ivalid": 22, "factori": [22, 23], "root_map": [22, 23], "filler_class": [22, 23], "fill_or_fail": [22, 23], "rout": [22, 23], "callback": [22, 23], "layer": 22, "scheme": 22, "fulli": 22, "remov": [22, 23], "start_doc": 22, "subfactori": [22, 23], "runstart": [22, 23], "subsequ": 22, "runstop": [22, 23], "descriptor_doc": 22, "arriv": 22, "whatev": 22, "parametr": 22, "account": 22, "temporarili": 22, "remount": 22, "subclass": [22, 23], "functool": 22, "partial": 22, "documentrout": [22, 23], "encount": [22, 23], "unfil": [22, 23], "true": 22, "unknown": [22, 23], "streamdatum": 22, "singlerundocumentrout": [22, 23], "get_start": 22, "eventmodelerror": 22, "get_descriptor": 22, "get_stream_nam": 22, "getattr": 22, "origin": [22, 23], "altogeth": 22, "instanti": [22, 23], "exclud": [22, 23], "coerc": [22, 23], "as_i": [22, 23], "resource_cach": 22, "datum_cach": 22, "descriptor_cach": 22, "stream_resource_cach": 22, "stream_datum_cach": 22, "inplac": [22, 23], "retry_interv": 22, "001": 22, "002": 22, "004": 22, "008": 22, "016": 22, "032": 22, "064": 22, "128": 22, "256": 22, "024": 22, "recommend": [22, 24], "expens": 22, "memori": [22, 23], "drop": 22, "upon": 22, "unless": 22, "hold": 22, "garbag": 22, "longer": 22, "delet": 22, "finish": 22, "mutual": 22, "skip": 22, "delai": [22, 23], "regist": [22, 23], "runtim": [22, 23], "found": [22, 23], "race": 22, "ioerror": 22, "wait": 22, "bit": 22, "retri": [22, 23], "sleep": 22, "attempt": 22, "datanotaccess": 22, "catch": 22, "async": 22, "framework": 22, "increas": 22, "interv": 22, "stabl": 22, "author": 22, "tune": 22, "mutat": [22, 23], "export": 22, "del": 22, "overridden": [22, 23], "register_handl": [22, 23], "overwrit": 22, "duplicatehandl": 22, "deregister_handl": [22, 23], "deregist": [22, 23], "op": 22, "get_handl": 22, "explicitli": 22, "clear": [22, 23], "clear_handler_cach": [22, 23], "oper": 22, "signific": 22, "clear_document_cach": [22, 23], "nofil": [22, 23], "mere": [22, 23], "advanc": [22, 23], "register_coercion": [22, 23], "func": [22, 23], "invok": 22, "colliss": 22, "eventmodelvalueerror": 22, "filler_st": [22, 23], "coercion": [22, 23], "unchang": 22, "force_numpi": [22, 23], "compose_run": 22, "composerunbundl": 22, "event_count": 22, "convention": 22, "uuid4": 22, "element": 22, "compose_descriptor": [22, 23], "composedescriptor": 22, "compose_resourc": [22, 23], "composeresourc": 22, "compose_stop": 22, "composestop": 22, "compose_stream_resourc": 22, "composestreamresourc": 22, "bundl": 22, "maintain": 22, "unpack": 22, "basic": 22, "composedescriptorbundl": 22, "prefer": 22, "compose_ev": 22, "composeev": 22, "compose_event_pag": 22, "composeeventpag": 22, "composeresourcebundl": 22, "resource_doc": 22, "compose_datum": 22, "composedatum": 22, "compose_datum_pag": 22, "composedatumpag": 22, "poison_pil": 22, "pack_event_pag": 22, "unpack_event_pag": [22, 23], "yield": 22, "pack_datum_pag": 22, "unpack_datum_pag": [22, 23], "sanitize_doc": [22, 23], "sanit": 22, "prior": 22, "send": 22, "recogn": 22, "sanitized_doc": 22, "verify_fil": [22, 23], "verifi": 22, "unfilleddata": 22, "inlcud": 22, "messag": [22, 23], "numpyencod": [22, 23], "skipkei": 22, "ensure_ascii": 22, "check_circular": 22, "allow_nan": 22, "sort_kei": 22, "indent": 22, "jsonencod": 22, "dump": 22, "cl": 22, "constructor": 22, "sensibl": 22, "typeerror": 22, "non": [22, 23], "ascii": 22, "charact": 22, "escap": 22, "circular": 22, "infinit": 22, "recurs": 22, "caus": [22, 23], "recursionerror": 22, "otherwis": 22, "nan": 22, "infin": 22, "behavior": [22, 23], "consist": [22, 23], "javascript": 22, "decod": 22, "valueerror": [22, 23], "sort": 22, "regress": 22, "ensur": 22, "serial": 22, "compar": 22, "basi": 22, "neg": 22, "pretti": 22, "insert": 22, "newlin": 22, "compact": 22, "item_separ": 22, "key_separ": 22, "tupl": 22, "elimin": 22, "whitespac": 22, "warn": 23, "distutil": 23, "inadvert": 23, "broken": 23, "add": 23, "contigu": 23, "especi": 23, "year": 23, "quo": 23, "importlib": 23, "condit": 23, "v0": 23, "py311": 23, "toc": 23, "modifi": 23, "__array__": 23, "toler": 23, "variant": 23, "dask": 23, "spars": 23, "cupi": 23, "relax": 23, "enhanc": 23, "locaiton": 23, "addition": 23, "repeat": 23, "collid": 23, "chain": 23, "public": 23, "incorrect": 23, "replac": 23, "misspel": 23, "register_coers": 23, "retain": 23, "alia": 23, "sent": 23, "erron": 23, "smooth": 23, "transit": 23, "squash": 23, "propag": 23, "unintention": 23, "un": 23, "pickleabl": 23, "pickl": 23, "duplic": 23, "registr": 23, "coersion": 23, "original_func": 23, "critic": 23, "typo": 23, "codepath": 23, "decid": 23, "formerli": 23, "respons": 23, "insid": 23, "effort": 23, "though": 23, "malform": 23, "mileston": 23, "dispatch": 23, "introduc": 23, "sometim": 23, "notimpl": 23, "fall": 23, "correctli": 23, "sentinel": 23, "confus": 23, "notimplementederror": 23, "backoff": 23, "loop": 23, "appli": 23, "well": 23, "lag": 23, "slightli": 23, "behind": 23, "forc": 23, "interfac": [23, 24], "immedi": 23, "perhap": 23, "overrid": 23, "certain": 23, "filter": 23, "factor": 23, "_dispatch": 23, "specifii": 23, "previous": 23, "distribut": 23, "unresolveableforeignkeyerror": 23, "inconsist": 23, "fill_ev": 23, "fill_event_pag": 23, "rechunk_event_pag": 23, "infer": 23, "off": 23, "assum": 23, "robust": 23, "against": 23, "meta": 23, "python_requir": 23, "wheel": 23, "util": 23, "callbackbas": 23, "interfer": 24}, "objects": {"event_model": [[22, 0, 1, "", "ComposeDescriptorBundle"], [22, 0, 1, "", "ComposeResourceBundle"], [22, 0, 1, "", "ComposeRunBundle"], [22, 0, 1, "", "DocumentNames"], [22, 0, 1, "", "DocumentRouter"], [22, 0, 1, "", "Filler"], [22, 0, 1, "", "NoFiller"], [22, 0, 1, "", "NumpyEncoder"], [22, 0, 1, "", "RunRouter"], [22, 0, 1, "", "SingleRunDocumentRouter"], [22, 3, 1, "", "__version__"], [22, 4, 1, "", "as_is"], [22, 4, 1, "", "compose_datum"], [22, 4, 1, "", "compose_datum_page"], [22, 4, 1, "", "compose_descriptor"], [22, 4, 1, "", "compose_event"], [22, 4, 1, "", "compose_event_page"], [22, 4, 1, "", "compose_resource"], [22, 4, 1, "", "compose_run"], [22, 4, 1, "", "compose_stop"], [22, 4, 1, "", "force_numpy"], [22, 4, 1, "", "pack_datum_page"], [22, 4, 1, "", "pack_event_page"], [22, 4, 1, "", "register_coercion"], [22, 4, 1, "", "sanitize_doc"], [22, 4, 1, "", "unpack_datum_page"], [22, 4, 1, "", "unpack_event_page"], [22, 4, 1, "", "verify_filled"]], "event_model.DocumentNames": [[22, 1, 1, "", "bulk_datum"], [22, 1, 1, "", "bulk_events"], [22, 1, 1, "", "datum"], [22, 1, 1, "", "datum_page"], [22, 1, 1, "", "descriptor"], [22, 1, 1, "", "event"], [22, 1, 1, "", "event_page"], [22, 1, 1, "", "resource"], [22, 1, 1, "", "start"], [22, 1, 1, "", "stop"], [22, 1, 1, "", "stream_datum"], [22, 1, 1, "", "stream_resource"]], "event_model.DocumentRouter": [[22, 2, 1, "", "bulk_datum"], [22, 2, 1, "", "bulk_events"], [22, 2, 1, "", "datum"], [22, 2, 1, "", "datum_page"], [22, 2, 1, "", "descriptor"], [22, 2, 1, "", "emit"], [22, 2, 1, "", "event"], [22, 2, 1, "", "event_page"], [22, 2, 1, "", "resource"], [22, 2, 1, "", "start"], [22, 2, 1, "", "stop"], [22, 2, 1, "", "stream_datum"], [22, 2, 1, "", "stream_resource"]], "event_model.Filler": [[22, 2, 1, "", "clear_document_caches"], [22, 2, 1, "", "clear_handler_cache"], [22, 2, 1, "", "clone"], [22, 2, 1, "", "close"], [22, 2, 1, "", "deregister_handler"], [22, 2, 1, "", "get_handler"], [22, 2, 1, "", "register_handler"]], "event_model.RunRouter": [[22, 2, 1, "", "datum_page"], [22, 2, 1, "", "descriptor"], [22, 2, 1, "", "event_page"], [22, 2, 1, "", "resource"], [22, 2, 1, "", "start"], [22, 2, 1, "", "stop"], [22, 2, 1, "", "stream_datum"], [22, 2, 1, "", "stream_resource"]], "event_model.SingleRunDocumentRouter": [[22, 2, 1, "", "get_descriptor"], [22, 2, 1, "", "get_start"], [22, 2, 1, "", "get_stream_name"]]}, "objtypes": {"0": "py:class", "1": "py:attribute", "2": "py:method", "3": "py:data", "4": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "attribute", "Python attribute"], "2": ["py", "method", "Python method"], "3": ["py", "data", "Python data"], "4": ["py", "function", "Python function"]}, "titleterms": {"architectur": [0, 1], "decis": [0, 1, 2], "record": [0, 1], "1": [1, 23], "statu": [1, 2], "context": [1, 2], "consequ": [1, 2], "2": [2, 23], "switch": 2, "us": [2, 3, 5, 8, 9, 20], "python": [2, 24], "skeleton": 2, "build": [3, 13], "doc": 3, "sphinx": 3, "autobuild": 3, "contribut": 4, "project": [4, 16], "issu": [4, 5], "discuss": 4, "code": [4, 12], "coverag": 4, "develop": [4, 11, 13], "guid": [4, 11, 21], "run": [5, 8, 9, 16], "lint": 5, "pre": 5, "commit": 5, "fix": [5, 23], "make": 6, "releas": [6, 23], "pin": 7, "requir": 7, "introduct": 7, "find": 7, "lock": 7, "file": 7, "appli": 7, "remov": 7, "depend": [7, 13], "from": 7, "ci": 7, "test": [8, 13], "pytest": 8, "static": 9, "analysi": 9, "mypi": 9, "updat": 10, "tool": 10, "tutori": [11, 21], "how": [11, 15, 21], "explan": [11, 21], "refer": [11, 21], "standard": 12, "document": [12, 15, 16, 17, 19, 22], "instal": [13, 24], "clone": 13, "repositori": 13, "see": 13, "what": 13, "wa": 13, "api": [14, 22], "index": 14, "event": [15, 16, 18, 20], "model": [15, 16, 20], "blueski": 15, "where": 15, "i": 15, "my": 15, "data": [15, 16, 18], "structur": 15, "overview": 16, "exampl": 16, "type": 16, "detail": 16, "start": 16, "experiment": 16, "descriptor": [16, 18], "page": 16, "stop": 16, "resourc": [16, 19], "datum": 16, "stream": 16, "bulk": 16, "deprec": [16, 23], "about": 17, "The": [17, 19], "kei": 18, "object": 18, "configur": 18, "hint": 18, "complet": 18, "sampl": 18, "extern": 19, "asset": 19, "handler": 19, "interfac": 19, "discoveri": 19, "fill": 19, "manag": 19, "packag": 19, "pattern": 20, "case": 20, "tomographi": 20, "tile": 20, "mongodb": 20, "serial": 20, "other": 20, "user": 21, "schema": 22, "name": 22, "router": 22, "mint": 22, "mung": 22, "histori": 23, "v1": 23, "19": 23, "2023": 23, "02": 23, "24": 23, "chang": 23, "2022": 23, "12": 23, "09": 23, "0": 23, "11": 23, "03": 23, "ad": 23, "18": 23, "08": 23, "05": 23, "17": 23, "2021": 23, "06": 23, "21": 23, "01": 23, "29": 23, "2020": 23, "16": 23, "10": 23, "15": 23, "04": 23, "27": 23, "14": 23, "13": 23, "3": 23, "31": 23, "28": 23, "intern": 23, "2019": 23, "9": 23, "8": 23, "7": 23, "check": 24, "your": 24, "version": 24, "creat": 24, "virtual": 24, "environ": 24, "librari": 24}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Architectural Decision Records": [[0, "architectural-decision-records"]], "1. Record architecture decisions": [[1, "record-architecture-decisions"]], "Status": [[1, "status"], [2, "status"]], "Context": [[1, "context"], [2, "context"]], "Decision": [[1, "decision"], [2, "decision"]], "Consequences": [[1, "consequences"], [2, "consequences"]], "2. Switched to using a python skeleton": [[2, "switched-to-using-a-python-skeleton"]], "Build the docs using sphinx": [[3, "build-the-docs-using-sphinx"]], "Autobuild": [[3, "autobuild"]], "Contributing to the project": [[4, "contributing-to-the-project"]], "Issue or Discussion?": [[4, "issue-or-discussion"]], "Code coverage": [[4, "code-coverage"]], "Developer guide": [[4, "developer-guide"]], "Run linting using pre-commit": [[5, "run-linting-using-pre-commit"]], "Running pre-commit": [[5, "running-pre-commit"]], "Fixing issues": [[5, "fixing-issues"]], "Make a release": [[6, "make-a-release"]], "Pinning Requirements": [[7, "pinning-requirements"]], "Introduction": [[7, "introduction"]], "Finding the lock files": [[7, "finding-the-lock-files"]], "Applying the lock file": [[7, "applying-the-lock-file"]], "Removing dependency locking from CI": [[7, "removing-dependency-locking-from-ci"]], "Run the tests using pytest": [[8, "run-the-tests-using-pytest"]], "Run static analysis using mypy": [[9, "run-static-analysis-using-mypy"]], "Update the tools": [[10, "update-the-tools"]], "Developer Guide": [[11, "developer-guide"]], "Tutorials": [[11, null], [21, null]], "How-to Guides": [[11, null], [21, null]], "Explanations": [[11, null], [21, null]], "Reference": [[11, null], [21, null]], "Standards": [[12, "standards"]], "Code Standards": [[12, "code-standards"]], "Documentation Standards": [[12, "documentation-standards"]], "Developer install": [[13, "developer-install"]], "Clone the repository": [[13, "clone-the-repository"]], "Install dependencies": [[13, "install-dependencies"]], "See what was installed": [[13, "see-what-was-installed"]], "Build and test": [[13, "build-and-test"]], "API Index": [[14, "api-index"]], "Event Model": [[15, "event-model"]], "Bluesky Event Model Documentation": [[15, "bluesky-event-model-documentation"]], "Where is my data?": [[15, "where-is-my-data"]], "How the documentation is structured": [[15, "how-the-documentation-is-structured"]], "Data Model": [[16, "data-model"]], "Overview": [[16, "overview"]], "Example Runs": [[16, "example-runs"]], "Document Types in Detail": [[16, "document-types-in-detail"]], "Run Start Document": [[16, "run-start-document"]], "Projections (Experimental)": [[16, "projections-experimental"]], "Event Descriptor": [[16, "event-descriptor"]], "Event Document": [[16, "event-document"]], "Event Page": [[16, "event-page"]], "Run Stop Document": [[16, "run-stop-document"]], "Resource Document": [[16, "resource-document"]], "Datum Document": [[16, "datum-document"]], "Datum Page": [[16, "datum-page"]], "Stream Resource Document (Experimental)": [[16, "stream-resource-document-experimental"]], "Stream Datum Document": [[16, "stream-datum-document"]], "\u201cBulk Events\u201d Document (DEPRECATED)": [[16, "bulk-events-document-deprecated"]], "\u201cBulk Datum\u201d Document (DEPRECATED)": [[16, "bulk-datum-document-deprecated"]], "About The Documentation": [[17, "about-the-documentation"]], "Event Descriptors": [[18, "event-descriptors"]], "Data Keys": [[18, "data-keys"]], "Object Keys": [[18, "object-keys"]], "Configuration": [[18, "configuration"]], "Hints": [[18, "hints"]], "Complete Sample": [[18, "complete-sample"]], "External Assets": [[19, "external-assets"]], "The Documents": [[19, "the-documents"]], "Handlers": [[19, "handlers"]], "Handler Interface": [[19, "handler-interface"]], "Handler Discovery": [[19, "handler-discovery"]], "Filling": [[19, "filling"]], "Resource Management": [[19, "resource-management"]], "Handler Packaging": [[19, "handler-packaging"]], "Event Model Patterns": [[20, "event-model-patterns"]], "Use Case - Tomography Tiling and MongoDB Serialization": [[20, "use-case-tomography-tiling-and-mongodb-serialization"]], "Other Use Cases": [[20, "other-use-cases"]], "User Guide": [[21, "user-guide"]], "API Documentation": [[22, "api-documentation"]], "Schemas and Names": [[22, "schemas-and-names"]], "Routers": [[22, "routers"]], "Document Minting": [[22, "document-minting"]], "Document Munging": [[22, "document-munging"]], "Release History": [[23, "release-history"]], "v1.19.2 (2023-02-24)": [[23, "v1-19-2-2023-02-24"]], "Changed": [[23, "changed"], [23, "id1"], [23, "id3"], [23, "id5"], [23, "id8"], [23, "id11"], [23, "id14"], [23, "id17"], [23, "id20"], [23, "id22"], [23, "id24"], [23, "id26"], [23, "id28"]], "v1.19.1 (2022-12-09)": [[23, "v1-19-1-2022-12-09"]], "v1.19.0 (2022-11-03)": [[23, "v1-19-0-2022-11-03"]], "Added": [[23, "added"], [23, "id2"], [23, "id4"], [23, "id6"], [23, "id7"], [23, "id9"], [23, "id10"], [23, "id13"], [23, "id15"], [23, "id25"], [23, "id27"], [23, "id32"], [23, "id34"], [23, "id35"], [23, "id38"], [23, "id39"]], "v1.18.0 (2022-08-05)": [[23, "v1-18-0-2022-08-05"]], "v1.17.2 (2021-06-21)": [[23, "v1-17-2-2021-06-21"]], "v1.17.1 (2021-01-29)": [[23, "v1-17-1-2021-01-29"]], "v1.17.0 (2020-12-17)": [[23, "v1-17-0-2020-12-17"]], "v1.16.1 (2020-10-15)": [[23, "v1-16-1-2020-10-15"]], "v1.16.0 (2020-09-03)": [[23, "v1-16-0-2020-09-03"], [23, "id12"]], "v1.15.2 (2020-06-12)": [[23, "v1-15-2-2020-06-12"]], "v1.15.1 (2020-05-01)": [[23, "v1-15-1-2020-05-01"]], "Fixed": [[23, "fixed"], [23, "id16"], [23, "id18"], [23, "id19"], [23, "id21"], [23, "id23"], [23, "id29"], [23, "id30"], [23, "id31"], [23, "id33"]], "v1.15.0 (2020-04-27)": [[23, "v1-15-0-2020-04-27"]], "v1.14.1 (2020-04-06)": [[23, "v1-14-1-2020-04-06"]], "v1.14.0 (2020-03-11)": [[23, "v1-14-0-2020-03-11"]], "v1.13.3 (2020-03-05)": [[23, "v1-13-3-2020-03-05"]], "v1.13.2 (2020-01-31)": [[23, "v1-13-2-2020-01-31"]], "v1.13.1 (2020-01-28)": [[23, "v1-13-1-2020-01-28"]], "v1.13.0 (2020-01-21)": [[23, "v1-13-0-2020-01-21"]], "Deprecated": [[23, "deprecated"]], "Internal Changes": [[23, "internal-changes"]], "v1.12.0 (2019-10-11)": [[23, "v1-12-0-2019-10-11"]], "v1.11.2 (2019-09-03)": [[23, "v1-11-2-2019-09-03"]], "v1.11.1 (2019-08-09)": [[23, "v1-11-1-2019-08-09"]], "v1.11.0 (2019-06-27)": [[23, "v1-11-0-2019-06-27"]], "v1.10.0 (2019-05-24)": [[23, "v1-10-0-2019-05-24"]], "Fixes": [[23, "fixes"], [23, "id36"], [23, "id37"]], "v1.9.0 (2019-05-01)": [[23, "v1-9-0-2019-05-01"]], "v1.8.3 (2019-03-28)": [[23, "v1-8-3-2019-03-28"]], "v1.8.2 (2019-03-08)": [[23, "v1-8-2-2019-03-08"]], "v1.8.0 (2019-03-05)": [[23, "v1-8-0-2019-03-05"]], "v1.7.0 (2019-01-03)": [[23, "v1-7-0-2019-01-03"]], "Installation": [[24, "installation"]], "Check your version of python": [[24, "check-your-version-of-python"]], "Create a virtual environment": [[24, "create-a-virtual-environment"]], "Installing the library": [[24, "installing-the-library"]]}, "indexentries": {"composedescriptorbundle (class in event_model)": [[22, "event_model.ComposeDescriptorBundle"]], "composeresourcebundle (class in event_model)": [[22, "event_model.ComposeResourceBundle"]], "composerunbundle (class in event_model)": [[22, "event_model.ComposeRunBundle"]], "documentnames (class in event_model)": [[22, "event_model.DocumentNames"]], "documentrouter (class in event_model)": [[22, "event_model.DocumentRouter"]], "filler (class in event_model)": [[22, "event_model.Filler"]], "nofiller (class in event_model)": [[22, "event_model.NoFiller"]], "numpyencoder (class in event_model)": [[22, "event_model.NumpyEncoder"]], "runrouter (class in event_model)": [[22, "event_model.RunRouter"]], "singlerundocumentrouter (class in event_model)": [[22, "event_model.SingleRunDocumentRouter"]], "as_is() (in module event_model)": [[22, "event_model.as_is"]], "bulk_datum (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.bulk_datum"]], "bulk_datum() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.bulk_datum"]], "bulk_events (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.bulk_events"]], "bulk_events() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.bulk_events"]], "clear_document_caches() (event_model.filler method)": [[22, "event_model.Filler.clear_document_caches"]], "clear_handler_cache() (event_model.filler method)": [[22, "event_model.Filler.clear_handler_cache"]], "clone() (event_model.filler method)": [[22, "event_model.Filler.clone"]], "close() (event_model.filler method)": [[22, "event_model.Filler.close"]], "compose_datum() (in module event_model)": [[22, "event_model.compose_datum"]], "compose_datum_page() (in module event_model)": [[22, "event_model.compose_datum_page"]], "compose_descriptor() (in module event_model)": [[22, "event_model.compose_descriptor"]], "compose_event() (in module event_model)": [[22, "event_model.compose_event"]], "compose_event_page() (in module event_model)": [[22, "event_model.compose_event_page"]], "compose_resource() (in module event_model)": [[22, "event_model.compose_resource"]], "compose_run() (in module event_model)": [[22, "event_model.compose_run"]], "compose_stop() (in module event_model)": [[22, "event_model.compose_stop"]], "datum (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.datum"]], "datum() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.datum"]], "datum_page (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.datum_page"]], "datum_page() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.datum_page"]], "datum_page() (event_model.runrouter method)": [[22, "event_model.RunRouter.datum_page"]], "deregister_handler() (event_model.filler method)": [[22, "event_model.Filler.deregister_handler"]], "descriptor (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.descriptor"]], "descriptor() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.descriptor"]], "descriptor() (event_model.runrouter method)": [[22, "event_model.RunRouter.descriptor"]], "emit() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.emit"]], "event (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.event"]], "event() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.event"]], "event_model.__version__ (built-in variable)": [[22, "event_model.__version__"]], "event_page (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.event_page"]], "event_page() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.event_page"]], "event_page() (event_model.runrouter method)": [[22, "event_model.RunRouter.event_page"]], "force_numpy() (in module event_model)": [[22, "event_model.force_numpy"]], "get_descriptor() (event_model.singlerundocumentrouter method)": [[22, "event_model.SingleRunDocumentRouter.get_descriptor"]], "get_handler() (event_model.filler method)": [[22, "event_model.Filler.get_handler"]], "get_start() (event_model.singlerundocumentrouter method)": [[22, "event_model.SingleRunDocumentRouter.get_start"]], "get_stream_name() (event_model.singlerundocumentrouter method)": [[22, "event_model.SingleRunDocumentRouter.get_stream_name"]], "pack_datum_page() (in module event_model)": [[22, "event_model.pack_datum_page"]], "pack_event_page() (in module event_model)": [[22, "event_model.pack_event_page"]], "register_coercion() (in module event_model)": [[22, "event_model.register_coercion"]], "register_handler() (event_model.filler method)": [[22, "event_model.Filler.register_handler"]], "resource (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.resource"]], "resource() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.resource"]], "resource() (event_model.runrouter method)": [[22, "event_model.RunRouter.resource"]], "sanitize_doc() (in module event_model)": [[22, "event_model.sanitize_doc"]], "start (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.start"]], "start() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.start"]], "start() (event_model.runrouter method)": [[22, "event_model.RunRouter.start"]], "stop (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.stop"]], "stop() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.stop"]], "stop() (event_model.runrouter method)": [[22, "event_model.RunRouter.stop"]], "stream_datum (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.stream_datum"]], "stream_datum() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.stream_datum"]], "stream_datum() (event_model.runrouter method)": [[22, "event_model.RunRouter.stream_datum"]], "stream_resource (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.stream_resource"]], "stream_resource() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.stream_resource"]], "stream_resource() (event_model.runrouter method)": [[22, "event_model.RunRouter.stream_resource"]], "unpack_datum_page() (in module event_model)": [[22, "event_model.unpack_datum_page"]], "unpack_event_page() (in module event_model)": [[22, "event_model.unpack_event_page"]], "verify_filled() (in module event_model)": [[22, "event_model.verify_filled"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["developer/explanations/decisions", "developer/explanations/decisions/0001-record-architecture-decisions", "developer/explanations/decisions/0002-switched-to-using-a-python-skeleton", "developer/how-to/build-docs", "developer/how-to/contribute", "developer/how-to/lint", "developer/how-to/make-release", "developer/how-to/pin-requirements", "developer/how-to/run-tests", "developer/how-to/static-analysis", "developer/how-to/update-tools", "developer/index", "developer/reference/standards", "developer/tutorials/dev-install", "genindex", "index", "user/explanations/data-model", "user/explanations/docs-structure", "user/explanations/event-descriptors", "user/explanations/external", "user/how-to/use-cases", "user/index", "user/reference/api", "user/reference/release-history", "user/tutorials/installation"], "filenames": ["developer/explanations/decisions.rst", "developer/explanations/decisions/0001-record-architecture-decisions.rst", "developer/explanations/decisions/0002-switched-to-using-a-python-skeleton.rst", "developer/how-to/build-docs.rst", "developer/how-to/contribute.rst", "developer/how-to/lint.rst", "developer/how-to/make-release.rst", "developer/how-to/pin-requirements.rst", "developer/how-to/run-tests.rst", "developer/how-to/static-analysis.rst", "developer/how-to/update-tools.rst", "developer/index.rst", "developer/reference/standards.rst", "developer/tutorials/dev-install.rst", "genindex.rst", "index.rst", "user/explanations/data-model.rst", "user/explanations/docs-structure.rst", "user/explanations/event-descriptors.rst", "user/explanations/external.rst", "user/how-to/use-cases.rst", "user/index.rst", "user/reference/api.rst", "user/reference/release-history.rst", "user/tutorials/installation.rst"], "titles": ["Architectural Decision Records", "1. Record architecture decisions", "2. Switched to using a python skeleton", "Build the docs using sphinx", "Contributing to the project", "Run linting using pre-commit", "Make a release", "Pinning Requirements", "Run the tests using pytest", "Run static analysis using mypy", "Update the tools", "Developer Guide", "Standards", "Developer install", "API Index", "Event Model", "Data Model", "About The Documentation", "Event Descriptors", "External Assets", "Event Model Patterns", "User Guide", "API Documentation", "Release History", "Installation"], "terms": {"we": [0, 1, 2, 4, 7, 12, 15, 16, 18, 19, 20, 22, 23], "major": 0, "adr": [0, 1], "describ": [0, 1, 12, 16, 18, 19, 22], "michael": [0, 1], "nygard": [0, 1], "below": [0, 19, 22], "i": [0, 4, 5, 7, 8, 9, 10, 11, 12, 16, 17, 18, 19, 20, 21, 22, 23, 24], "list": [0, 7, 12, 16, 18, 22, 23], "our": [0, 16, 18, 19], "current": [0, 10, 19, 22, 23, 24], "1": [0, 12, 16, 18, 20, 22], "2": [0, 12, 15, 16, 18, 20, 22], "switch": 0, "us": [0, 1, 7, 11, 12, 13, 15, 16, 19, 22, 23, 24], "python": [0, 6, 7, 10, 12, 13, 15, 16, 19, 22, 23], "skeleton": [0, 7, 10], "date": [1, 2], "2023": [1, 2], "02": 1, "18": 1, "accept": [1, 2, 16, 19, 23], "need": [1, 7, 12, 17, 18, 19, 22, 23, 24], "made": [1, 7, 20, 23], "thi": [1, 3, 5, 6, 7, 10, 12, 13, 15, 16, 17, 18, 19, 22, 23, 24], "project": [1, 3, 7, 8, 10, 11, 23], "see": [1, 3, 6, 12, 15, 16, 18, 19, 22, 23], "": [1, 15, 16, 18, 19, 22, 23], "articl": 1, "link": [1, 11, 16, 21, 23], "abov": [1, 5, 12, 16, 18], "To": [1, 6, 7, 10, 13, 19, 20, 22, 23], "creat": [1, 6, 7, 16, 19, 20, 22, 23], "new": [1, 2, 4, 6, 21, 22, 23], "copi": [1, 7, 22], "past": 1, "from": [1, 3, 5, 11, 12, 15, 16, 18, 19, 20, 21, 22, 23, 24], "exist": [1, 4, 19, 23, 24], "ones": [1, 16], "03": [2, 16, 19], "23": 2, "should": [2, 4, 7, 12, 13, 15, 16, 19, 22, 24], "follow": [2, 4, 6, 12, 13, 16, 19, 22], "develop": [2, 15], "featur": [2, 16, 18, 22, 23, 24], "singl": [2, 16, 20], "pyproject": [2, 7], "toml": [2, 7], "instead": [2, 4, 16, 23], "requir": [2, 11, 13, 16, 17, 20, 22, 23, 24], "txt": [2, 7, 23], "dev": [2, 11, 13], "black": [2, 5, 12], "isort": [2, 5, 12], "have": [2, 4, 5, 7, 12, 13, 16, 18, 19, 20, 22, 23], "git": [2, 5, 10, 13, 24], "version": [2, 7, 10, 16, 22, 23], "gener": [2, 6, 10, 16, 18, 19, 22], "setup": [2, 10, 13, 19, 23], "py": [2, 19, 23], "mypi": [2, 11, 12, 13], "pre": [2, 11, 12, 13, 23], "commit": [2, 7, 11, 12, 13], "dl": 2, "pip": [2, 7, 10, 13, 15, 24], "ci": 2, "workflow": [2, 23], "chang": [2, 3, 4, 5, 7, 10, 15, 16, 18, 19, 20, 22], "even": [2, 12], "job": 2, "provid": [2, 7, 10, 12, 16, 18, 19, 20, 22, 23], "same": [2, 4, 6, 7, 18, 19, 20, 22, 23], "older": 2, "check": [2, 4, 5, 8, 9, 10, 12, 13, 19, 22, 23], "you": [3, 4, 5, 6, 7, 8, 9, 12, 13, 15, 19, 20, 22, 24], "can": [3, 4, 5, 7, 8, 9, 12, 13, 16, 18, 19, 20, 22, 23, 24], "base": [3, 16, 20, 22, 23], "directori": [3, 12], "run": [3, 4, 10, 11, 12, 13, 18, 19, 20, 22, 23], "tox": [3, 5, 8, 9, 13], "e": [3, 5, 7, 8, 9, 12, 13, 16, 19, 22, 23], "static": [3, 11, 12, 13, 16], "which": [3, 10, 12, 13, 16, 18, 19, 22, 23], "includ": [3, 12, 16, 19, 21, 22, 23], "api": [3, 12, 21, 23], "pull": [3, 4, 10, 16], "docstr": [3, 12], "code": [3, 5, 13, 15, 16, 22, 23], "document": [3, 4, 11, 18, 20, 21, 23], "standard": [3, 4, 11, 16], "The": [3, 4, 7, 12, 15, 16, 18, 20, 21, 22, 23, 24], "built": [3, 22, 23], "html": [3, 22], "open": [3, 4, 19], "local": [3, 13, 16], "web": 3, "browser": 3, "firefox": 3, "index": [3, 16, 19, 21], "also": [3, 4, 5, 8, 11, 12, 16, 18, 19, 21, 22, 24], "an": [3, 5, 7, 10, 12, 16, 18, 19, 20, 22, 23], "process": [3, 12, 16, 18, 20, 22], "watch": 3, "your": [3, 4, 5, 7, 15], "rebuild": 3, "whenev": 3, "reload": 3, "ani": [3, 4, 5, 7, 10, 16, 19, 22, 23, 24], "page": [3, 6, 7, 12, 22, 23], "view": [3, 19, 23], "localhost": 3, "http": [3, 6, 10, 15, 22, 24], "8000": 3, "If": [3, 4, 5, 19, 22, 23, 24], "ar": [3, 4, 7, 12, 15, 16, 17, 18, 19, 20, 22, 23], "make": [3, 4, 11, 16, 19, 20, 22, 23], "sourc": [3, 9, 13, 15, 16, 18, 19, 22, 23, 24], "too": 3, "tell": [3, 5, 19], "event_model": [3, 19, 22, 24], "most": [4, 16, 17, 22], "welcom": 4, "all": [4, 5, 7, 12, 16, 18, 19, 20, 22, 23], "request": [4, 10], "handl": [4, 5, 16, 19], "through": [4, 13, 20, 22, 23], "github": [4, 6, 10, 13, 23, 24], "pleas": [4, 6, 12, 15, 20], "befor": [4, 15, 16, 19, 22, 23], "file": [4, 5, 9, 16, 19, 22], "one": [4, 7, 12, 16, 17, 18, 19, 20, 22, 23], "great": 4, "idea": [4, 7], "involv": [4, 18, 23], "big": 4, "ticket": 4, "want": [4, 16, 22, 23], "sure": [4, 22], "don": [4, 18], "t": [4, 12, 17, 18, 19, 22], "spend": 4, "time": [4, 5, 7, 16, 18, 19, 20, 22], "someth": [4, 10, 19], "might": [4, 16, 18, 19, 20], "fit": 4, "scope": [4, 16], "offer": 4, "place": [4, 7, 16, 19, 22, 23], "ask": [4, 19], "question": [4, 19, 23], "share": [4, 19, 22], "end": [4, 16], "obviou": 4, "when": [4, 7, 12, 16, 19, 20, 22, 23], "close": [4, 10, 12, 19, 22], "rais": [4, 12, 19, 22, 23], "while": 4, "100": 4, "doe": [4, 22, 23], "librari": [4, 7, 21], "bug": [4, 23], "free": [4, 22], "significantli": [4, 16], "reduc": 4, "number": [4, 6, 7, 16, 18, 19, 20, 22, 23], "easili": 4, "caught": 4, "remain": [4, 22], "improv": [4, 17], "contain": [4, 7, 12, 15, 16, 19, 20, 22, 23], "inform": [4, 15, 16, 17, 18, 19, 20, 22, 23], "set": [4, 7, 12, 16, 22, 23], "up": [4, 11, 19, 22, 23], "environ": [4, 7, 13, 19], "test": [4, 7, 11, 22, 23], "what": [4, 15, 16, 19, 20], "flake8": [5, 12], "under": [5, 12], "command": 5, "Or": [5, 22], "instal": [5, 7, 11, 15, 19, 21, 23], "hook": [5, 19], "each": [5, 7, 16, 18, 19, 20, 22, 23], "do": [5, 7, 9, 15, 16, 18, 19, 20, 22, 23], "just": [5, 20], "It": [5, 7, 8, 9, 16, 19, 22, 23, 24], "possibl": [5, 7], "automat": 5, "enabl": [5, 15, 16, 23], "clone": [5, 22, 23], "repositori": [5, 7, 12, 15], "result": [5, 19], "being": [5, 16, 20, 23], "everi": [5, 7, 16, 18, 23], "repo": [5, 7], "user": [5, 15, 16, 20, 22], "now": [5, 13, 19, 23, 24], "report": [5, 8], "reformat": 5, "likewis": [5, 23], "get": [5, 6, 7, 11, 13, 16, 22, 23], "those": [5, 12, 16, 20, 22], "manual": [5, 22], "checklist": 6, "choos": 6, "pep440": 6, "compliant": [6, 22], "pep": 6, "org": 6, "0440": 6, "go": [6, 7], "draft": 6, "click": [6, 7], "tag": 6, "suppli": 6, "chose": 6, "note": [6, 12, 16, 20, 21], "review": 6, "edit": 6, "titl": [6, 12, 16], "publish": [6, 7, 23], "push": [6, 7], "main": 6, "branch": 6, "ha": [6, 7, 10, 16, 18, 19, 22, 23, 24], "effect": 6, "except": [6, 22, 23], "option": [6, 12, 16, 18, 19, 20, 22, 23], "By": [7, 22], "design": [7, 15, 16, 19, 20], "onli": [7, 16, 19, 22, 23], "defin": [7, 12, 16, 20], "tabl": [7, 16], "In": [7, 18, 19, 20, 22, 23], "some": [7, 12, 15, 16, 19, 22, 23], "For": [7, 12, 15, 16, 18, 20, 23], "best": [7, 20, 23], "leav": 7, "minimum": 7, "so": [7, 13, 16, 22, 23, 24], "widest": 7, "rang": [7, 16], "applic": [7, 19, 22], "build": [7, 11, 12], "latest": [7, 10], "compat": [7, 16, 22, 23], "avail": [7, 23], "after": [7, 12, 16, 19, 22], "approach": [7, 17], "mean": [7, 10, 12, 16, 18, 23], "futur": [7, 16, 22, 23], "mai": [7, 12, 16, 19, 22, 23], "break": 7, "becaus": [7, 12, 18, 19, 22, 23], "updat": [7, 11], "releas": [7, 11, 15, 16, 19, 21, 22, 24], "correct": [7, 23], "wai": [7, 16, 19, 21, 22, 23], "fix": [7, 16], "issu": [7, 9], "work": [7, 21, 23], "out": [7, 12, 19, 20, 23], "resolv": [7, 22], "problem": 7, "howev": 7, "quit": [7, 16, 20], "hard": 7, "consum": [7, 16, 19, 20, 22], "simpli": [7, 22], "try": [7, 22, 23], "minor": 7, "reason": [7, 16, 19, 22], "mechan": [7, 19, 22], "previou": [7, 19, 23], "success": [7, 16, 22], "quick": [7, 15], "guarante": [7, 22], "asset": [7, 16, 21], "exampl": [7, 12, 18, 19, 20, 22, 23], "take": [7, 13, 16, 19, 20, 22, 23], "look": [7, 8, 15, 16, 18, 19], "python3": [7, 10, 13, 24], "cli": 7, "here": [7, 12, 16, 18, 19, 20, 21, 22], "diamondlightsourc": 7, "There": [7, 12, 17, 22], "show": [7, 16, 20], "virtual": 7, "multipl": [7, 10, 12, 16, 18, 19, 20, 22, 23], "differ": [7, 15, 16, 17, 18, 20, 22, 23], "freez": 7, "full": [7, 15], "sub": 7, "download": 7, "them": [7, 8, 9, 16, 19, 20, 22, 23], "ran": 7, "lowest": 7, "more": [7, 10, 12, 16, 17, 18, 19, 20, 21, 22, 23], "like": [7, 8, 12, 16, 18, 19, 22, 23], "matrix": 7, "ubuntu": 7, "3": [7, 12, 13, 16, 18, 20, 22, 24], "8": [7, 13, 24], "lockfil": 7, "root": [7, 16, 19, 22], "renam": 7, "pass": [7, 12, 16, 22, 23], "exactli": [7, 22], "packag": [7, 13, 22, 23], "onc": [7, 22], "been": [7, 16, 19, 22, 23, 24], "good": [7, 17], "back": [7, 12, 15, 16, 18, 19, 20, 23], "unlock": 7, "earli": 7, "indic": [7, 10, 16, 19], "incom": [7, 22], "restor": 7, "done": [8, 9, 12, 22, 23], "find": [8, 19], "function": [8, 12, 16, 17, 22, 23], "error": [8, 16, 19, 23], "coverag": 8, "commandlin": [8, 24], "cov": 8, "xml": 8, "type": [9, 12, 13, 15, 18, 19, 20, 22, 23, 24], "definit": [9, 16, 20], "without": [9, 16], "highlight": 9, "potenti": [9, 20, 22, 23], "where": [9, 10, 16, 18, 19], "match": [9, 19], "modul": [10, 12, 19, 22], "merg": 10, "structur": [10, 16, 20], "keep": [10, 19, 22], "techniqu": [10, 12, 20], "sync": 10, "between": [10, 18, 19, 20, 22], "rebas": 10, "fals": [10, 16, 19, 22, 23], "com": [10, 13, 24], "blueski": [10, 13, 16, 19, 23, 24], "conflict": 10, "area": [10, 19], "detail": [10, 12, 15, 18, 19, 22, 23], "split": [11, 15, 21], "four": [11, 17, 21], "categori": [11, 18, 21], "access": [11, 16, 19, 21], "side": [11, 19, 21], "bar": [11, 21], "contribut": [11, 15, 20], "doc": [11, 12, 13, 22], "sphinx": [11, 12, 13], "pytest": [11, 13], "analysi": [11, 12, 13, 15, 16, 20, 22], "lint": [11, 12, 13], "tool": [11, 12, 15, 16, 20, 22], "pin": 11, "practic": [11, 21], "step": [11, 13, 16, 20, 21], "dai": [11, 22], "task": 11, "architectur": 11, "decis": [11, 20], "record": [11, 15, 16, 18, 23], "why": [11, 16, 19, 21], "technic": [11, 17, 21], "materi": [11, 21], "conform": [12, 22], "format": [12, 16, 19], "style": 12, "import": [12, 19, 22], "order": [12, 16, 17, 20], "how": [12, 16, 17, 19, 20, 22, 23], "guid": [12, 15, 17], "napoleon": 12, "extens": [12, 22], "As": [12, 16, 19, 22], "numpydoc": 12, "consid": [12, 16, 18, 20, 22], "hint": [12, 16, 19, 22], "signatur": [12, 19, 22], "def": [12, 19], "foo": 12, "var1": 12, "var2": 12, "arg": [12, 16, 22], "long_var_nam": 12, "hi": 12, "only_seldom_used_keyword": 12, "0": [12, 16, 18, 19, 20, 22], "kwarg": [12, 16, 22], "r": 12, "summar": 12, "line": [12, 16], "sever": [12, 19, 22, 23], "sentenc": 12, "extend": 12, "descript": [12, 16, 18], "refer": [12, 15, 16, 17, 18, 19, 22, 23], "variabl": [12, 18], "tick": 12, "g": [12, 16, 19, 22], "var": 12, "paramet": [12, 16, 18, 19, 22, 23], "array_lik": 12, "object": [12, 16, 19, 22, 23], "nest": [12, 16, 22], "etc": [12, 16, 20], "convert": [12, 22, 23], "arrai": [12, 16, 18, 19, 22, 23], "int": [12, 22], "either": [12, 20, 23], "actual": [12, 16, 22, 23], "n": [12, 16], "ndarrai": [12, 22], "iter": [12, 22], "other": [12, 16, 19, 22], "argument": [12, 16, 19, 22, 23], "ho": 12, "choic": [12, 20], "bracket": 12, "default": [12, 19, 22, 23], "first": [12, 13, 16, 18, 22], "return": [12, 18, 19, 22, 23], "explan": [12, 17], "anonym": 12, "valu": [12, 16, 18, 19, 22], "name": [12, 16, 18, 19, 20, 23], "type_without_descript": 12, "infrequ": 12, "section": [12, 15, 16, 18, 19], "prevent": [12, 22, 23], "clutter": 12, "dict": [12, 18, 19, 22], "keyword": [12, 22], "appear": [12, 19], "specifi": [12, 16, 18, 22], "badexcept": 12, "shouldn": 12, "numpi": [12, 22, 23], "relationship": [12, 20], "could": [12, 16, 20, 22], "fairli": 12, "long": [12, 16, 22, 23], "case": [12, 16, 19, 23], "wrap": 12, "dot": 12, "linalg": 12, "norm": 12, "ey": 12, "about": [12, 15, 16, 18, 19, 21, 23], "implement": [12, 16, 19, 20, 22, 23], "algorithm": 12, "paragraph": 12, "math": 12, "x": [12, 16, 18, 23], "j": 12, "omega": 12, "And": [12, 16], "greek": 12, "symbol": 12, "inlin": 12, "cite": 12, "relev": [12, 19, 23], "literatur": 12, "_": 12, "o": [12, 22, 23], "mcnoleg": 12, "integr": [12, 19], "gi": 12, "remot": 12, "sens": [12, 16], "expert": 12, "system": [12, 15, 16, 19, 20, 22], "adapt": [12, 23], "co": 12, "krige": 12, "environment": 12, "habitat": 12, "model": [12, 13, 18, 19, 21, 22, 23, 24], "highland": 12, "haggi": 12, "orient": 12, "fuzzi": 12, "logic": [12, 23], "neural": 12, "network": [12, 16, 19], "comput": [12, 16, 22, 23], "geoscienc": 12, "vol": 12, "22": 12, "pp": 12, "585": 12, "588": 12, "1996": 12, "These": [12, 13, 22, 23], "written": [12, 16], "doctest": 12, "illustr": 12, "print": [12, 22, 23], "4": [12, 20], "5": [12, 18, 19], "6": [12, 23], "nb": 12, "b": [12, 22], "blank": 12, "method": [12, 18, 19, 22, 23], "extract": 12, "underlin": 12, "convent": 12, "headl": 12, "head": [12, 16], "instruct": [13, 16], "minim": [13, 16], "event": [13, 19, 21, 22, 23, 24], "venv": [13, 24], "later": [13, 15, 16, 19, 22, 23, 24], "cd": 13, "m": [13, 24], "bin": [13, 24], "activ": [13, 24], "graph": 13, "tree": 13, "pipdeptre": 13, "termin": [13, 24], "p": 13, "parallel": 13, "pypi": [15, 23], "blueskyproject": [15, 22], "io": [15, 22], "A": [15, 16, 18, 19, 20, 22, 23], "primari": [15, 16, 19, 20], "goal": [15, 16], "better": [15, 16, 23], "research": [15, 16], "rich": [15, 16], "metadata": [15, 16, 18, 22, 23], "alongsid": [15, 16], "measur": [15, 16], "formal": [15, 16], "schema": [15, 16, 23], "stream": [15, 19, 20, 22, 23], "compos": [15, 16, 22, 23], "valid": [15, 16, 22, 23], "transform": [15, 16, 22], "veri": [15, 16, 19, 20], "put": [15, 19, 20], "kind": 15, "sampl": [15, 16, 20], "know": [15, 16, 19, 23], "start": [15, 18, 21, 22, 23], "experi": [15, 16, 18], "intend": [15, 16, 22, 23], "who": [15, 16], "extern": [15, 16, 18, 21, 22, 23], "databas": [15, 20, 22], "detector": [15, 16, 18, 19], "calibr": 15, "dark": 15, "frame": 15, "flat": 15, "field": [15, 16, 18, 19, 20, 22, 23], "mask": 15, "probabl": 15, "its": [15, 18, 19, 20, 22, 23, 24], "own": [15, 20], "shape": [15, 16, 18, 19, 23], "unit": [15, 16, 18, 19], "descriptor": [15, 19, 20, 22, 23], "data_kei": [15, 16, 18, 19, 22], "entri": [15, 16], "anyth": 15, "read": [15, 16, 18, 19, 20, 23], "control": 15, "devic": [15, 16, 18], "configur": [15, 16, 19, 22, 23], "term": [16, 18], "dictionari": [16, 22], "runengin": [16, 18, 22, 23], "emit": [16, 22, 23], "dure": [16, 18, 19, 22], "plan": 16, "execut": [16, 23], "organ": 16, "support": [16, 23], "complex": [16, 18], "asynchron": 16, "collect": [16, 22], "sophist": 16, "live": [16, 22], "prompt": 16, "post": [16, 20], "facto": 16, "outsid": [16, 19], "subscrib": [16, 22, 23], "visual": 16, "save": 16, "outlin": 16, "themselv": 16, "aim": 16, "give": [16, 19], "familiar": 16, "compon": 16, "eight": 16, "repres": [16, 17, 20], "map": [16, 18, 19, 20, 22], "json": [16, 19, 22], "languag": 16, "class": [16, 19, 22, 23], "flexibl": 16, "everyth": [16, 22], "simul": 16, "acquisit": 16, "begin": 16, "row": [16, 23], "associ": [16, 18, 22], "timestamp": [16, 18, 20, 22], "seri": [16, 19], "envis": 16, "richli": 16, "column": [16, 23], "encompass": 16, "physic": 16, "hardwar": [16, 18], "pointer": 16, "predict": 16, "dimension": 16, "specif": [16, 18, 19, 22, 23], "slice": [16, 19], "within": [16, 20], "restrict": 16, "length": 16, "dimens": [16, 18, 23], "known": 16, "point": [16, 18, 19, 20], "exit": [16, 22], "statu": [16, 23], "succeed": 16, "abort": [16, 22], "fail": [16, 22], "due": [16, 23], "uniqu": [16, 18, 22], "identifi": [16, 18, 20, 22], "run_start": [16, 18, 19, 20], "thu": [16, 19], "liter": [16, 19, 22, 23], "store": [16, 18, 19, 20, 23], "yet": [16, 19], "load": [16, 19, 22], "manag": [16, 22, 23], "final": [16, 22], "form": 16, "effici": [16, 19, 20], "transport": 16, "vector": 16, "represent": [16, 22], "equival": 16, "eventpag": [16, 19, 22, 23], "alwai": [16, 18, 19, 23], "loss": 16, "vice": 16, "versa": 16, "left": [16, 19, 23], "instrument": 16, "team": 16, "individu": [16, 22], "scientist": 16, "given": [16, 18, 19, 22, 23], "sequenc": [16, 22, 23], "short": 16, "sai": 16, "count": [16, 22], "multi": 16, "procedur": 16, "raster": 16, "scan": [16, 19, 20], "togeth": [16, 18, 20], "nontrivi": 16, "satisfi": 16, "typic": [16, 18, 19, 21, 22], "encod": [16, 22], "again": [16, 18, 20], "mark": 16, "compris": 16, "seem": 16, "natur": [16, 20], "block": [16, 23], "than": [16, 19, 23], "allow": [16, 18, 19, 23], "u": [16, 19], "comment": [16, 19, 22], "1550069716": 16, "5092213": 16, "unix": [16, 22], "epoch": [16, 22], "second": [16, 22], "sinc": 16, "jan": 16, "1970": 16, "uid": [16, 18, 19, 20, 22, 23], "10bf6945": [16, 19], "4afd": [16, 19], "43ca": [16, 19], "af36": [16, 19], "6ad8f3540bcd": [16, 19], "global": [16, 19], "id": [16, 18, 23], "data_sess": [16, 23], "vist54321": 16, "data_group": [16, 23], "bl42": 16, "proposal12345": 16, "random_walk": 16, "dt": 16, "motor": [16, 18], "num_interv": 16, "num_point": 16, "plan_arg": 16, "epicssign": 16, "read_pv": 16, "1550070001": 16, "828528": 16, "auto_monitor": 16, "string": [16, 18, 22], "write_pv": 16, "limit": 16, "put_complet": 16, "61472277847348": 16, "1550070000": 16, "807677": 16, "num": 16, "per_step": 16, "none": [16, 18, 22, 23], "plan_nam": 16, "plan_pattern": 16, "inner_product": 16, "plan_pattern_arg": 16, "plan_pattern_modul": 16, "plan_typ": 16, "scan_id": 16, "1550070004": 16, "9850419": 16, "ba1f9076": 16, "7925": 16, "4af8": 16, "916e": 16, "0e1eaa1b3c47": 16, "softwar": [16, 17, 24], "would": [16, 20, 22], "cours": [16, 19, 20], "translat": 16, "human": [16, 19], "readabl": 16, "aid": 16, "interact": 16, "vocabulari": 16, "varieti": 16, "suitcas": 16, "experimet": 16, "subject": [16, 19], "backward": [16, 22, 23], "incompat": [16, 22], "seach": 16, "target": 16, "calcul": [16, 22], "properti": 16, "item": [16, 19, 22], "callabl": [16, 19, 22], "perform": [16, 23], "calcal": 16, "datatyp": 16, "additionalproperti": 16, "patternproperti": 16, "ref": [16, 18], "level": [16, 20, 22, 23], "independ": 16, "ax": 16, "slow": 16, "fast": 16, "anyof": 16, "allof": 16, "config_devic": 16, "config": 16, "config_index": 16, "integ": [16, 22], "locat": [16, 19, 20], "come": [16, 19], "event_descriptor": [16, 22], "enum": [16, 22], "explicit": [16, 23], "interperet": 16, "spec": [16, 19, 22, 23], "group": 16, "facil": 16, "beamlin": [16, 20], "station": 16, "propos": 16, "safeti": 16, "session": 16, "mandat": 16, "scientif": 16, "visit": 16, "trial": 16, "data_typ": 16, "owner": 16, "part": [16, 19], "anoth": [16, 20], "state": [16, 19, 22], "kei": [16, 19, 22, 23], "layout": [16, 20], "cover": 16, "defer": 16, "camera_imag": 16, "dtype": [16, 18, 19], "512": [16, 19, 22], "pv": 16, "object_kei": [16, 18, 22], "foreign": [16, 19], "1550070954": 16, "276659": 16, "d08d2ada": 16, "5f4e": 16, "495b": 16, "8e73": 16, "ff36186e7183": 16, "lower_ctrl_limit": 16, "precis": [16, 18], "upper_ctrl_limit": 16, "994477": 16, "9221013521832928": 16, "812525": 16, "object_nam": [16, 19, 23], "1550070005": 16, "0109222": 16, "0ad55d9": 16, "1b31": 16, "4af2": 16, "865c": 16, "7ab7c8171303": 16, "captur": 16, "datakei": [16, 22, 23], "dim": [16, 23], "null": 16, "empti": [16, 22, 23], "scalar": [16, 19], "boolean": [16, 22], "pattern": [16, 21], "z": 16, "wa": [16, 23], "digit": 16, "decim": 16, "float": [16, 22], "ex": 16, "piec": 16, "engin": 16, "perobjecthint": [16, 22], "interest": [16, 20], "necessari": [16, 19], "interpret": 16, "friendli": 16, "baselin": 16, "signal": 16, "produc": [16, 18, 22], "creation": [16, 17, 19], "directli": [16, 19, 23], "512x512": 16, "fill": [16, 22, 23], "seq_num": [16, 18, 20, 22], "1550072091": 16, "2793343": 16, "2793014": 16, "8eac2f83": 16, "2b3e": 16, "4d67": 16, "ae2c": 16, "1d3aaff29ff5": 16, "via": [16, 18, 23], "datum_id": [16, 19], "272132cf": 16, "564f": 16, "428f": 16, "bf6b": 16, "149ee4287024": 16, "0189056": 16, "7b5343fe": 16, "dfd7": 16, "4884": 16, "bc18": 16, "a0b571ff60b7": 16, "perspect": 16, "were": [16, 19, 23], "simultan": 16, "occur": [16, 22, 23], "separ": [16, 19, 20, 22], "thrown": 16, "awai": 16, "thei": [16, 17, 18, 19, 22, 23], "overal": 16, "often": [16, 17, 18], "quanta": 16, "eventdescriptor": [16, 22, 23], "belong": [16, 19], "move": [16, 19, 20, 22], "seq": 16, "mayb": 16, "content": [16, 19], "event_pag": [16, 22, 23], "datafram": 16, "dataframeforfil": 16, "intent": [16, 20], "numer": 16, "bool": [16, 22], "homogen": 16, "never": 16, "terminologi": 16, "respect": [16, 19, 22], "simplifi": 16, "assumpt": 16, "justif": 16, "lead": 16, "arbitrarili": [16, 22], "turn": [16, 19], "until": [16, 19], "complet": [16, 22, 23], "commonli": 16, "exit_statu": [16, 22], "546cc556": 16, "5f69": 16, "46b5": 16, "bf36": 16, "587d8cfe67a9": 16, "1550072737": 16, "175858": 16, "61bb1db8": 16, "c95c": 16, "4144": 16, "845b": 16, "e248c06d80e1": 16, "num_ev": [16, 23], "1580172029": 16, "3419003": 16, "78c70c2c": 16, "2508": 16, "479e": 16, "9857": 16, "05553748022e": 16, "10": [16, 19], "run_stop": 16, "per": [16, 20], "pair": 16, "role": 16, "plai": 16, "referenc": [16, 19, 22], "larg": [16, 18, 19, 20, 22], "path_semant": [16, 19, 22], "posix": [16, 19, 22], "resource_kwarg": [16, 19, 22], "resource_path": [16, 19, 22], "path": [16, 19, 23, 24], "subdirectori": 16, "data_fil": 16, "some_spec": 16, "ad_hdf5": [16, 19], "gpf": [16, 19], "andor": [16, 19], "2020": [16, 19], "01": [16, 19], "8ff08ff9": [16, 19], "a2bf": [16, 19], "48c3": [16, 19], "8ff3": [16, 19], "dcac0f309d7d": [16, 19], "h5": [16, 19], "frame_per_point": [16, 19], "3b300e6f": [16, 19], "b431": [16, 19], "4750": [16, 19], "a635": [16, 19], "5630d15c81a8": [16, 19], "semant": [16, 19, 23], "rule": 16, "join": 16, "window": [16, 22], "addit": [16, 18, 19, 22, 23], "handler": [16, 22, 23], "filepath": [16, 19], "uri": 16, "subset": [16, 19], "datum_kwarg": [16, 19, 22, 23], "counter": [16, 22, 23], "akin": 16, "retriev": [16, 19, 20], "strucut": 16, "datum_pag": [16, 22, 23], "nativ": 16, "rag": [16, 23], "photon": 16, "mani": [16, 18, 19, 20, 23], "rel": [16, 19], "small": [16, 19, 20], "fluoresc": 16, "detector_1": 16, "stream_resourc": [16, 22], "86340942": 16, "9865": 16, "47f9": 16, "9a8d": 16, "bdaaab1bfce2": 16, "8c70b8c2": 16, "df32": 16, "40e3": 16, "9f50": 16, "29cda8142fa0": 16, "stream_datum": [16, 22], "streamrang": 16, "increment": 16, "last": [16, 19], "less": 16, "streamresourc": [16, 22], "hand": [16, 19, 20, 23], "correspond": [16, 22], "suggest": [16, 19, 22], "stream_nam": 16, "block_id": 16, "whether": [16, 19], "bulk_ev": [16, 22], "datumpag": [16, 22, 23], "datum_kwarg_list": 16, "bulk_datum": [16, 22], "grand": 17, "unifi": 17, "theori": 17, "david": 17, "la": 17, "secret": 17, "understood": 17, "write": 17, "isn": 17, "thing": [17, 20], "call": [17, 18, 22, 23], "tutori": 17, "purpos": [17, 20, 23], "understand": 17, "implic": 17, "help": [17, 19], "immens": 17, "topic": 17, "gave": 18, "overview": 18, "present": [18, 20], "discuss": [18, 20], "recal": 18, "temperatur": [18, 19], "x_setpoint": 18, "x_readback": 18, "05": 18, "1442521007": 18, "9258342": 18, "5029348": 18, "3438923": 18, "randomli": 18, "ten": 18, "sequenti": 18, "ident": [18, 23], "got": 18, "5x5": 18, "epic": 18, "imag": [18, 19], "arbitrari": 18, "obtain": 18, "excerpt": [18, 19], "k": 18, "mm": 18, "suppos": [18, 19], "came": 18, "temp_ctrl": 18, "anew": 18, "middl": 18, "exposur": 18, "usual": [18, 19], "delin": 18, "two": [18, 19, 20, 22, 23], "normal": 18, "read_configur": 18, "told": 18, "describe_configur": 18, "collat": 18, "happen": 18, "offset": 18, "534918": 18, "experiment": [18, 22, 23], "attribut": [18, 23], "taken": [18, 19, 20], "data": [19, 20, 21, 22, 23], "mixtur": 19, "size": 19, "suitabl": [19, 22], "mongodb": [19, 22], "text": 19, "aa10035d": 19, "1d2b": 19, "41d9": 19, "97e6": 19, "03e3fe62fa6c": 19, "219310e0": 19, "faa0": 19, "4990": 19, "84a0": 19, "95b508d4ae35": 19, "omit": 19, "breviti": 19, "placehold": 19, "consult": [19, 23], "Of": 19, "abl": 19, "guess": 19, "wouldn": 19, "program": 19, "goe": 19, "presenc": 19, "futu": 19, "must": [19, 22], "datum": [19, 22, 23], "stack": 19, "notic": 19, "still": [19, 23], "anywher": 19, "common": [19, 20], "hdf5": 19, "tiff": 19, "rather": [19, 23], "redundantli": 19, "ll": 19, "relat": [19, 22, 23], "lifecycl": [19, 22], "context": [19, 22], "depend": [19, 22, 23, 24], "over": [19, 22], "special": [19, 23], "databrok": [19, 23], "reader": 19, "exchang": 19, "pertin": 19, "handler_class": [19, 22], "full_path": [19, 22], "expect": [19, 22, 23], "instanc": [19, 22, 23], "handler_inst": [19, 22], "__init__": [19, 22], "__call__": [19, 22, 23], "myhandl": 19, "self": 19, "stash": 19, "chunk": 19, "some_array_lik": 19, "But": [19, 22], "f": [19, 22], "get_file_list": 19, "presum": 19, "filesystem": [19, 23], "cach": [19, 22, 23], "connect": 19, "filler": [19, 22, 23], "runrout": [19, 22, 23], "easier": [19, 23], "reus": [19, 23], "clean": 19, "proper": 19, "discov": 19, "core": 19, "handler_registri": [19, 22, 23], "discover_handl": 19, "search": 19, "output": [19, 22], "ad_cbf": 19, "area_detector_handl": 19, "pilatuscbfhandl": 19, "areadetectorhdf5handl": 19, "ad_hdf5_swmr": 19, "areadetectorhdf5swmrhandl": 19, "ad_hdf5_swmr_t": 19, "areadetectorhdf5swmrtimestamphandl": 19, "ad_hdf5_t": 19, "areadetectorhdf5timestamphandl": 19, "ad_sp": 19, "areadetectorspehandl": 19, "ad_tiff": 19, "areadetectortiffhandl": 19, "xsp3": 19, "_xspress3": 19, "xspress3hdf5handl": 19, "xsp3_fly": 19, "bulkxspress": 19, "rare": 19, "determin": [19, 23], "track": 19, "flight": 19, "alreadi": [19, 22], "_partially_": 19, "shown": 19, "registri": 19, "cannot": [19, 23], "undefinedassetspecif": [19, 22], "concern": 19, "alloc": 19, "inject": 19, "custom": [19, 22, 23], "cachetool": 19, "lrucach": 19, "lfucach": 19, "receiv": [19, 22], "prepopul": 19, "entir": 19, "lru": 19, "handler_cach": [19, 22], "32": 19, "f1": 19, "f2": 19, "both": [19, 20, 23], "therein": 19, "evict": 19, "recov": 19, "gracefulli": 19, "recreat": 19, "demand": 19, "conveni": [19, 22, 23], "dispos": 19, "rr": 19, "entrypoint": 19, "declar": 19, "entry_point": 19, "imm": 19, "immhandl": 19, "On": [19, 20], "right": 19, "particular": 20, "pro": 20, "con": 20, "further": [20, 22], "complic": 20, "optim": 20, "scenario": 20, "feedback": 20, "docstream": 20, "mongo": 20, "visualizt": 20, "granular": 20, "quickli": 20, "affect": 20, "much": 20, "larger": 20, "preferr": 20, "concept": 20, "chosen": 20, "around": [20, 23], "axi": 20, "volum": 20, "stitch": 20, "variou": [20, 23], "mosaic": 20, "altern": [20, 23], "let": [20, 22, 23], "boundari": [20, 22], "posit": 20, "With": [20, 23], "assign": 20, "4fa521e7": 20, "fcdc": 20, "4a68": 20, "9171": 20, "d4838d1fc9a2": 20, "1600995123": 20, "1785965": 20, "9b5dd575": 20, "b556": 20, "439a": 20, "ba71": 20, "357307caebb9": 20, "tile_0": 20, "a82a83b0": 20, "5959": 20, "4ca3": 20, "a7": 20, "7fb1d0f07994": 20, "tile_1": 20, "Then": 20, "carri": 20, "c4aa6916": 20, "3d84": 20, "446c": 20, "850a": 20, "95fb71cee6b6": 20, "1808913": 20, "somehow": 20, "tile_id": 20, "summari": 20, "advantag": 20, "tomograph": 20, "ad": 20, "hijack": 20, "challeng": 20, "prove": 20, "extrem": 20, "downstream": 20, "visul": 20, "bounari": 20, "usag": 21, "experienc": 21, "histori": 21, "intern": 22, "__version__": [22, 23], "str": 22, "pypa": 22, "setuptools_scm": 22, "documentnam": 22, "qualnam": 22, "stop": 22, "resourc": [22, 23], "schema_valid": [22, 23], "member": 22, "jsonschema": [22, 23], "ivalid": 22, "factori": [22, 23], "root_map": [22, 23], "filler_class": [22, 23], "fill_or_fail": [22, 23], "rout": [22, 23], "callback": [22, 23], "layer": 22, "scheme": 22, "fulli": 22, "remov": [22, 23], "start_doc": 22, "subfactori": [22, 23], "runstart": [22, 23], "subsequ": 22, "runstop": [22, 23], "descriptor_doc": 22, "arriv": 22, "whatev": 22, "parametr": 22, "account": 22, "temporarili": 22, "remount": 22, "subclass": [22, 23], "functool": 22, "partial": 22, "documentrout": [22, 23], "encount": [22, 23], "unfil": [22, 23], "true": 22, "unknown": [22, 23], "streamdatum": 22, "singlerundocumentrout": [22, 23], "get_start": 22, "eventmodelerror": 22, "get_descriptor": 22, "get_stream_nam": 22, "getattr": 22, "origin": [22, 23], "altogeth": 22, "instanti": [22, 23], "exclud": [22, 23], "coerc": [22, 23], "as_i": [22, 23], "resource_cach": 22, "datum_cach": 22, "descriptor_cach": 22, "stream_resource_cach": 22, "stream_datum_cach": 22, "inplac": [22, 23], "retry_interv": 22, "001": 22, "002": 22, "004": 22, "008": 22, "016": 22, "032": 22, "064": 22, "128": 22, "256": 22, "024": 22, "recommend": [22, 24], "expens": 22, "memori": [22, 23], "drop": [22, 23], "upon": 22, "unless": 22, "hold": 22, "garbag": 22, "longer": 22, "delet": 22, "finish": 22, "mutual": 22, "skip": 22, "delai": [22, 23], "regist": [22, 23], "runtim": [22, 23], "found": [22, 23], "race": 22, "ioerror": 22, "wait": 22, "bit": 22, "retri": [22, 23], "sleep": 22, "attempt": 22, "datanotaccess": 22, "catch": 22, "async": 22, "framework": 22, "increas": 22, "interv": 22, "stabl": 22, "author": 22, "tune": 22, "mutat": [22, 23], "export": 22, "del": 22, "overridden": [22, 23], "register_handl": [22, 23], "overwrit": 22, "duplicatehandl": 22, "deregister_handl": [22, 23], "deregist": [22, 23], "op": 22, "get_handl": 22, "explicitli": 22, "clear": [22, 23], "clear_handler_cach": [22, 23], "oper": 22, "signific": 22, "clear_document_cach": [22, 23], "nofil": [22, 23], "mere": [22, 23], "advanc": [22, 23], "register_coercion": [22, 23], "func": [22, 23], "invok": 22, "colliss": 22, "eventmodelvalueerror": 22, "filler_st": [22, 23], "coercion": [22, 23], "unchang": 22, "force_numpi": [22, 23], "compose_run": 22, "composerunbundl": 22, "event_count": 22, "convention": 22, "uuid4": 22, "element": 22, "compose_descriptor": [22, 23], "composedescriptor": 22, "compose_resourc": [22, 23], "composeresourc": 22, "compose_stop": 22, "composestop": 22, "compose_stream_resourc": 22, "composestreamresourc": 22, "bundl": 22, "maintain": 22, "unpack": 22, "basic": 22, "composedescriptorbundl": 22, "prefer": 22, "compose_ev": 22, "composeev": 22, "compose_event_pag": 22, "composeeventpag": 22, "composeresourcebundl": 22, "resource_doc": 22, "compose_datum": 22, "composedatum": 22, "compose_datum_pag": 22, "composedatumpag": 22, "poison_pil": 22, "pack_event_pag": 22, "unpack_event_pag": [22, 23], "yield": 22, "pack_datum_pag": 22, "unpack_datum_pag": [22, 23], "sanitize_doc": [22, 23], "sanit": 22, "prior": 22, "send": 22, "recogn": 22, "sanitized_doc": 22, "verify_fil": [22, 23], "verifi": 22, "unfilleddata": 22, "inlcud": 22, "messag": [22, 23], "numpyencod": [22, 23], "skipkei": 22, "ensure_ascii": 22, "check_circular": 22, "allow_nan": 22, "sort_kei": 22, "indent": 22, "jsonencod": 22, "dump": 22, "cl": 22, "constructor": 22, "sensibl": 22, "typeerror": 22, "non": [22, 23], "ascii": 22, "charact": 22, "escap": 22, "circular": 22, "infinit": 22, "recurs": 22, "caus": [22, 23], "recursionerror": 22, "otherwis": 22, "nan": 22, "infin": 22, "behavior": [22, 23], "consist": [22, 23], "javascript": 22, "decod": 22, "valueerror": [22, 23], "sort": 22, "regress": 22, "ensur": 22, "serial": 22, "compar": 22, "basi": 22, "neg": 22, "pretti": 22, "insert": 22, "newlin": 22, "compact": 22, "item_separ": 22, "key_separ": 22, "tupl": 22, "elimin": 22, "whitespac": 22, "warn": 23, "distutil": 23, "inadvert": 23, "broken": 23, "add": 23, "contigu": 23, "especi": 23, "year": 23, "quo": 23, "importlib": 23, "condit": 23, "v0": 23, "py311": 23, "toc": 23, "modifi": 23, "__array__": 23, "toler": 23, "variant": 23, "dask": 23, "spars": 23, "cupi": 23, "relax": 23, "enhanc": 23, "locaiton": 23, "addition": 23, "repeat": 23, "collid": 23, "chain": 23, "public": 23, "incorrect": 23, "replac": 23, "misspel": 23, "register_coers": 23, "retain": 23, "alia": 23, "sent": 23, "erron": 23, "smooth": 23, "transit": 23, "squash": 23, "propag": 23, "unintention": 23, "un": 23, "pickleabl": 23, "pickl": 23, "duplic": 23, "registr": 23, "coersion": 23, "original_func": 23, "critic": 23, "typo": 23, "codepath": 23, "decid": 23, "formerli": 23, "respons": 23, "insid": 23, "effort": 23, "though": 23, "malform": 23, "mileston": 23, "dispatch": 23, "introduc": 23, "sometim": 23, "notimpl": 23, "fall": 23, "correctli": 23, "sentinel": 23, "confus": 23, "notimplementederror": 23, "backoff": 23, "loop": 23, "appli": 23, "well": 23, "lag": 23, "slightli": 23, "behind": 23, "forc": 23, "interfac": [23, 24], "immedi": 23, "perhap": 23, "overrid": 23, "certain": 23, "filter": 23, "factor": 23, "_dispatch": 23, "specifii": 23, "previous": 23, "distribut": 23, "unresolveableforeignkeyerror": 23, "inconsist": 23, "fill_ev": 23, "fill_event_pag": 23, "rechunk_event_pag": 23, "infer": 23, "off": 23, "assum": 23, "robust": 23, "against": 23, "meta": 23, "python_requir": 23, "wheel": 23, "util": 23, "callbackbas": 23, "interfer": 24}, "objects": {"event_model": [[22, 0, 1, "", "ComposeDescriptorBundle"], [22, 0, 1, "", "ComposeResourceBundle"], [22, 0, 1, "", "ComposeRunBundle"], [22, 0, 1, "", "DocumentNames"], [22, 0, 1, "", "DocumentRouter"], [22, 0, 1, "", "Filler"], [22, 0, 1, "", "NoFiller"], [22, 0, 1, "", "NumpyEncoder"], [22, 0, 1, "", "RunRouter"], [22, 0, 1, "", "SingleRunDocumentRouter"], [22, 3, 1, "", "__version__"], [22, 4, 1, "", "as_is"], [22, 4, 1, "", "compose_datum"], [22, 4, 1, "", "compose_datum_page"], [22, 4, 1, "", "compose_descriptor"], [22, 4, 1, "", "compose_event"], [22, 4, 1, "", "compose_event_page"], [22, 4, 1, "", "compose_resource"], [22, 4, 1, "", "compose_run"], [22, 4, 1, "", "compose_stop"], [22, 4, 1, "", "force_numpy"], [22, 4, 1, "", "pack_datum_page"], [22, 4, 1, "", "pack_event_page"], [22, 4, 1, "", "register_coercion"], [22, 4, 1, "", "sanitize_doc"], [22, 4, 1, "", "unpack_datum_page"], [22, 4, 1, "", "unpack_event_page"], [22, 4, 1, "", "verify_filled"]], "event_model.DocumentNames": [[22, 1, 1, "", "bulk_datum"], [22, 1, 1, "", "bulk_events"], [22, 1, 1, "", "datum"], [22, 1, 1, "", "datum_page"], [22, 1, 1, "", "descriptor"], [22, 1, 1, "", "event"], [22, 1, 1, "", "event_page"], [22, 1, 1, "", "resource"], [22, 1, 1, "", "start"], [22, 1, 1, "", "stop"], [22, 1, 1, "", "stream_datum"], [22, 1, 1, "", "stream_resource"]], "event_model.DocumentRouter": [[22, 2, 1, "", "bulk_datum"], [22, 2, 1, "", "bulk_events"], [22, 2, 1, "", "datum"], [22, 2, 1, "", "datum_page"], [22, 2, 1, "", "descriptor"], [22, 2, 1, "", "emit"], [22, 2, 1, "", "event"], [22, 2, 1, "", "event_page"], [22, 2, 1, "", "resource"], [22, 2, 1, "", "start"], [22, 2, 1, "", "stop"], [22, 2, 1, "", "stream_datum"], [22, 2, 1, "", "stream_resource"]], "event_model.Filler": [[22, 2, 1, "", "clear_document_caches"], [22, 2, 1, "", "clear_handler_cache"], [22, 2, 1, "", "clone"], [22, 2, 1, "", "close"], [22, 2, 1, "", "deregister_handler"], [22, 2, 1, "", "get_handler"], [22, 2, 1, "", "register_handler"]], "event_model.RunRouter": [[22, 2, 1, "", "datum_page"], [22, 2, 1, "", "descriptor"], [22, 2, 1, "", "event_page"], [22, 2, 1, "", "resource"], [22, 2, 1, "", "start"], [22, 2, 1, "", "stop"], [22, 2, 1, "", "stream_datum"], [22, 2, 1, "", "stream_resource"]], "event_model.SingleRunDocumentRouter": [[22, 2, 1, "", "get_descriptor"], [22, 2, 1, "", "get_start"], [22, 2, 1, "", "get_stream_name"]]}, "objtypes": {"0": "py:class", "1": "py:attribute", "2": "py:method", "3": "py:data", "4": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "attribute", "Python attribute"], "2": ["py", "method", "Python method"], "3": ["py", "data", "Python data"], "4": ["py", "function", "Python function"]}, "titleterms": {"architectur": [0, 1], "decis": [0, 1, 2], "record": [0, 1], "1": [1, 23], "statu": [1, 2], "context": [1, 2], "consequ": [1, 2], "2": [2, 23], "switch": 2, "us": [2, 3, 5, 8, 9, 20], "python": [2, 24], "skeleton": 2, "build": [3, 13], "doc": 3, "sphinx": 3, "autobuild": 3, "contribut": 4, "project": [4, 16], "issu": [4, 5], "discuss": 4, "code": [4, 12], "coverag": 4, "develop": [4, 11, 13], "guid": [4, 11, 21], "run": [5, 8, 9, 16], "lint": 5, "pre": 5, "commit": 5, "fix": [5, 23], "make": 6, "releas": [6, 23], "pin": 7, "requir": 7, "introduct": 7, "find": 7, "lock": 7, "file": 7, "appli": 7, "remov": 7, "depend": [7, 13], "from": 7, "ci": 7, "test": [8, 13], "pytest": 8, "static": 9, "analysi": 9, "mypi": 9, "updat": 10, "tool": 10, "tutori": [11, 21], "how": [11, 15, 21], "explan": [11, 21], "refer": [11, 21], "standard": 12, "document": [12, 15, 16, 17, 19, 22], "instal": [13, 24], "clone": 13, "repositori": 13, "see": 13, "what": 13, "wa": 13, "api": [14, 22], "index": 14, "event": [15, 16, 18, 20], "model": [15, 16, 20], "blueski": 15, "where": 15, "i": 15, "my": 15, "data": [15, 16, 18], "structur": 15, "overview": 16, "exampl": 16, "type": 16, "detail": 16, "start": 16, "experiment": 16, "descriptor": [16, 18], "page": 16, "stop": 16, "resourc": [16, 19], "datum": 16, "stream": 16, "bulk": 16, "deprec": [16, 23], "about": 17, "The": [17, 19], "kei": 18, "object": 18, "configur": 18, "hint": 18, "complet": 18, "sampl": 18, "extern": 19, "asset": 19, "handler": 19, "interfac": 19, "discoveri": 19, "fill": 19, "manag": 19, "packag": 19, "pattern": 20, "case": 20, "tomographi": 20, "tile": 20, "mongodb": 20, "serial": 20, "other": 20, "user": 21, "schema": 22, "name": 22, "router": 22, "mint": 22, "mung": 22, "histori": 23, "v1": 23, "19": 23, "9": 23, "2023": 23, "11": 23, "22": 23, "chang": 23, "02": 23, "24": 23, "2022": 23, "12": 23, "09": 23, "0": 23, "03": 23, "ad": 23, "18": 23, "08": 23, "05": 23, "17": 23, "2021": 23, "06": 23, "21": 23, "01": 23, "29": 23, "2020": 23, "16": 23, "10": 23, "15": 23, "04": 23, "27": 23, "14": 23, "13": 23, "3": 23, "31": 23, "28": 23, "intern": 23, "2019": 23, "8": 23, "7": 23, "check": 24, "your": 24, "version": 24, "creat": 24, "virtual": 24, "environ": 24, "librari": 24}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Architectural Decision Records": [[0, "architectural-decision-records"]], "1. Record architecture decisions": [[1, "record-architecture-decisions"]], "Status": [[1, "status"], [2, "status"]], "Context": [[1, "context"], [2, "context"]], "Decision": [[1, "decision"], [2, "decision"]], "Consequences": [[1, "consequences"], [2, "consequences"]], "2. Switched to using a python skeleton": [[2, "switched-to-using-a-python-skeleton"]], "Build the docs using sphinx": [[3, "build-the-docs-using-sphinx"]], "Autobuild": [[3, "autobuild"]], "Contributing to the project": [[4, "contributing-to-the-project"]], "Issue or Discussion?": [[4, "issue-or-discussion"]], "Code coverage": [[4, "code-coverage"]], "Developer guide": [[4, "developer-guide"]], "Run linting using pre-commit": [[5, "run-linting-using-pre-commit"]], "Running pre-commit": [[5, "running-pre-commit"]], "Fixing issues": [[5, "fixing-issues"]], "Make a release": [[6, "make-a-release"]], "Pinning Requirements": [[7, "pinning-requirements"]], "Introduction": [[7, "introduction"]], "Finding the lock files": [[7, "finding-the-lock-files"]], "Applying the lock file": [[7, "applying-the-lock-file"]], "Removing dependency locking from CI": [[7, "removing-dependency-locking-from-ci"]], "Run the tests using pytest": [[8, "run-the-tests-using-pytest"]], "Run static analysis using mypy": [[9, "run-static-analysis-using-mypy"]], "Update the tools": [[10, "update-the-tools"]], "Developer Guide": [[11, "developer-guide"]], "Tutorials": [[11, null], [21, null]], "How-to Guides": [[11, null], [21, null]], "Explanations": [[11, null], [21, null]], "Reference": [[11, null], [21, null]], "Standards": [[12, "standards"]], "Code Standards": [[12, "code-standards"]], "Documentation Standards": [[12, "documentation-standards"]], "Developer install": [[13, "developer-install"]], "Clone the repository": [[13, "clone-the-repository"]], "Install dependencies": [[13, "install-dependencies"]], "See what was installed": [[13, "see-what-was-installed"]], "Build and test": [[13, "build-and-test"]], "API Index": [[14, "api-index"]], "Event Model": [[15, "event-model"]], "Bluesky Event Model Documentation": [[15, "bluesky-event-model-documentation"]], "Where is my data?": [[15, "where-is-my-data"]], "How the documentation is structured": [[15, "how-the-documentation-is-structured"]], "Data Model": [[16, "data-model"]], "Overview": [[16, "overview"]], "Example Runs": [[16, "example-runs"]], "Document Types in Detail": [[16, "document-types-in-detail"]], "Run Start Document": [[16, "run-start-document"]], "Projections (Experimental)": [[16, "projections-experimental"]], "Event Descriptor": [[16, "event-descriptor"]], "Event Document": [[16, "event-document"]], "Event Page": [[16, "event-page"]], "Run Stop Document": [[16, "run-stop-document"]], "Resource Document": [[16, "resource-document"]], "Datum Document": [[16, "datum-document"]], "Datum Page": [[16, "datum-page"]], "Stream Resource Document (Experimental)": [[16, "stream-resource-document-experimental"]], "Stream Datum Document": [[16, "stream-datum-document"]], "\u201cBulk Events\u201d Document (DEPRECATED)": [[16, "bulk-events-document-deprecated"]], "\u201cBulk Datum\u201d Document (DEPRECATED)": [[16, "bulk-datum-document-deprecated"]], "About The Documentation": [[17, "about-the-documentation"]], "Event Descriptors": [[18, "event-descriptors"]], "Data Keys": [[18, "data-keys"]], "Object Keys": [[18, "object-keys"]], "Configuration": [[18, "configuration"]], "Hints": [[18, "hints"]], "Complete Sample": [[18, "complete-sample"]], "External Assets": [[19, "external-assets"]], "The Documents": [[19, "the-documents"]], "Handlers": [[19, "handlers"]], "Handler Interface": [[19, "handler-interface"]], "Handler Discovery": [[19, "handler-discovery"]], "Filling": [[19, "filling"]], "Resource Management": [[19, "resource-management"]], "Handler Packaging": [[19, "handler-packaging"]], "Event Model Patterns": [[20, "event-model-patterns"]], "Use Case - Tomography Tiling and MongoDB Serialization": [[20, "use-case-tomography-tiling-and-mongodb-serialization"]], "Other Use Cases": [[20, "other-use-cases"]], "User Guide": [[21, "user-guide"]], "API Documentation": [[22, "api-documentation"]], "Schemas and Names": [[22, "schemas-and-names"]], "Routers": [[22, "routers"]], "Document Minting": [[22, "document-minting"]], "Document Munging": [[22, "document-munging"]], "Release History": [[23, "release-history"]], "v1.19.9 (2023-11-22)": [[23, "v1-19-9-2023-11-22"]], "Changed": [[23, "changed"], [23, "id1"], [23, "id2"], [23, "id4"], [23, "id6"], [23, "id9"], [23, "id12"], [23, "id15"], [23, "id18"], [23, "id21"], [23, "id23"], [23, "id25"], [23, "id27"], [23, "id29"]], "v1.19.2 (2023-02-24)": [[23, "v1-19-2-2023-02-24"]], "v1.19.1 (2022-12-09)": [[23, "v1-19-1-2022-12-09"]], "v1.19.0 (2022-11-03)": [[23, "v1-19-0-2022-11-03"]], "Added": [[23, "added"], [23, "id3"], [23, "id5"], [23, "id7"], [23, "id8"], [23, "id10"], [23, "id11"], [23, "id14"], [23, "id16"], [23, "id26"], [23, "id28"], [23, "id33"], [23, "id35"], [23, "id36"], [23, "id39"], [23, "id40"]], "v1.18.0 (2022-08-05)": [[23, "v1-18-0-2022-08-05"]], "v1.17.2 (2021-06-21)": [[23, "v1-17-2-2021-06-21"]], "v1.17.1 (2021-01-29)": [[23, "v1-17-1-2021-01-29"]], "v1.17.0 (2020-12-17)": [[23, "v1-17-0-2020-12-17"]], "v1.16.1 (2020-10-15)": [[23, "v1-16-1-2020-10-15"]], "v1.16.0 (2020-09-03)": [[23, "v1-16-0-2020-09-03"], [23, "id13"]], "v1.15.2 (2020-06-12)": [[23, "v1-15-2-2020-06-12"]], "v1.15.1 (2020-05-01)": [[23, "v1-15-1-2020-05-01"]], "Fixed": [[23, "fixed"], [23, "id17"], [23, "id19"], [23, "id20"], [23, "id22"], [23, "id24"], [23, "id30"], [23, "id31"], [23, "id32"], [23, "id34"]], "v1.15.0 (2020-04-27)": [[23, "v1-15-0-2020-04-27"]], "v1.14.1 (2020-04-06)": [[23, "v1-14-1-2020-04-06"]], "v1.14.0 (2020-03-11)": [[23, "v1-14-0-2020-03-11"]], "v1.13.3 (2020-03-05)": [[23, "v1-13-3-2020-03-05"]], "v1.13.2 (2020-01-31)": [[23, "v1-13-2-2020-01-31"]], "v1.13.1 (2020-01-28)": [[23, "v1-13-1-2020-01-28"]], "v1.13.0 (2020-01-21)": [[23, "v1-13-0-2020-01-21"]], "Deprecated": [[23, "deprecated"]], "Internal Changes": [[23, "internal-changes"]], "v1.12.0 (2019-10-11)": [[23, "v1-12-0-2019-10-11"]], "v1.11.2 (2019-09-03)": [[23, "v1-11-2-2019-09-03"]], "v1.11.1 (2019-08-09)": [[23, "v1-11-1-2019-08-09"]], "v1.11.0 (2019-06-27)": [[23, "v1-11-0-2019-06-27"]], "v1.10.0 (2019-05-24)": [[23, "v1-10-0-2019-05-24"]], "Fixes": [[23, "fixes"], [23, "id37"], [23, "id38"]], "v1.9.0 (2019-05-01)": [[23, "v1-9-0-2019-05-01"]], "v1.8.3 (2019-03-28)": [[23, "v1-8-3-2019-03-28"]], "v1.8.2 (2019-03-08)": [[23, "v1-8-2-2019-03-08"]], "v1.8.0 (2019-03-05)": [[23, "v1-8-0-2019-03-05"]], "v1.7.0 (2019-01-03)": [[23, "v1-7-0-2019-01-03"]], "Installation": [[24, "installation"]], "Check your version of python": [[24, "check-your-version-of-python"]], "Create a virtual environment": [[24, "create-a-virtual-environment"]], "Installing the library": [[24, "installing-the-library"]]}, "indexentries": {"composedescriptorbundle (class in event_model)": [[22, "event_model.ComposeDescriptorBundle"]], "composeresourcebundle (class in event_model)": [[22, "event_model.ComposeResourceBundle"]], "composerunbundle (class in event_model)": [[22, "event_model.ComposeRunBundle"]], "documentnames (class in event_model)": [[22, "event_model.DocumentNames"]], "documentrouter (class in event_model)": [[22, "event_model.DocumentRouter"]], "filler (class in event_model)": [[22, "event_model.Filler"]], "nofiller (class in event_model)": [[22, "event_model.NoFiller"]], "numpyencoder (class in event_model)": [[22, "event_model.NumpyEncoder"]], "runrouter (class in event_model)": [[22, "event_model.RunRouter"]], "singlerundocumentrouter (class in event_model)": [[22, "event_model.SingleRunDocumentRouter"]], "as_is() (in module event_model)": [[22, "event_model.as_is"]], "bulk_datum (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.bulk_datum"]], "bulk_datum() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.bulk_datum"]], "bulk_events (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.bulk_events"]], "bulk_events() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.bulk_events"]], "clear_document_caches() (event_model.filler method)": [[22, "event_model.Filler.clear_document_caches"]], "clear_handler_cache() (event_model.filler method)": [[22, "event_model.Filler.clear_handler_cache"]], "clone() (event_model.filler method)": [[22, "event_model.Filler.clone"]], "close() (event_model.filler method)": [[22, "event_model.Filler.close"]], "compose_datum() (in module event_model)": [[22, "event_model.compose_datum"]], "compose_datum_page() (in module event_model)": [[22, "event_model.compose_datum_page"]], "compose_descriptor() (in module event_model)": [[22, "event_model.compose_descriptor"]], "compose_event() (in module event_model)": [[22, "event_model.compose_event"]], "compose_event_page() (in module event_model)": [[22, "event_model.compose_event_page"]], "compose_resource() (in module event_model)": [[22, "event_model.compose_resource"]], "compose_run() (in module event_model)": [[22, "event_model.compose_run"]], "compose_stop() (in module event_model)": [[22, "event_model.compose_stop"]], "datum (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.datum"]], "datum() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.datum"]], "datum_page (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.datum_page"]], "datum_page() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.datum_page"]], "datum_page() (event_model.runrouter method)": [[22, "event_model.RunRouter.datum_page"]], "deregister_handler() (event_model.filler method)": [[22, "event_model.Filler.deregister_handler"]], "descriptor (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.descriptor"]], "descriptor() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.descriptor"]], "descriptor() (event_model.runrouter method)": [[22, "event_model.RunRouter.descriptor"]], "emit() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.emit"]], "event (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.event"]], "event() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.event"]], "event_model.__version__ (built-in variable)": [[22, "event_model.__version__"]], "event_page (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.event_page"]], "event_page() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.event_page"]], "event_page() (event_model.runrouter method)": [[22, "event_model.RunRouter.event_page"]], "force_numpy() (in module event_model)": [[22, "event_model.force_numpy"]], "get_descriptor() (event_model.singlerundocumentrouter method)": [[22, "event_model.SingleRunDocumentRouter.get_descriptor"]], "get_handler() (event_model.filler method)": [[22, "event_model.Filler.get_handler"]], "get_start() (event_model.singlerundocumentrouter method)": [[22, "event_model.SingleRunDocumentRouter.get_start"]], "get_stream_name() (event_model.singlerundocumentrouter method)": [[22, "event_model.SingleRunDocumentRouter.get_stream_name"]], "pack_datum_page() (in module event_model)": [[22, "event_model.pack_datum_page"]], "pack_event_page() (in module event_model)": [[22, "event_model.pack_event_page"]], "register_coercion() (in module event_model)": [[22, "event_model.register_coercion"]], "register_handler() (event_model.filler method)": [[22, "event_model.Filler.register_handler"]], "resource (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.resource"]], "resource() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.resource"]], "resource() (event_model.runrouter method)": [[22, "event_model.RunRouter.resource"]], "sanitize_doc() (in module event_model)": [[22, "event_model.sanitize_doc"]], "start (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.start"]], "start() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.start"]], "start() (event_model.runrouter method)": [[22, "event_model.RunRouter.start"]], "stop (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.stop"]], "stop() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.stop"]], "stop() (event_model.runrouter method)": [[22, "event_model.RunRouter.stop"]], "stream_datum (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.stream_datum"]], "stream_datum() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.stream_datum"]], "stream_datum() (event_model.runrouter method)": [[22, "event_model.RunRouter.stream_datum"]], "stream_resource (event_model.documentnames attribute)": [[22, "event_model.DocumentNames.stream_resource"]], "stream_resource() (event_model.documentrouter method)": [[22, "event_model.DocumentRouter.stream_resource"]], "stream_resource() (event_model.runrouter method)": [[22, "event_model.RunRouter.stream_resource"]], "unpack_datum_page() (in module event_model)": [[22, "event_model.unpack_datum_page"]], "unpack_event_page() (in module event_model)": [[22, "event_model.unpack_event_page"]], "verify_filled() (in module event_model)": [[22, "event_model.verify_filled"]]}}) \ No newline at end of file diff --git a/main/user/explanations/data-model.html b/main/user/explanations/data-model.html index 36370814..f86b8368 100644 --- a/main/user/explanations/data-model.html +++ b/main/user/explanations/data-model.html @@ -8,7 +8,7 @@ - Data Model — event-model 1.19.9.dev6+ga4829b8 documentation + Data Model — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/user/explanations/docs-structure.html b/main/user/explanations/docs-structure.html index c19da139..edce1a4c 100644 --- a/main/user/explanations/docs-structure.html +++ b/main/user/explanations/docs-structure.html @@ -8,7 +8,7 @@ - About The Documentation — event-model 1.19.9.dev6+ga4829b8 documentation + About The Documentation — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/user/explanations/event-descriptors.html b/main/user/explanations/event-descriptors.html index bcdba7d2..02770ebf 100644 --- a/main/user/explanations/event-descriptors.html +++ b/main/user/explanations/event-descriptors.html @@ -8,7 +8,7 @@ - Event Descriptors — event-model 1.19.9.dev6+ga4829b8 documentation + Event Descriptors — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/user/explanations/external.html b/main/user/explanations/external.html index 383d8577..fd0546f8 100644 --- a/main/user/explanations/external.html +++ b/main/user/explanations/external.html @@ -8,7 +8,7 @@ - External Assets — event-model 1.19.9.dev6+ga4829b8 documentation + External Assets — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/user/how-to/use-cases.html b/main/user/how-to/use-cases.html index f42a19c7..79601f9f 100644 --- a/main/user/how-to/use-cases.html +++ b/main/user/how-to/use-cases.html @@ -8,7 +8,7 @@ - Event Model Patterns — event-model 1.19.9.dev6+ga4829b8 documentation + Event Model Patterns — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/user/index.html b/main/user/index.html index d8d6b9e8..8ada5f97 100644 --- a/main/user/index.html +++ b/main/user/index.html @@ -8,7 +8,7 @@ - User Guide — event-model 1.19.9.dev6+ga4829b8 documentation + User Guide — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/user/reference/api.html b/main/user/reference/api.html index 922e85f4..a3fe376b 100644 --- a/main/user/reference/api.html +++ b/main/user/reference/api.html @@ -8,7 +8,7 @@ - API Documentation — event-model 1.19.9.dev6+ga4829b8 documentation + API Documentation — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + diff --git a/main/user/reference/release-history.html b/main/user/reference/release-history.html index e6948494..b194aac3 100644 --- a/main/user/reference/release-history.html +++ b/main/user/reference/release-history.html @@ -8,7 +8,7 @@ - Release History — event-model 1.19.9.dev6+ga4829b8 documentation + Release History — event-model 1.19.9.dev8+gab5dde3 documentation @@ -39,7 +39,7 @@ - + @@ -475,11 +475,20 @@

Release History#

-
-

v1.19.2 (2023-02-24)#

+
+

v1.19.9 (2023-11-22)#

Changed#

    +

  • Dropped support for jsonschema 2.*.

    • +
+
+
+
+

v1.19.2 (2023-02-24)#

+
+

Changed#

+

  • Fix warnings about distutils being deprecated in Python>=3.10

@@ -500,8 +509,8 @@

Added#< or has no pre-determined shape (number of rows).

-
-

Changed#

+
+

Changed#

  • Added object_name to Event Descriptor schema. The RunEngine has been adding this for many years. This change merely documents the status quo.

    • @@ -512,14 +521,14 @@

    Changed#<

v1.18.0 (2022-08-05)#

-
-

Added#

+
+

Added#

  • GitHub workflow to publish releases on PyPI

-
-

Changed#

+
+

Changed#

  • Fix for databroker.v0 API

  • Fix versioneer compatibility with py311

    • @@ -528,14 +537,14 @@

    Changed#<

v1.17.2 (2021-06-21)#

-
-

Added#

+
+

Added#

  • Event, Datum Page were added to TOC

-
-

Changed#

+
+

Changed#

  • The start document parameter to compose_resource() is now optional

  • descriptor() has been modified to record descriptor document @@ -545,8 +554,8 @@

    Changed#<

v1.17.1 (2021-01-29)#

-
-

Added#

+
+

Added#