Repository navigation
Add documentation for using Tiled at Diamond - #37
Open
ZohebShaikh wants to merge 4 commits into
Open
ZohebShaikh wants to merge 4 commits into
ZohebShaikh wants to merge 4 commits into
Conversation
Cover getting started, searching with Tiled queries and Glazed, live streaming, NeXus file creation, the current and central authorization policies, and the per-beamline deployment architecture. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Generate the docs setup from python-copier-template 5.4.0 with docs_type sphinx and move the pages into its tutorials, how-to and explanations layout. Publish through the GitHub Pages actions in place of the template's gh-pages step. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Explain that acquisition comes first and how an outage is handled. Add an example of reading Tiled from UDC, a workaround for creating a processed folder that the central authorization migration keeps, how to request a custom endpoint, and searching with TimeRange. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #37 +/- ##
=======================================
Coverage 95.79% 95.79%
=======================================
Files 5 5
Lines 857 857
=======================================
Hits 821 821
Misses 36 36 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
ZohebShaikh
marked this pull request as ready for review
November 10, 2026 19:34
ZohebShaikh
commented
Nov 11, 2026
| | Open Policy Agent | Makes the access decisions. See [Authorization](authorization.md). | | ||
| | Redis | Tiled's streaming cache, which live [streaming](streaming.md) requires. | | ||
| | Glazed | The [GraphQL interface](searching.md#graphql-with-glazed), a separate service in front of Tiled. | | ||
| | oauth2-proxy | Sits in front of Tiled and Glazed, and sends anonymous browsers to log in. | |
Contributor
Author
There was a problem hiding this comment.
This will be remove in a future version to remove this as a single point of failure
ZohebShaikh
commented
Nov 11, 2026
| visit.search(Key("start.blueapi_task_id") == task_id).values().first() | ||
|
|
||
| # Everything since a given time | ||
| visit.search(Key("start.time") > datetime(2026, 7, 2, 9, 0).timestamp()) |
ZohebShaikh
commented
Nov 11, 2026
Comment on lines
+16
to
+18
| It needs a recent client: `bluesky-tiled-plugins` 2.0.13 and `tiled` 0.2.21 are | ||
| known to work. Older Tiled clients try to create an API key for the connection, | ||
| which fails without the `create:apikeys` scope. |
Contributor
Author
There was a problem hiding this comment.
Currently prod tiled is stuck on 0.2.18, once updated you will be able to use the tiled_client for websocket.
But the raw websocket connection should still work without the update
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cover getting started, searching with Tiled queries and Glazed, live streaming, NeXus file creation, the current and central authorization policies, and the per-beamline deployment architecture.