Merge pull request #273 from sot/fix-fetch-engarchive-break

Fix update scripts broken in #269 + unrelated docs fixes

Author: taldcroft

cheta/check_integrity.py

@@ -11,6 +11,7 @@
 import Ska.DBI
 import tables
 
+import cheta.remote_access
 from cheta import fetch
 
 opt = None
@@ -167,7 +168,9 @@ def main():
     # fetch.ENG_ARCHIVE.  Fetch is a read-only process so this is safe when
     # testing.
     if opt.data_root:
-        fetch.msid_files.basedir = ":".join([opt.data_root, fetch.ENG_ARCHIVE])
+        fetch.msid_files.basedir = ":".join(
+            [opt.data_root, cheta.remote_access.ENG_ARCHIVE]
+        )
 
     # Set up logging
     loglevel = pyyaks.logger.VERBOSE if opt.verbose else pyyaks.logger.INFO

cheta/derived/__init__.py

@@ -3,7 +3,7 @@
 Derived Parameters
 
 The engineering archive has pseudo-MSIDs that are derived via computation from
-telemetry MSIDs.  All derived parameter names begin with the characters "DP_"
+telemetry MSIDs.  All derived parameter names begin with the characters ``DP_``
 (not case sensitive as usual).  Otherwise there is no difference from standard
 MSIDs.
 """

cheta/get_telem.py

@@ -4,6 +4,7 @@
 
 Examples
 ========
+::
 
   # Get full-resolution TEPHIN, AOPCADMD for 30 days, and save as telem.zip
   % ska_fetch TEPHIN AOPCADMD --start=2013:001 --stop=2013:030 --sampling=5min \\

cheta/update_archive.py

@@ -26,6 +26,7 @@
 from ska_helpers.retry import tables_open_file
 
 import cheta.derived
+import cheta.remote_access
 from cheta import converters, fetch, file_defs
 
 
@@ -129,11 +130,15 @@ def get_options(args=None):
 )
 arch_files.update(file_defs.arch_files)
 
-# Set up fetch so it will first try to read from opt.data_root if that is
-# provided as an option and exists, and if not fall back to the default of
-# fetch.ENG_ARCHIVE.  Fetch is a read-only process so this is safe when testing.
+# Set up fetch so it will first try to read from opt.data_root if that is provided as an
+# option and exists, and if not fall back to the default of
+# cheta.remote_access.ENG_ARCHIVE. In this context that could be overridden with the
+# ENG_ARCHIVE environment variable. Fetch is a read-only process so this is safe when
+# testing.
 if opt.data_root:
-    fetch.msid_files.basedir = ":".join([opt.data_root, fetch.ENG_ARCHIVE])
+    fetch.msid_files.basedir = ":".join(
+        [opt.data_root, cheta.remote_access.ENG_ARCHIVE]
+    )
 
 # Set up logging
 loglevel = pyyaks.logger.VERBOSE if opt.log_level is None else int(opt.log_level)