Reference
apps/web: the workbench server, the readout catalogue that says what this front end can carry, the hookup guide and the montage drawings.
pythonpathapps/webmodules4public symbols19Real calls, run when this page was built. The code is the story file itself.
Each readout in the catalogue names the feature that makes it informative. readouts.gate asks the front-end model whether that feature fits in the band, and answers before anything is recorded.
import readouts
gates = {r["key"]: readouts.gate(r["key"]) for r in readouts.catalogue()}Ran 2026-10-02 21:53 at 98158d0 in 0.0 s. Output is computed at build time; plots decimate long traces for display only.
hookuphookup.py -- the guide that opens BEFORE the port does. Stdlib only.placement.placementplacement.py — WHERE DO THE ELECTRODES GO? As a picture, not a paragraph.readoutsreadouts.py -- WHAT the electrodes are measuring, and whether this front end can carry it.serveserve.py -- the olimex-shield workbench: live view, record, playback, electrode placement.Read from the source without importing or running it.
hookuphookup.py -- the guide that opens BEFORE the port does. Stdlib only.
guide(readout_key: str='eeg') -> dictEverything the modal shows. Raises rather than returning a partial guide.
A guide missing its diagram, or showing a site the montage does not contain, is worse than no guide -- someone places an electrode from it.
placement.placementplacement.py — WHERE DO THE ELECTRODES GO? As a picture, not a paragraph.
class PlacementError(ValueError)maps()get_map(map_id, mirror=False)sites(map_id)label_boxes(montage, map_id='hand-dorsal-right', mirror=False)Where each label's text actually lands, in view-box units.
Same estimate _gutters already uses, so the two cannot disagree about how wide a label is.
label_collisions(montage, map_id='hand-dorsal-right', mirror=False)Pairs of labels whose text boxes overlap.
A diagram whose captions sit on top of each other is unreadable in exactly the place it matters — beside the electrode. This was found by LOOKING at a rendered head map (two labels printed over one another) rather than by any test, which is why it is a function now.
render(montage, map_id='hand-dorsal-right', mirror=False, title=None, width=560, require_ground=True)Montage -> a self-contained SVG string.
montage is a list of {role, site, note?} — the shape the scalp montage advisor, ECG lead definitions and peripheral montages already use.
checklist(montage, map_id='hand-dorsal-right', mirror=False)The words that go beside the picture: one line per connection, plus each site's own note.
readoutsreadouts.py -- WHAT the electrodes are measuring, and whether this front end can carry it.
class ReadoutError(ValueError)get(key: str) -> dictgate(key: str) -> dictCan this front end carry this readout's informative feature? Answer BEFORE recording.
Returns the per-frequency verdict for the feature and both band edges, so a readout that is fine in the middle and destroyed at one edge cannot read as simply 'reachable'.
catalogue() -> listserveserve.py -- the olimex-shield workbench: live view, record, playback, electrode placement.
tools_dir()The directory holding the optional companion analysis tools: $OLIMEX_TOOLS, else the nearest parent with a REGISTRY.md. The Atlas tab and the extraction widgets come from there; without it they are switched off.
optional_tools() -> dictclass Handler(SimpleHTTPRequestHandler)bridge_up(url: str=BRIDGE) -> boolstart_bridge(url: str=BRIDGE) -> subprocess.Popen | Nonemain(argv=None)↑↓ to move · ↵ to open · esc to close