From 6f4c16fa64c53ed9e98ac0706197d096f3d81e35 Mon Sep 17 00:00:00 2001
From: Jared Males <jrmales@arizona.edu>
Date: Thu, 14 Nov 2024 22:06:42 -0700
Subject: [PATCH] updated docs on cacao-calib scripts

---
 AOloopControl/scripts/cacao-calib-apply   |  3 ++-
 AOloopControl/scripts/cacao-calib-archive | 31 +++++++++++++++++++++--
 2 files changed, 31 insertions(+), 3 deletions(-)

diff --git a/AOloopControl/scripts/cacao-calib-apply b/AOloopControl/scripts/cacao-calib-apply
index beb45531..3af7ddd7 100755
--- a/AOloopControl/scripts/cacao-calib-apply
+++ b/AOloopControl/scripts/cacao-calib-apply
@@ -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
diff --git a/AOloopControl/scripts/cacao-calib-archive b/AOloopControl/scripts/cacao-calib-archive
index b50ba788..be70f017 100755
--- a/AOloopControl/scripts/cacao-calib-archive
+++ b/AOloopControl/scripts/cacao-calib-archive
@@ -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
@@ -16,8 +45,6 @@ RequiredFiles=()
 
 RequiredDirs=(conf)
 
-
-
 MSarg+=( "calibname:string:calibration name" )
 MSopt+=( "u:update:setupdate::update existing, do not append timestamp" )