Developer Guide

Contributing

lsst.ts.standardscripts is developed at https://github.com/lsst-ts/ts_standardscripts. You can find Jira issues for this package using project=DM and labels=ts_standardscripts.

Python API reference

lsst.ts.standardscripts Package

Functions

format_as_list(value, recurrences)	Reformat single instance of the attribute value as a list with a specified number of recurrences .
format_grid(axis1, axis2)	Format two input values into lists with the same lengths.
get_s3_bucket()	Generate an s3 bucket object.
get_scripts_dir()	Get the absolute path to the scripts directory.
get_topic_time_utc(topic)	Reformat a topic command time from TAI unix to UTC.

Classes

BaseBlockScript(index, descr[, help])	Extend BaseScript to add support for executing blocks.
BasePointAzEl(index, descr)	A base Script that implements pointing the telescope to a fixed Az/El/Rot position.
BaseScriptTestCase()	Base class for Script tests.
MuteAlarms(index)	Mute Watcher alarm(s) for a given amount of time.
PauseQueue(index)	A script to pause the script queue.
RunCommand(index)	Run a command from a CSC and, optionally, wait for an event once the command finishes.
SetSummaryState(index)	Set the summary state for one or more CSCs.
Sleep(index)	Sleep for a given amount of time.
SystemWideShutdown(index)	Discover all running CSCs and send them all to OFFLINE state.

Class Inheritance Diagram

lsst.ts.standardscripts.auxtel Package

Classes

CalSysTakeData(index)
EnableATTCS(index)	Enable all ATCS components.
EnableLATISS(index)	Enable all LATISS components.
LatissTakeSequence(index[, add_remotes])	Perform a sequence of exposures for a given set of instrument configurations.
OfflineATCS(index)	Put ATCS components in offline.
OfflineLATISS(index)	Put LATISS components in offline.
OffsetATAOS(index[, add_remotes])	Perform an ATAOS offset.
OffsetATCS(index[, add_remotes])	Perform an ATCS offset.
PointAzEl(index)	Auxiliary Telescope point_azel script.
PrepareForFlat(index)	Run prepare for flat on ATCS.
PrepareForOnSky(index)	Run ATTCS startup.
Shutdown(index)	Run ATTCS shutdown.
StandbyATCS(index)	Put ATCS components in standby.
StandbyLATISS(index)	Put LATISS components in standby.
Stop(index)	Stop telescope and dome.
StopTracking(index)	Stop telescope and dome tracking.
TakeImageLatiss(index)	Take a series of images with the ATCamera with set exposure times.
TakeStutteredLatiss(index)	Take a series of stuttered images with LATISS.
TrackTarget(index)	Execute a Slew/Track operation with the Auxiliary Telescope.
TrackTargetAndTakeImage(index[, add_remotes])	Track target and take image script.

Class Inheritance Diagram

lsst.ts.standardscripts.maintel Package

Classes

ApplyDOF(index)	Apply a DOF to the main telescope, either bending mode or hexapod offset.
BaseBlockScript(index, descr[, help])	Extend BaseScript to add support for executing blocks.
BaseCloseLoop([index, descr])	Closed loop script.
CameraSetup(camera, config, identifier[, ...])	Encapsulates camera object, its configuration, and a unique identifier.
CloseLoopComCam(index[, descr])	Run Closed Loop with ComCam.
CloseLoopLSSTCam(index[, descr])	Run closed loop with LSSTCam.
DisableHexapodCompensationMode(index)	Disable compensation mode for M2 and/or Camera Hexapods.
EnableComCam(index)	Enable all ComCam components.
EnableHexapodCompensationMode(index)	Enable compensation mode for M2 and/or Camera Hexapods.
EnableMTCS(index)	Enable all MTCS components.
HomeBothAxes(index[, add_remotes])	Home azimuth and elevation axes of the MTMount.
MTCS([domain, log, intended_usage])	High level library for the Main Telescope Control System
MoveP2P(index)	Move Telescope using point to point trajectory instead of traditional slew/tracking.
OfflineComCam(index)	Put ComCam components in offline.
OfflineMTCS(index)	Put MTCS components in offline.
OffsetCameraHexapod(index[, add_remotes])	Perform a camera hexapod offset.
OffsetMTCS(index[, add_remotes])	Perform an MTCS offset.
PointAzEl(index)	Main Telescope point_azel script.
ScriptState(value[, names, module, ...])	ScriptState constants.
SetupMTCS([index, remotes])	Setup MTCS components so they are ready for operation.
StandbyComCam(index)	Put ComCam components in standby.
StandbyMTCS(index)	Put MTCS components in standby.
Stop(index)	Stop telescope and dome.
StopRotator(index)	A script that executes stop_rotator method for MTCS
TakeImageAnyCam(index)	A script for taking images concurrently with ComCam, LSSTCam, and/or one or more Generic Cameras.
TakeImageComCam(index)	Take images with ComCam.
TakeImageLSSTCam(index)	Take images with LSSTCam.
TrackTarget(index)	Execute a Slew/Track operation with the Main Telescope.
TrackTargetAndTakeImageComCam(index[, ...])	Track target and take image script.
TrackTargetAndTakeImageGenCam(index[, ...])	Track target and take image script with one more Generic Cameras.

Class Inheritance Diagram