Developer Guide

The ScriptQueue CSC is implemented using ts_salobj.

API

The primary classes in ts_scriptqueue are:

• ScriptQueue: a Commandable SAL Component (CSC) to queue and run SAL scripts.

• QueueModel: a class that does most of the work for ScriptQueue.

lsst.ts.scriptqueue Package

Functions

configure_logging([verbose, console_format, ...])	Configure the logging for the system.
find_public_scripts(root)	Find all public scripts in the specified root path.
generate_logfile([basename])	Generate a log file name based on current time.
get_default_scripts_dir(is_standard)	Return the default directory for the specified kind of scripts.
parse_run_one_script_cmd([args])	Parse command-line arguments for run_one_script.
run_one_script(index, script, config[, loglevel])	Run one SAL script.
run_one_script_cli()	Use the command line to run one script.
run_script_queue()	Run the ScriptQueue CSC.

Classes

BlockInfo(log, block_id, block_size)	Information about a block.
BlockModel()	Manages block information.
QueueModel(domain, log, standardpath, ...[, ...])	Code to load and configure scripts; implementation for ScriptQueue.
ScriptInfo(log, remote, index, seq_num, ...)	Information about a loaded script.
ScriptQueue(index[, initial_state, ...])	CSC to load and configure scripts, so they can be run.
ScriptQueueCommander(script_log_level, **kwargs)	ScriptQueue command-line commander.

Class Inheritance Diagram

Build and Test

This is a pure python package. There is nothing to build except the documentation.

make_idl_files.py Script ScriptQueue
setup -r .
pytest -v  # to run tests
package-docs clean; package-docs build  # to build the documentation

Contributing

lsst.ts.ScriptQueue is developed at lsst-ts/ts_scriptqueue. Bug reports and feature requests use Jira with labels=ts_scriptqueue.