Implementation of 'autostart' mode, in which the queue is automatically started once plans are added to the queue or the manager becomes ready to execute plans (e.g. environment is opened). The autostart mode is enabled by calling queue_autostart API with the parameter enable=True and disabled by calling the same API with enable=False. The autostart mode is disabled automatically if the queue is stopped (using queue_stop queue instruction or queue_stop API) or a running plan was stopped, halted or aborted. The autostart mode is also disabled if the plan fails, unless the ignore_failures mode is enabled (see queue_mode API).
Another new feature was implemented after multiple request from beamline staff. In addition to run UUIDs, the worker is now collecting scan ID from start documents. The scan IDs are returned in the list of runs (re_runs API) and included in the history returned by history_get API. The scan IDs may be useful in monitoring GUI widgets, since many beamlines primarily use scan IDs to identify runs.
Description
Motivation and Context
The implemented features were requested by beamline staff.
Summary of Changes for Release Notes
Fixed
Added
New queue_autostart API (enable/disable 'autostart' mode by passing True/False with the enable parameter).
New queue_autostart_enabled status parameter, which indicates if the queue is in the 'autostart' mode.
CLI options to enable/disable autostart: qserver queue autostart enable/disable.
Each item in the list of current runs (re_runs API) now contains scan_id (integer) of the current scan.
The history items (history_get API) now contains a list of scan IDS (scan_ids, list(int)) in addition to the list of `uids'.
Implementation of 'autostart' mode, in which the queue is automatically started once plans are added to the queue or the manager becomes ready to execute plans (e.g. environment is opened). The autostart mode is enabled by calling
queue_autostartAPI with the parameterenable=Trueand disabled by calling the same API withenable=False. The autostart mode is disabled automatically if the queue is stopped (usingqueue_stopqueue instruction orqueue_stopAPI) or a running plan was stopped, halted or aborted. The autostart mode is also disabled if the plan fails, unless theignore_failuresmode is enabled (seequeue_modeAPI).Another new feature was implemented after multiple request from beamline staff. In addition to run UUIDs, the worker is now collecting scan ID from start documents. The scan IDs are returned in the list of runs (
re_runsAPI) and included in the history returned byhistory_getAPI. The scan IDs may be useful in monitoring GUI widgets, since many beamlines primarily use scan IDs to identify runs.Description
Motivation and Context
The implemented features were requested by beamline staff.
Summary of Changes for Release Notes
Fixed
Added
New
queue_autostartAPI (enable/disable 'autostart' mode by passingTrue/Falsewith theenableparameter).New
queue_autostart_enabledstatus parameter, which indicates if the queue is in the 'autostart' mode.CLI options to enable/disable autostart:
qserver queue autostart enable/disable.Each item in the list of current runs (
re_runsAPI) now containsscan_id(integer) of the current scan.The history items (
history_getAPI) now contains a list of scan IDS (scan_ids,list(int)) in addition to the list of `uids'.Changed
Removed
How Has This Been Tested?
Detailed unit tests were implemented.