Write a beamline troubleshooting guide

[Tom-Willemsen]

Targeted at inst. sci. or first line support sort of level - not quite the same as the tutorial which is about "what is ibex_bluesky_core" but rather targeted at "it's broken, help me fix it"

• Where is the code
  • Both our code, and that exists on individual beamlines
• Where are the logs
  • How do I make it log more
• Where is the data
  • Raw data (diagnostics)
  • Scientist-facing data
• I typed plan(...) instead of RE(plan(...)) and it didn't do anything useful
• What do I do when it falls over with <some exception>
• I got <some warning> printed, is that important?
• How do I debug plans
• What rules do I need to follow to not make problems worse / create further problems
  • Rules in plans - e.g. finalize_wrapper not try-finally, not stalling the event loop, not doing I/O, etc (link to bluesky tutorials mostly)
  • Rules in devices
  • Where should I put that extra sleep that I've just discovered <some device> needs in order to work?
• What is an event loop / asyncio
  • and why should I care about not stalling it, symptoms if it does get stalled & how to debug this
• Why does my data look weird?
• Why didn't my fit do a good job with <some data>?
• <bluesky / ibex_bluesky_core / ophyd_async> has ruined my <night's sleep / career / marriage / life> how do I make it do <the thing>
• What happens if motion is not working - how do I diagnose/debug this?