https://www.quatm.com/en/docs/experiment-framework/Recent content in Experiment framework on QuatmHugoenhttps://www.quatm.com/en/docs/experiment-framework/data-widgets/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/data-widgets/Overview quatm/GUI/widgets/arg_boxes.py provides data widgets: a family of input boxes that present experiment parameters as editable controls. FloatBox / BoolBox / ComboBox and the other widgets subclass the corresponding manager (FloatManager / BoolManager / ComboManager), carry a unit, range and step, and write a changed value straight back to the attribute (including last_set); they are used by the parameter grid of the experiment window and by the parameter system.https://www.quatm.com/en/docs/experiment-framework/base-window-widgets/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/base-window-widgets/Overview quatm/GUI/widgets/quatmQt.py provides the GUI base widget classes: BWidget / BFrame / BMainWindow are the base classes of the various windows/panels/main windows (with a property namespace _props, saving the geometry to QSettings on close and restoring it on start-up); SearchComboBox and others provide searchable combo boxes with autocompletion and filtering. Components Component Description BWidget Base QWidget (properties + geometry persistence) BFrame Base QFrame BMainWindow Base main window (QMainWindow + title/geometry persistence) CustomCompleter Completer supporting contains / begins matching SearchComboBox Searchable combo box (with a built-in SearchLineEdit) SearchLineEdit Custom line edit of SearchComboBox (select all on focus, Esc restores) Usage from quatm.https://www.quatm.com/en/docs/experiment-framework/sequence-editor/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/sequence-editor/Overview quatm/GUI/editors/editor_sequencer.py provides the sequence editor (edit and simulate): the CodeEditorParser composite window combines the CodeEditor code editor on the left with the sequence visualisation on the right; after editing an experiment script you can simulate a run with one click and the timing of the individual output channels is drawn as step plots. Components Component Description CodeEditor Code editor: line numbers, Python highlighting, automatic indentation and completion PythonHighlighter / LineNumberArea Syntax highlighting / line-number margin ExperimentParser Parses an experiment: buildExperiment / simulateExperiment return the command stack ExperimentSequencer Draws the sequence over time as a step plot for each output channel CodeEditorParser Composite window: Save / Simulate / Clear toolbar + dock layout Usage from quatm.https://www.quatm.com/en/docs/experiment-framework/experiment-run-manager/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/experiment-run-manager/Overview quatm/GUI/experiment/experiment_manager.py provides the experiment run manager (ExperimentManager): the engine that takes tasks out of the experiment queue and executes them. The queue polling runs in a worker thread, and tasks are scheduled in the hierarchy measurement (measurement) → repetition (repetition) → sequence/scan (sequence) → single run (run). Key methods Method Description queue_fn Continuously polls the task dictionary: picks tasks by priority, task number and reservation time run Task-run wrapper: guarantees teardown however the task ends pause Pauses / resumes the current experiment terminate_experiment Graceful termination: lets the current run finish naturally before stopping start_measurement / start_sequence / end_sequence / end_measurement Hooks for the individual experiment stages set_dict Writes a single parameter to an attribute of the experiment object set_run_nr / set_rep_nr Synchronises the run / repetition number start_queue / shutdown Starts / stops the resident queue worker Usage from quatm.https://www.quatm.com/en/docs/experiment-framework/experiment-browser/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/experiment-browser/Overview quatm/GUI/browser/ provides the experiment browser (Browser): the main application window of Quatm, built on QMainWindow + QMdiArea. The FileSelector on the left browses the experiment scripts, the experiment queue, preparation station and looper are docked at the top, and each experiment has its own ExperimentWindow sub-window in the central MDI area. Core components Component Module Description Browser browser/main_window.py Main window: MDI + dock widgets + lifecycle FileSelector browser/file_selector.py Experiment file tree (double-click to open/simulate) ExperimentWindow browser/experiment_window.https://www.quatm.com/en/docs/experiment-framework/experiment-queue-manager/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/experiment-queue-manager/Overview quatm/GUI/experiment/experiment_queue.py provides the experiment queue manager (ExperimentQueue ): it shows the task queue as a table (the task dictionary expDict, keyed by task number) and supports priority sorting, state tracking and controls such as pause/terminate/delete. submit() is the only enqueueing entry point on the GUI thread (task numbers are allocated centrally, and the Looper also goes through it via the submitItem signal). Key methods Method Description submit The single enqueueing entry point: allocates task numbers centrally pause Pauses/resumes the currently running experiment set_sleeping Sets a task to Sleeping / Queued (reserved execution) terminate_clicked / terminate_all Gracefully terminates the selected / all tasks (Termination Pending) delete_item / delete_clicked Deletes a task (graceful termination if it is running) update_item Refreshes the row of a task set_model Replaces the table model (ScheduleModel) Task-state enumeration: Queued / Waiting / Sleeping / Running / Paused / Scanning / Terminating / Termination Pending / Done / Failed.https://www.quatm.com/en/docs/experiment-framework/worker-task-manager/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/worker-task-manager/Overview quatm/GUI/widgets/browser_workers.py provides the worker task manager: Worker subclasses QRunnable and executes a callback in the QThreadPool thread pool, then sends finished / error / result / progress signals back to the main thread via WorkerSignals. It is used by the experiment browser (experiment queue, looper, etc.); the isomorphic helper_workers is used by alignment/auxiliary tools. Components Component Description Worker QRunnable worker thread: setup, execution and teardown (including exception handling) WorkerSignals Worker-thread signals: finished / error / result / progress, etc.https://www.quatm.com/en/docs/experiment-framework/auto-save-editor/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/auto-save-editor/Overview quatm/GUI/editors/auto_save_editor.py provides the auto-save editor (AutoSaveEditor): a popup dialog for editing the “list of points in time” of the periodic HDF5 auto-save, where every row is one (tick mark + date/time) pair and a ticked row triggers one auto-save at the corresponding instant. The configuration is stored in a property (such as regular_auto_save_times). Components Component Description AutoSaveEditor Auto-save point-in-time editor (BWidget popup) DateTimeWidget Single-row date/time + tick widget Key methods Method Description load_AutoSaveEditor_props Reads the date/times and tick states from the properties (static) update_props Writes the date/times and tick states back to the properties (static) update_datetime / update_ticked Updates when the date/time / tick state of a row changes accept Saves the changes and closes the window Usage from quatm.https://www.quatm.com/en/docs/experiment-framework/timeline-viewer/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/timeline-viewer/Overview quatm/GUI/entries/experiment_timeline.py provides the timeline viewer (Timeline): it loads an experiment-timing JSON file (experiment.json), plots the variation over time of each DAC/TTL output channel as a step subplot, and the output-channel check panel determines which curves are visible; it is used to debug and verify the experiment timing. Components Component Description Timeline Timing-viewer main window: file loading, plotting and channel control TimelinePlotter Timing-visualisation widget: draws the state of every output in use over time SelectorWidget Output-channel check panel: select all / select none Key methods (Timeline) Method Description load_file Loads and parses the timing JSON, builds the time series and refreshes the channel selector plot_experimental_sequence Creates an individual subplot per output according to the channel selection and draws a step plot decode_ttl_bitmask Splits a 32-bit TTL bitmask into set/clear commands for the individual channels construct_time_sequences Converts the step-wise timing into times/vals sequences organised per channel reverse_device_db_transformation Reverse device-database transformation: maps internal names back to readable names Usage from quatm.https://www.quatm.com/en/docs/experiment-framework/multithreaded-worker-framework/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/multithreaded-worker-framework/Overview quatm/GUI/widgets/helper_workers.py (and the isomorphic browser_workers.py) provides the multithreaded worker framework: Worker subclasses QRunnable and puts an arbitrary callback function into the QThreadPool thread pool for execution, and returns the result to the GUI main thread through WorkerSignals using finished / error / result / progress signals. browser_workers: used by the experiment browser (experiment queue, looper, etc.); helper_workers: used by alignment/auxiliary and similar tools. Components Component Description Worker QRunnable worker thread: setup, execution and teardown (including exception handling) WorkerSignals Signals a worker thread can emit: finished / error / result / progress, etc.https://www.quatm.com/en/docs/experiment-framework/loop-manager/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/loop-manager/Overview quatm/GUI/looper/ provides the loop manager (Looper): task entries are organised as “loop groups (tabs)”, the entries of a group are executed in order, and the jumps or termination are decided from measurement results. LoopManager runs the loop in a background thread; the loop definition is persisted in loopfile.json and shared with the web remote-control platform. Core logic LoopManager.run_loop(): start from the first group, loop indefinitely until terminate └─→ execute the entries of the group in order ├─ Task: submit to the experiment queue, advance once complete (maximum count configurable) └─ Conditional: read data-stream fields and compare → jump if satisfied / else branch otherwise Components Component Description LoopGroup Loop group (one tab) TaskItem / ListItem Task entry / task-list entry ConditionalItem etc.https://www.quatm.com/en/docs/experiment-framework/preparation-queue-manager/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/preparation-queue-manager/Overview quatm/GUI/widgets/models.py provides base classes that map Python dictionaries / lists onto Qt table models (derived from the ARTIQ models). The preparation queue (preparation station) uses the list-type PrepModel: prepared tasks need no unique ID and their order can be changed freely; the experiment queue uses the dictionary-type ScheduleModel (sorted by priority, then by task number). Core classes Class Description _SyncSubstruct Helper wrapping the dictionary operations of the underlying container (append/insert/pop callbacks refresh) DictSyncModel Dictionary → table model base class ListSyncModel List → table model base class ScheduleModel Experiment queue (ExperimentQueue) model: tasks sorted by priority/task number PrepModel Preparation queue (PrepStation) model: list type, order adjustable Concrete business models implement three hooks in a subclass: convert (key/value/column to cell content), sort_key (sorting key) and flags (edit flags).https://www.quatm.com/en/docs/experiment-framework/experiment-run-scheduler/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/experiment-run-scheduler/Overview Experiment run scheduling is accomplished by the experiment queue and the execution engine working together: submit() of the ExperimentQueue is the only enqueueing entry point on the GUI thread (task numbers are allocated centrally, and the preparation station and looper also enqueue through it); the resident worker polls the task dictionary in ExperimentManager.queue_fn and selects and executes tasks by priority → task number → reservation time (due_check) (measurement → sequence → run).https://www.quatm.com/en/docs/experiment-framework/experiment-preparation/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/experiment-preparation/Overview quatm/GUI/experiment/prepstation.py provides experiment preparation (PrepStation): the preparation station in the dock at the top of the experiment browser, used for staging and editing tasks before they are sent to the experiment queue. The task list is displayed with a PrepModel table (its order can be changed freely) and persisted to prepfile.json. Key methods Method Description push / push_row / push_first Pushes the selected/designated/first task to the experiment queue push_to_looper Pushes the selected task to the looper move_up / move_down Changes the order of tasks delete_clicked / set_sleeping Deletes / sleeps a task open_editor / open_viewer / save_params Edits parameters, views parameters, saves them as JSON update_prep_file Saves the task list to prepfile.https://www.quatm.com/en/docs/experiment-framework/process-manager/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/process-manager/Overview quatm/GUI/entries/processmanager.py provides the process manager: it reads the configuration grouped as Servers / Driver / GUI / Viewer / Monitor and generates a SingleProcess start/stop button panel for every script entry, managing the whole set of experiment-software processes in one place. A process is started with the current interpreter, either as a script or as a module (python -m), and carries the project root and the parent-process watchdog environment.https://www.quatm.com/en/docs/experiment-framework/experiment-parameter-manager/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/experiment-parameter-manager/Overview quatm/GUI/entries/dashboard.py provides the experiment parameter manager: DefaultExp is the experiment base class that aggregates the attributes of all devices (build() walks the device database and groups them by type), and the per-type parameter managers (BasicManager / IntManager / FloatManager / BoolManager / ComboManager / FrequencyManager) generate input widgets with unit/range from the parameter declarations; the Dashboard panel presents the device groups as editable default-parameter sections. Components Component Description DefaultExp Default experiment: aggregates all device attributes and groups them by device Dashboard Default-parameter panel: generates parameter widgets grouped by device BasicManager etc.https://www.quatm.com/en/docs/experiment-framework/run-monitor/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/run-monitor/Overview quatm/GUI/streammonitor/ provides the run monitor: MainWindow hosts monitoring tabs for data streams (Data), image streams (Image), commands (Command), the message log (Message) and history (History); each monitoring tab consists of a StreamMonitor that subscribes to a single data stream and displays it in real time. Components Component Description MainWindow Monitoring main window: multi-tab container + menu StreamMonitor Single-stream monitoring panel: subscribes to one data stream and displays it in real time MessageTableModel Message-log table model (timestamp/source/level/content, coloured by level) ImageTableModel Image-stream metadata table (fixed time/source columns + dynamic key columns) Usage from quatm.https://www.quatm.com/en/docs/experiment-framework/collapsible-sections/Mon, 01 Jan 0001 00:00:00 +0000https://www.quatm.com/en/docs/experiment-framework/collapsible-sections/Overview quatm/GUI/widgets/theexpandables.py provides collapsible section components: CollapsibleDialog (a QDialog subclass) organises several collapsible sections with a QTreeWidget whose header is hidden; each section header is a SectionExpandButton button, and clicking it expands/collapses the corresponding content. Components Component Description SectionExpandButton Button that expands/collapses a section (QPushButton) CollapsibleDialog Base class for dialogs to which collapsible sections can be added Key methods (CollapsibleDialog) Method Description define_sections Override this method to define all sections as (title, widget) tuples add_section Add one collapsible section add_button / add_widget Create a top-level entry containing a button / attach a content widget Usage from quatm.