Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

MotorMemory

Muscle memory for motors: a small PyQt5 tool to save and restore named motor positions at the beamline.

  • Columns are EPICS motor records (base PV, e.g. MFX:DG1:MMS:01). The tool reads .RBV .VAL .DMOV .EGU .DESC .LLM .HLM .RDBD .PREC.
  • Rows are named presets, one coordinate per motor.
  • A pinned LIVE row shows the current readback (green = connected, yellow = moving, red = disconnected).
  • Several independent tables live in dockable panels (e.g. "Sample stage", "Diode"): tabbed by default, drag a title bar to float one as its own window (e.g. on a second monitor) or drop it next to another to tile them. Closing a floating table returns it to the main window. Tile all / Stack as tabs rearrange everything; the layout is remembered.

Everything autosaves to a JSON file (default ~/.motormemory/presets.json, override with --file or $MOTORMEMORY_FILE, e.g. to share a file in the experiment directory).

Workflow

  1. Type or paste one or more motor base PVs in the top bar and press Add motor(s) (or Paste PV names to take them from the clipboard). Trailing .RBV/.VAL are stripped. The header shows ● green when connected and the description/units once they arrive.
  2. Create preset rows:
    • Capture current - snapshot the live readbacks under a name.
    • Paste values / Ctrl+V - paste rows of numbers (tab, comma or space separated; a leading non-numeric cell becomes the preset name). If a motor cell is selected the paste starts there, otherwise rows are added.
    • New empty row then type into cells.
    • Update selected from live - overwrite a row with the readbacks.
  3. Select a row and press Move to selected (no confirmation). By default motors move sequentially: one at a time, in column order (left to right); the next is commanded only when the previous reports done (DMOV). This avoids current spikes that can trip breakers on stages sharing a supply (issue #1). Motors already at their target are not commanded. While a sequence runs the button becomes Abort (stops further puts; a motor already moving finishes). If a motor is still moving after 60 s the sequence stops there. Set the table's Move box to All at once to command every motor simultaneously. If some motor cannot be moved (disconnected, no write access, outside soft limits) it is skipped and a popup lists it.

Cell colours are live on every row: green when the motor's readback is at that cell's value (within tolerance), yellow while moving toward it, grey if the motor is disconnected, red if the value is outside the soft limits. So the green row tells you which preset you are currently at. Tolerance is the motor's RDBD (fallback 0.01) unless the per-table Tolerance box is non-zero.

Long PV names can be given a friendly name: double-click the column header (or right-click > Rename column). The header then shows the friendly name on the first line and the PV on the second.

Right-click a column header to move/remove a motor; right-click a row to duplicate/move/delete it or copy the table as text. Double-click a LIVE cell to copy its value. Delete key removes selected rows.

eLog posting

Tick Post to eLog in the toolbar to log to the current experiment's eLog. Login mirrors hutch-python: ~/.web.cfg ([DEFAULT] user= / pw=, present for operator accounts such as mfxopr) if it exists, otherwise the Kerberos ticket of the account running MotorMemory. What gets posted:

  • every move, posted once the motors have settled, with from / target / final readback per motor and any skipped motors (60 s timeout);
  • Capture current, Update from live, paste of new rows, duplicate / delete rows, add / remove motor columns, create / rename / delete tables (posted immediately);
  • typed or pasted edits (values, names, notes, column names, tolerance), grouped into one post per table after 5 s without further changes.

Tags: motormemory and the table name. The instrument comes from --hutch MFX (or $MOTORMEMORY_HUTCH), else from the first motor's PV prefix. Posting runs in the background; failures appear in the status bar (first one as a popup).

Running

Beamline (PCDS conda, pyca/psp backend - same env as camviewer)

./run_motormemory.sh [--file /path/to/presets.json] [--hutch MFX]

S3DF development (ana conda, pyepics backend) with a fake IOC

./run_dev.sh --ioc --count 3      # terminal 1: SIM:MMS:01..03
./run_dev.sh                      # terminal 2: GUI
QT_QPA_PLATFORM=offscreen ./run_dev.sh ; python test_gui.py   # headless smoke test

pv_backend.py picks pyca/psp if importable, otherwise pyepics. The CA backend in use is shown in the status bar at startup.

Files

File Purpose
motormemory.py entry point / argument parsing
main_window.py tabs, toolbar, autosave
table_widget.py one table: motor columns, LIVE row, presets, paste, restore dialog
motor.py Motor QObject: motor-record fields -> Qt signals
pv_backend.py pyca/psp or pyepics wrapper with a common API
presets_model.py data model + atomic JSON persistence + paste parsers
elog_poster.py eLog client wrapper (background thread) + post formatting
sim_ioc.py caproto soft IOC with fake motors for testing
test_gui.py headless end-to-end test against the sim IOC
docs/MotorMemory-confluence.md user documentation (paste into Confluence via Insert > Markup > Markdown)

File format

{"version": 1, "tables": [
  {"name": "Sample stage",
   "motors": ["MFX:DG1:MMS:01", "MFX:DG1:MMS:02"],
   "id": "3f2a9c1b7d4e",
   "aliases": ["Sample X", null],
   "tolerance": null,
   "move_mode": "sequential",
   "presets": [{"name": "Pos A", "values": [1.0, null], "note": "", "saved": "2026-11-02 10:12:00"}]}]}

move_mode is sequential (default, also when the key is missing) or parallel. id is a stable identifier used to remember each table's window position. null in values means "no value for this motor" (skipped on move); null in aliases means "show the PV name".

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages