Skip to content

Make run_number a metadata key in period-per-point mode & document/make it easier to add scan-specific metadata #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
danielmaclaren merged 4 commits into from
Oct 30, 2025
Merged

Make run_number a metadata key in period-per-point mode & document/make it easier to add scan-specific metadata #277

danielmaclaren merged 4 commits into from
Oct 30, 2025

Conversation

@Tom-Willemsen
Copy link
Member

@Tom-Willemsen Tom-Willemsen commented Oct 29, 2025 •
edited by danielmaclaren
Loading

Description of work

  • Makes run_number a metadata key in our standard scan() plan, if in period-per-point mode and save_run is True.
  • Document how to pass around extra md so that users can add any other metadata that they happen to want easily.
  • Allow passing extra md into most of our top-level plans (as per bluesky upstream recommendation)

Ticket

Closes #152

Acceptance criteria

  • Pull request title is understandable for a user (e.g. scientist) reading the release notes. The PR title should be a short description of the change from a user perspective.
  • Pull request has appropriate labels for automatic release-notes generation
  • run_number is a metadata key in our standard scan() plan, if in period-per-point mode and save_run is True. Otherwise it should not be present.

Documentation

Added documentation in the getting-started guide about how to add further metadata if users are not using "our" scan plan wrapper.

@Tom-Willemsen Tom-Willemsen added the bluesky-Semver-Minor New functionality / back-compatible changes label Oct 29, 2025
@pull-request-size pull-request-size bot added size/L and removed size/M labels Oct 29, 2025
@Tom-Willemsen Tom-Willemsen marked this pull request as ready for review October 29, 2025 17:17
@Tom-Willemsen Tom-Willemsen changed the title Make run_number a metadata key in period-per-point mode Make run_number a metadata key in period-per-point mode & document/make it easier to add scan-specific metadata Oct 29, 2025
@danielmaclaren danielmaclaren self-requested a review October 30, 2025 14:11
danielmaclaren
danielmaclaren approved these changes Oct 30, 2025
View reviewed changes
Copy link
Contributor

@danielmaclaren danielmaclaren left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description in documentation, updated standard scans and test case passed

@danielmaclaren danielmaclaren merged commit 14dc973 into main Oct 30, 2025
14 checks passed
@danielmaclaren danielmaclaren deleted the Ticket152 branch October 30, 2025 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@danielmaclaren danielmaclaren danielmaclaren approved these changes

Assignees

No one assigned

Labels

bluesky-Semver-Minor New functionality / back-compatible changes size/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

In period-per-point mode make run_number a metadata key

3 participants

@Tom-Willemsen @danielmaclaren