DEIMOS user script save

Name

save_state -- store instrument settings for future restoration

Purpose

Generate a file listing the current INSTRUMENT settings. This file
is similar in form to the files generated by XHIRES. The
contents of the file can be parsed later by the restore_state
function in order to recover the original configuration. By
default, the data will be written to a file in the user's home
directory. The user can provide an optional file name to use
instead.

Usage

save_state [-all] [-detector] [-motors] [-info] [-fcs] [-tv] \
[-clobber] [-verbose] [save_file]

Flags

-(a)ll save all INSTRUMENT parameters except INFO keywords;
equivalent to -dmtf
-(d)etector save CCD parameters
-(m)otors save all motor settings
-(i)nfoman save INFOMAN-only keywords when saving
CCD settings; these include FRAMENO, OUTDIR,
OUTFILE, TODISK, OBJECT, OBSERVER
-(f)cs save flexure compensation system parameters
-(t)v save tv guider parameters
-(c)lobber clobber existing save file
-(v)erbose print diagnostic output

Arguments

save_file = name of the save file to generate. The default is
to create the file ~/.save_state.YYYY-MMM-DD

Output

Current INSTRUMENT settings are stored in the save file

Restrictions

- Unless the clobber flag is set, this script will not
overwrite an existing save file
- Hatch and lamp settings are never saved

Exit values

0 = normal completion
1 = wrong number of arguments

Example

1) Save detector and motor keywords to default file:
save_state

2) Save detector, motor and infoman keywords to default file:
save_state -i

3) Save detector, motor and infoman keywords to file ~/state1
save_state -i ~/state1

4) Overwrite existing default state file:
save_state -c