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

Standard Scripts Core

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])	(Deprecated) 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.scheduler Package

Classes

SetDesiredState(index, descr, ...)

A base script that implements setting the desired state for the Scheduler.

Class Inheritance Diagram

lsst.ts.standardscripts.calibration Module

OCS Script Classes

lsst.ts.standardscripts.data.scripts.ocs.scheduler.add_block Module

Classes

AddBlock(index, scheduler_index)	A base script that implements loading BLOCKS to the Scheduler.
OCSSchedulerAddBlock(index)	Add BLOCK to the OCSScheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.ocs.scheduler.enable Module

Classes

Enable(index, scheduler_index)	A base script that implements enable functionality for the Scheduler.
OCSSchedulerEnable(index)	Enable the OCS Scheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.ocs.scheduler.load_snapshot Module

Classes

LoadSnapshot(index, scheduler_index)	A base script that implements loading snapshots for the Scheduler.
OCSSchedulerLoadSnapshot(index)	Load snapshot for OCS Scheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.ocs.scheduler.resume Module

Classes

OCSSchedulerResume(index)	Resume OCS Scheduler.
Resume(index, scheduler_index)	A base script that implements resuming the Scheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.ocs.scheduler.standby Module

Classes

OCSSchedulerStandby(index)	Send OCS Scheduler to STANDBY state.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.
SetDesiredState(index, descr, ...)	A base script that implements setting the desired state for the Scheduler.

lsst.ts.standardscripts.data.scripts.ocs.scheduler.stop Module

Classes

OCSSchedulerStop(index)	Stop OCS Scheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.
Stop(index, scheduler_index)	A base script that implements resuming the Scheduler.

Auxiliary Telescope Standardscripts

lsst.ts.auxtel.standardscripts Package

Classes

CalSysTakeData(index)
DisableATAOSCorrections(index)	Disable ATAOS corrections as a stand alone operation.
EnableATAOSCorrections(index)	Enable ATAOS corrections as a stand alone operation.
EnableATTCS(index)	Enable all ATCS components.
EnableLATISS(index)	Enable all LATISS components.
FocusSweepLatiss(index[, descr])	Perform a focus sweep by taking images at different focus positions with LATISS.
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.auxtel.standardscripts.atdome Package

Classes

CloseDome(index)	Run close dome on ATCS.
CloseDropoutDoor(index)	Run close dropout door on ATCS.
DisableDomeFollowing(index)	Run disable dome following on ATCS.
EnableDomeFollowing(index)	Run enable dome following on ATCS.
HomeDome(index)	Run home dome on ATCS.
OpenDome(index)	Run open dome shutter on ATCS.
OpenDropoutDoor(index)	A SAL script for opening the dropout door of the Auxiliary Telescope's dome based on current wind conditions as reported by the Environmental Sensor Suite 301 (ESS 301).
SlewDome(index)	Run slew dome on ATCS.

Class Inheritance Diagram

lsst.ts.auxtel.standardscripts.calibrations Package

Classes

PowerOffATCalSys(index[, add_remotes])	Powers off the ATCalSys dome flat illuminator turning white lamp off, closing the shutter and stopping the chiller.
PowerOnATCalSys(index[, add_remotes])	Powers on the ATCalSys dome flat illuminator (ATWhiteLight and ATMonochromator) required to perform image calibrations over white light.
RunCalibrationSequence(index)	Run calibration sequence with LATISS using ATCalSys.

Class Inheritance Diagram

lsst.ts.auxtel.standardscripts.daytime_checkout Package

Classes

ATPneumaticsCheckout([index])	Pneumatics Checkout SAL Script.
LatissCheckout([index, add_remotes])	DayTime LATISS Checkout SAL Script.
SlewAndTakeImageCheckout([index, add_remotes])	DayTime Slew and Take Image Checkout SAL Script.
TelescopeAndDomeCheckout([index, add_remotes])	DayTime Checkout SAL Script.

Class Inheritance Diagram

lsst.ts.auxtel.standardscripts.detector_characterization Package

Classes

ATGetStdFlatDataset(index)

Implement script to get sensor characterization data.

Class Inheritance Diagram

lsst.ts.auxtel.standardscripts.prepare_for Package

Classes

