ISISComputingGroup/ibex_bluesky_core

Muons: set run "comment" from bluesky scan

Open

#196 opened on May 6, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (0 forks)auto 404
Muonsgood first issue

Repository metrics

Stars
 (4 stars)
PR merge metrics
 (PR metrics pending)

Description

As a user on muons I want to be able to find what scan a DAE .nxs file was part of.

To do this, insert the bluesky scan ID (or another suitable string identifier) as the "run comment" in the experiment details. This way we have a two-way link between .nxs which has a pointer to the scan it's part of, and the scan which has pointers to the .nxs it generated.

We can write this as a bluesky preprocessor that reacts to open_run and close_run messages. After we've seen the open_run message we know the UID of a scan, the preprocessor can then write this to the comment field. On close run it should put the comment back to whatever it was before.

Contributor guide

Research direction
Implement a bluesky preprocessor that reacts to `open run` and `close run` messages. On `open run`, extract the scan UID and write it to the experiment's run comment field. On `close run`, revert the comment to its previous value.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythonbluesky
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70