Skip to content

Commit 3ddd98a

Browse files
wakonigCopilot
andcommitted
feat: add what-to-remember sections
Co-authored-by: Copilot <copilot@github.com>
1 parent b1a714b commit 3ddd98a

3 files changed

Lines changed: 22 additions & 0 deletions

File tree

docs/learn/devices/introduction-to-ophyd.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,14 @@ The device-and-signal model makes it possible to:
124124

125125
That makes ophyd a practical abstraction layer for scientific instrumentation software.
126126

127+
!!! info "What to remember"
128+
- In ophyd, a `Signal` models one value and a `Device` groups related signals.
129+
- `Component` declarations define a reusable device structure that can be instantiated with
130+
different prefixes.
131+
- `read()` and `read_configuration()` serve different purposes.
132+
- `Kind` controls whether a signal behaves like measured data, configuration data, or is
133+
omitted from normal reads.
134+
127135
## What to read next
128136

129137
If you are learning ophyd specifically for BEC, the next useful pages are:

docs/learn/file-writer/introduction.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,10 @@ BEC file writing is organized around a few distinct pieces:
2727
- plugin-provided writer classes, which can extend that structure
2828
- file references, which let devices announce externally created files so they can be linked into the master file
2929
- async writing, which continuously writes data while the scan is still running
30+
31+
!!! info "What to remember"
32+
- BEC writes scan data to HDF5 files after every scan.
33+
- The default layout is defined by `DefaultFormat` and does not strictly enforce NeXuS.
34+
- Beamlines can extend or replace the default layout through a plugin-provided writer class.
35+
- Devices can link externally created files into the master file using file references.
36+
- Async writing keeps data flowing into the file while the scan is still in progress.

docs/learn/gui/introduction.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,13 @@ data updates, Qt property support, and RPC exposure for user-facing methods. In
8181
is used to build beamline-specific views that can then be reused in BEC Designer, the Dock Area,
8282
and scripted RPC workflows.
8383

84+
!!! info "What to remember"
85+
- BEC Widgets runs in a separate process, so GUI load does not affect scan execution.
86+
- Live widget updates come from Redis events through the BEC Dispatcher into Qt signals/slots.
87+
- You can build UIs in four ways: BEC Designer, Dock Area profiles, RPC scripting, or custom
88+
`BECWidget` subclasses.
89+
- GUI workflows can stay fully graphical, fully scripted, or mixed in the same experiment.
90+
8491
## What to read next
8592

8693
- [RPC GUI Control](rpc-gui-control.md) explains how the BEC IPython client communicates with

0 commit comments

Comments
 (0)