Syllabus for upcoming tutorial for beamline staff

[danielballan]

Start (Tutorials)

• How to Use This: local install, JupyterLite, JupyterHub (?)
• New to Python? (link to https://lectures.scientific-python.org/, Software Carpentry, and others)
• Quickstart: Hello Bluesky (ophyd + RE + tiled + plot)
• What is Bluesky?

How-To Guides

• Access Data: auth, search, navigate and slice, export
• Compose "Plans"
• Capture Metadata
• Interrupt and Resume (pause and suspend)
• Integrating Devices
• Use Streaming (callbacks)
• Simulate Experiments
• Debug (logging, msg_hook, etc)

Solutions

• Use 0MQ to Stream Documents
• Automatically take dark frames

Add to this section application-specific tutorials from past User Meetings.

Integrations

• PyMCA
• Napari

Technical Overviews

• Ecosystem Architecture
• Ophyd and Ophyd-Async
• Document Storage
• Anatomy of an Ophyd Device
• The Parable of the RunEngine
• RunEngine over HTTP (Queueserver)

Reference

• Bluesky Document Model

More ideas...

• Draw on https://bcda-aps.github.io/bluesky_training/
• Draw on https://hzb-controls-wiki.readthedocs.io/en/external/Beamlines/bluesky_training/

[bruceravel]

This is a good start, but it seems really scattered. "What is Bluesky" and "Anatomy of an Ophyd Device" are not topics I would want to introduce to a hire on the same day. Probably not the same month.

I'm not certain the organizational structure suggested here is the right way to think about training a new BL hire. That is, I think the structure proposed here are the <h2> ... </h2> labels. The <h1> labels should be more focused on aspects of the BL experience. For example:

• Training to do user support
• Writing a measurement plan
• Integrating a motor or detector into the beamline
• Using tiled for data visualization, reduction, and analysis
• Developing a data reduction / date analysis pipeline
  and so on.

With that sort of structure, then subheadings like "getting started", "how-to guides", and "technical overview" make more sense, will be easier for the authors to write, and will end up being more focused. More focused probably means more useful to the flummoxed newbie.

[bruceravel]

I am also confused about the purpose of the Integrations heading. What is the value add of that section beyond the (presumably) excellent on line offerings? And what is the scope of that section. At BMM, for example, we do not use either of the programs on the list. (Edit: well, on second thoughht, the IBM folks use PyMCA to visualize theta/2theta and reflectivity data.)

So "Integrations" is a confusing heading. Something like "Useful tools from outside the Bluesky ecosystem" is probably more what you mean. I think the way to frame an entry about a specific external package would be something like:

• What measurement techniques is this relevant to? What beamline is this relevant to?
• What documentation / explanation is needed for NSLS-II use cases that is not covered in the online documentation?
• How does this package interact with Tiled?
• Give examples with step-by-step instructions and screenshots, using real, measured-at-NSLS-II data which is publically available.

[danielballan]

This is good feedback. For what it's worth, we intend to cover this over a period of several months, perhaps ~12 weekly sessions. So, indeed, it is not something we would cover in the same week or month. Some of this material may be supplemental, for people who explore when they are ready.

The purpose of the "Integrations" is to specifically address how to use popular external software with Bluesky and Tiled. (You may know we have plugins/extensions in development to integrate both Napari and PyMCA with Tiled for more streamlined access.) I like your framing.