Skip to content

Commit

Permalink
updated docs on cacao-calib scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredmales committed Nov 15, 2024
1 parent e1d0448 commit 6f4c16f
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 3 deletions.
3 changes: 2 additions & 1 deletion AOloopControl/scripts/cacao-calib-apply
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
# Usage: cacao-calib-apply cal_name
#
# This script must be run in `loop-name-rootdir`. Here cal_name corresponds to a directory
# in ``../loop-name-calibs`. Note this is not the whole path, just the directory name.
# in `../loop-name-calibs`. Note this is not the whole path, just the directory name including
# the timestamp appended by cacao-calib-archive.
#
# The following steps are performed:
# 1. The loop is turned off
Expand Down
31 changes: 29 additions & 2 deletions AOloopControl/scripts/cacao-calib-archive
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
#!/usr/bin/env bash

#######################################################################################
# Script to archive a CACAO loop calibration.
#
# Usage: cacao-calib-arhchive cal_name
#
# This script must be run in `loop-name-rootdir`. Here cal_name corresponds to a descriptive name
# of the calibration. A timestamp will be apended to it, and the result is used to create a directory
# in ``../loop-name-calibs`.
#
# The time stamp appendage can be suppressed with -u for update.
#
# The following files are copied to the cal directory.
# conf/CMmodesDM/CMmodesDM.fits
# conf/CMmodesWFS/CMmodesWFS.fits
# conf/RMmodesWFS/zrespM-H.fits
# conf/wfsref.fits
# conf/wfsmap.fits
# conf/wfsmask.fits
# conf/dmmap.fits
# conf/dmmask.fits
# LOOPNAME
#
# Additionally a file named calib_dir.txt is created which holds the directory path (useful for
# dereferencing symlinks).
#
# The file calib_archived.txt is updated with the current time, and a log entry is made.
#
##########################################################################################################

MSdescr="Archive AO calibration"

MSextdescr="Copy current filesystem calibration to ../CACAO_LOOPNAME-AOcalibs/<calibname>/ directory
Expand All @@ -16,8 +45,6 @@ RequiredFiles=()

RequiredDirs=(conf)



MSarg+=( "calibname:string:calibration name" )
MSopt+=( "u:update:setupdate::update existing, do not append timestamp" )

Expand Down

0 comments on commit 6f4c16f

Please sign in to comment.