queueserver

The bluesky queueserver [1] manages sequencing and execution of Bluesky plans. It has a host process that manages a RunEngine. Client sessions will interact with that host process. See Configure the QS Host for more details.

Important

The queueserver requires a redis service [2] to be running. File ./qserver/qs-config.yml has settings to specify the redis service.

QS host – queueserver host process

Use the queueserver host management script. This option stops the server (if it is running) and then starts it. This is the usual way to (re)start the QS host process.

./qserver/qs_host.sh restart

queueserver client GUI

At this time, there is one GUI recommended for use with the bluesky queueserver. Other GUI clients are in development and show promise of improvements. For now, use this one.

queue-monitor &

Configure the QS Host

File qs-config.yml [3] contains all configuration of the QS host process. The source code contains lots of comments about the various settings. See the bluesky-queueserver documentation [4] for more details of the configuration.

The QS host process writes files into this directory. This directory can be relocated. However, it should not be moved into the instrument package since that might be installed into a read-only directory.

shell script qs_host.sh

A shell script qs_host.sh [5] is used to start the QS host process. Typically, it is run in the background: ./qserver/qs_host.sh restart. This command looks for a running QS host process. If found, that process is stopped. Then, a new QS host process is started in a screen [6] session.

 1(bstest) $ ./qserver/qs_host.sh help
 2Usage: qs_host.sh {start|stop|restart|status|checkup|console|run} [NAME]
 3
 4    COMMANDS
 5        console   attach to process console if process is running in screen
 6        checkup   check that process is running, restart if not
 7        restart   restart process
 8        run       run process in console (not screen)
 9        start     start process
10        status    report if process is running
11        stop      stop process
12
13    OPTIONAL TERMS
14        NAME      name of process (default: bluesky_queueserver-)

Alternatively, run the QS host’s startup command directly within the ./qserver/ subdirectory.

1cd ./qserver
2start-re-manager --config=./qs-config.yml