PrepareForCO2Cleanup(index)	Put AT in CO2 cleanup position.
PrepareForFlat(index)	Run prepare for flat on ATCS.
PrepareForOnSky(index)	Run ATTCS startup.
PrepareForVent(index[, remotes])	Run prepare for vent on ATCS.

Class Inheritance Diagram

AuxTel Scheduler Scripts

lsst.ts.standardscripts.data.scripts.auxtel.scheduler.add_block Module

Classes

ATSchedulerAddBlock(index)	Add BLOCK to the ATScheduler.
AddBlock(index, scheduler_index)	A base script that implements loading BLOCKS to the Scheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.auxtel.scheduler.enable Module

Classes

ATSchedulerEnable(index)	Enable the ATScheduler.
Enable(index, scheduler_index)	A base script that implements enable functionality for the Scheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.auxtel.scheduler.load_snapshot Module

Classes

ATSchedulerLoadSnapshot(index)	Load snapshot for ATScheduler.
LoadSnapshot(index, scheduler_index)	A base script that implements loading snapshots for the Scheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.auxtel.scheduler.resume Module

Classes

ATSchedulerResume(index)	Resume ATScheduler.
Resume(index, scheduler_index)	A base script that implements resuming the Scheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.auxtel.scheduler.standby Module

Classes

ATSchedulerStandby(index)	Send ATScheduler to STANDBY state.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.
SetDesiredState(index, descr, ...)	A base script that implements setting the desired state for the Scheduler.

lsst.ts.standardscripts.data.scripts.auxtel.scheduler.stop Module

Classes

ATSchedulerStop(index)	Stop ATScheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.
Stop(index, scheduler_index)	A base script that implements resuming the Scheduler.

Main Telescope Standardscripts

lsst.ts.maintel.standardscripts Package

Classes

ApplyDOF(index)	Apply a DOF to the main telescope, either bending mode or hexapod offset.
BaseBlockScript(index, descr[, help])	(Deprecated) 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.
ChangeFilterLSSTCam(index)	Change filter of the LSSTCam.
CloseLoopComCam(index[, descr])	Run Closed Loop with ComCam.
CloseLoopLSSTCam(index[, descr])	Run closed loop with LSSTCam.
CloseMirrorCovers(index)	Run open mirror covers on MTCS.
CscEndOfNight(index)	Send MTCS and LSSTCam CSCs to End Of Night State.
DisableAOSClosedLoop(index)	Disable AOS Closed Loop task to run in parallel to survey mode imaging.
DisableHexapodCompensationMode(index)	Disable compensation mode for M2 and/or Camera Hexapods.
EnableAOSClosedLoop(index)	Enable AOS Closed Loop task to run in parallel to survey mode imaging.
EnableComCam(index)	Enable all ComCam components.
EnableHexapodCompensationMode(index)	Enable compensation mode for M2 and/or Camera Hexapods.
EnableLSSTCam(index)	Enable all LSSTCam components.
EnableMTCS(index)	Enable all MTCS components.
EndOfNightConfig()	The End-of-Night configurations for desired states
FocusSweepComCam(index[, descr])	Perform a focus sweep by taking images at different focus positions with ComCam.
FocusSweepLSSTCam(index[, descr])	Perform a focus sweep by taking images at different focus positions with LSSTCam.
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 or reset operation.
OffsetM2Hexapod(index[, add_remotes])	Perform a m2 hexapod offset or reset operation..
OffsetMTCS(index[, add_remotes])	Perform an MTCS offset.
OpenMirrorCovers(index)	Run open mirror covers on MTCS.
PointAzEl(index)	Main Telescope point_azel script.
ScriptState(value[, names, module, ...])	ScriptState constants.
SetDOF(index)	Set absolute positions DOF to the main telescope, either bending mode or hexapod position.
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
TakeAOSSequenceComCam(index[, descr])	Take aos sequence with ComCam.
TakeAOSSequenceLSSTCam(index[, descr])	Take aos sequence with LSSTCam.
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.
TakeStutteredComCam(index)	Take a series of stuttered images with ComCam.
TakeStutteredLSSTCam(index)	Take a series of stuttered 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.
TrackTargetAndTakeImageLSSTCam(index[, ...])	Track target and take image script.

Class Inheritance Diagram

lsst.ts.maintel.standardscripts.calibration Package

Classes

PowerOffTunableLaser(index)	Stope the propagation of the Tunable Laser for functional testing.
PowerOnTunableLaser(index)	Starts propagating the Tunable Laser for functional testing.

Class Inheritance Diagram

lsst.ts.maintel.standardscripts.laser_tracker Package

Classes

Align(index)	Align component using laser tracker.
AlignComponent(value[, names, module, ...])
Measure(index[, add_remotes])	Measure component using laser tracker.
SetUp(index[, add_remotes])	Set up Laser Tracker.
ShutDown(index[, add_remotes])	Shut down Laser Tracker.

Class Inheritance Diagram

lsst.ts.maintel.standardscripts.m1m3 Package

Classes

CheckActuators(index)	Perform a M1M3 bump test on either a selection of individual actuators or on all actuators.
CheckHardpoint(index[, add_remotes])	Check M1M3 Individual hardpoint breakaway.
DisableM1M3BalanceSystem(index)	Disable M1M3 force balance system.
EnableM1M3BalanceSystem(index)	Enable M1M3 force balance system.
EnableM1M3SlewControllerFlags(index)	Set M1M3 Slew Controller Settings for the main telescope.
LowerM1M3(index)	Lower M1M3 mirror.
RaiseM1M3(index)	Raise M1M3 mirror.

Class Inheritance Diagram

lsst.ts.maintel.standardscripts.m2 Package

Classes

CheckActuators(index)	Perform a M2 bump test on either a selection of individual actuators or on all axial actuators.
DisableM2ClosedLoop(index)	Disable M2 closed-loop.
EnableM2ClosedLoop(index)	Enable M2 closed-loop.

Class Inheritance Diagram

lsst.ts.maintel.standardscripts.mtdome Package

Classes

CloseDome(index)	Close MTDome shutter door.
CrawlAz(index)	Script that makes the MTDome crawl.
Direction(value[, names, module, qualname, ...])
DisableDomeFollowing(index)	Disable Dome Following for the MTDome.
EnableDomeFollowing(index)	Enable Dome Following for the MTDome.
HomeDome(index[, add_remotes])	Home azimuth of the MTDome.
OpenDome(index)	Open MTDome shutter door.
ParkDome(index)	Park Dome for the MTDome.
SlewDome(index)	Slew main telescope dome to desired azimuth.
UnparkDome(index)	Unpark Dome for the MTDome.

Class Inheritance Diagram

lsst.ts.maintel.standardscripts.mtmount Package

Classes

ParkMount(index)	Park Mount for the MTMount.
UnparkMount(index)	Un-park Mount for the MTMount.

Class Inheritance Diagram

lsst.ts.maintel.standardscripts.mtrotator Package

Classes

MoveRotator(index)

Move the rotator to a given angle.

Class Inheritance Diagram

lsst.ts.maintel.standardscripts.prepare_for Package

Classes

PrepareForAlign(index[, add_remotes])

Run prepare for align on MTCS.

Class Inheritance Diagram

MainTel Scheduler Scripts

lsst.ts.standardscripts.data.scripts.maintel.scheduler.add_block Module

Classes

AddBlock(index, scheduler_index)	A base script that implements loading BLOCKS to the Scheduler.
MTSchedulerAddBlock(index)	Add BLOCK to the MTScheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.maintel.scheduler.enable Module

Classes

Enable(index, scheduler_index)	A base script that implements enable functionality for the Scheduler.
MTSchedulerEnable(index)	Enable the MTScheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.maintel.scheduler.load_snapshot Module

Classes

LoadSnapshot(index, scheduler_index)	A base script that implements loading snapshots for the Scheduler.
MTSchedulerLoadSnapshot(index)	Load snapshot for MTScheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.maintel.scheduler.resume Module

Classes

MTSchedulerResume(index)	Resume MTScheduler.
Resume(index, scheduler_index)	A base script that implements resuming the Scheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.standardscripts.data.scripts.maintel.scheduler.standby Module

Classes

MTSchedulerStandby(index)	Send MTScheduler to STANDBY state.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.
SetDesiredState(index, descr, ...)	A base script that implements setting the desired state for the Scheduler.

lsst.ts.standardscripts.data.scripts.maintel.scheduler.stop Module

Classes

MTSchedulerStop(index)	Stop MTScheduler.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.
Stop(index, scheduler_index)	A base script that implements resuming the Scheduler.