Background

The following tables list scripts that can be used to control OSIRIS and/or the telescope. These are useful for two things:

• As shortcuts, they can be entered on any napili command line to run the instrument in a command-line mode, as is done with NIRC2
• As building blocks in OSIRIS shell scripts which can perform complex operations.

These commands are always available from any OSIRIS account when logged into the OSIRIS workstation, napili.

---

Contents

• AO - Scripts for AO control
• CONTROL - Scripts for taking data
• OPERATIONS - Scripts for starting OSIRIS
• RUN - Scripts for keyword servers
• TEL - Scripts for telescope control
• TEMPLATE - Example scripts
• UTIL - Scripts for gathering information

---

OSIRIS Script Library

AO - Scripts for AO control

• ao2real -- disconnects AO simulator
• ao2sim -- puts AO system into simulate mode
• aodelay -- sets wfao delay time
• aohatch -- opens or closes the AO hatch cover
• osirisLGSMode -- temporary script for setting AO mode with LGS
• osirisRefocusAO -- change the AO focus to match sscale
• rotate -- move rotator and set mode
• setdar -- sets dar mode and tells wfao to wait/not wait for dar
• wait4ao -- sets wait for tip-tilt, deformable mirror, and DAR states
• wait4dar -- turns DAR offloading on/off
• wait4dm -- enables/disables waiting for deformable mirror loop closure
• wait4fsm -- waits for field steering mirror to complete move
• wait4tt -- enables/disables waiting for tip-tilt loop closure
• wfao -- waits for AO loops to close

CONTROL - Scripts for taking data

• ifilter --
• osirisAbortAfterSpec -- sets proper keyword so that osirisTakeDataset
• osirisAbortAll -- sets proper keyword so that osirisTakeDataset
• osirisAbortOnly -- aborts current IMAG or SPEC exposure in dataset
• osirisCoordI2S -- convert IMAG pixel coords to instrument coord (in ")
• osirisFlushDetector -- takes sufficient test frames to flush either
• osirisGetSetnum -- normal exit, no error
• osirisGoi -- takes OSIRIS data frames
• osirisHeaderPA -- calculates SPEC and IMAG PA's and updates OGS keywords
• osirisHomeMech -- normal exit, no error
• osirisMoveTel -- basic move telescope command for osiris (in instr coords)
• osirisPause -- pauses osirisTakeDataset after current SPEC exposure
• osirisRecover -- restart detector server without bothering other servers
• osirisResume -- resumes osirisTakeDataset after it has been paused
• osirisScriptCleanUp -- resets dataset script keywords in the OGS
• osirisScriptMsg -- a general purpose utility for reporting script
• osirisSetTargwave -- sets DCS targwave keywords based on filter
• osirisSetupMech -- configures OSIRIS IMAG or SPEC mechanisms for an exposure
• osirisTakeDarks -- takes a user-defined list of darks
• osirisTakeDataset -- coordinates dataset execution for OSIRIS
• osirisUnlockMech -- normal exit, no error
• ring_bell --
• sfilter --
• sscale --
• wfgo -- waits for an exposure to finish
• wfmech -- waits until all motors (SPEC or IMAG) are idle using OGS keywords
• wfready -- checks and waits for detector to be ready before starting exposure

OPERATIONS - Scripts for starting OSIRIS

• check_keywords --
• osirisConnect -- sets up OSIRIS software when instrument
• osirisDisconnect -- sets up OSIRIS software when instrument
• osirisEndCooldown -- sets OSIRIS up for a cooldown
• osirisEndNight --
• osirisSetupDataRoot -- Sets up a new OSIRIS_DATA_ROOT output data tree
• osirisSetupNight -- brief description of script function
• osirisSetupUser -- prepares instrument and environment for a new user
• osirisStartCooldown -- sets OSIRIS up for a cooldown
• osirisStartGuis -- normal exit, no error
• osirisStartWarmup -- sets OSIRIS up for a cooldown
• start_check_keywords --
• start_tklogger --
• stop_check_keywords --
• tklogger --

RUN - Scripts for keyword servers

• osiris -- base start/stop/restart script for servers, guis, etc.
• osiris_servers.csh.old --

TEL - Scripts for telescope control

• E --
• N --
• S --
• W --
• X --
• Y --
• az --
• azel --
• en --
• gomark --
• mark --
• xy --

TEMPLATE - Example scripts

• osirisTemplate -- brief description of script function
• osirisTemplateHeader -- brief description of script function

UTIL - Scripts for gathering information

• cabtemps -- print electronics cabinet temps to screen
• cryotemps -- print electronics cabinet temps to screen
• ct -- check tasks for running daemons and GUIs
• ctx -- check for missing servers and list GUIs
• dettemps --
• help -- prints help for each command
• help.cat --
• help.inc --
• lastimage --
• math -- performs simple math operations
• osirisCheckRPCInfo -- checks if specified service is already registered
• osirisCheckServer -- check if server is alive
• osirisCleanVncDir -- removes old .log, .pid, and .info files from ~/.vnc
• osirisGetCurDisplay -- echos the number of displays on the current host
• osirisGetHostname -- echos the number of displays on the current host
• osirisGetNumDisplays -- echos the number of displays on the current host
• osirisKeywords --
• osirisKillRPCEntry -- removes an entry from the RPC registry
• osirisLogTail --
• osirisRPCInfo --
• osirisStartVncServers -- start required VNC servers for observing
• round --
• temps --
• testAll -- confirm health of the instrument
• vnc --

---

Go to: OSIRIS Home Page - Instruments Home Page - Keck Home Page

---

Last modified: