Skip to content

docs: Add simple devices and plans for use in tutorials - #1577

Merged
abbiemery merged 8 commits into
mainfrom
toy-devices
Jul 29, 2026
Merged

docs: Add simple devices and plans for use in tutorials#1577
abbiemery merged 8 commits into
mainfrom
toy-devices

Conversation

@abbiemery

@abbiemery abbiemery commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

With the removal of dodal as a dependency, we need to provide some simple devices and plans in order to follow through the tutorials. These are getting overhauled in #1564.

This adds ophyd-async sim devices and dodal plans to allow users to run simple plans and make a hdf5 file.

@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.96%. Comparing base (b767635) to head (bad808c).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1577      +/-   ##
==========================================
+ Coverage   95.93%   95.96%   +0.02%     
==========================================
  Files          44       45       +1     
  Lines        3300     3317      +17     
==========================================
+ Hits         3166     3183      +17     
  Misses        134      134              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread src/blueapi/tutorial/plans.py Outdated

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Is there a better place for this to live?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

utils would make the most sense if there's a way of getting it working without import order issues

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

utils but not include it in the __all__ ?

@abbiemery

abbiemery commented Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

After a lot of rabbit holes, I went back to using optional dependencies for the demo. I don't think the config should live in that module though, I will put it just in the docs.

@abbiemery
abbiemery requested a review from tpoliaw July 29, 2026 10:59

@fajinyuan fajinyuan left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks good tome.

@abbiemery
abbiemery added this pull request to the merge queue Jul 29, 2026
Merged via the queue into main with commit 26a0ea2 Jul 29, 2026
20 checks passed
@abbiemery
abbiemery deleted the toy-devices branch July 29, 2026 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants