bia_ql3/solo.sp: Cleanup

irfu · May 29, 2024 · b8c9200 · b8c9200
1 parent c9785c2
commit b8c9200
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 5 deletions.
diff --git a/mission/solar_orbiter/+solo/+sp/README.TXT b/mission/solar_orbiter/+solo/+sp/README.TXT
@@ -4,3 +4,13 @@ The software is delivered to ROC/LESIA for execution there.
 
 
 See irfu-matlab/mission/solar_orbiter/bia_ql3/README.TXT
+
+
+
+ABBREVIATIONS
+=============
+DSI
+    Dataset ID
+SP
+    Summary Plots. Name of plots and synonym (sort of) for the BIA_QL3 s/w.
+    See irfu-matlab/mission/solar_orbiter/bia_ql3/README.TXT
diff --git a/mission/solar_orbiter/+solo/+sp/bia_ql3.m b/mission/solar_orbiter/+solo/+sp/bia_ql3.m
@@ -1,6 +1,6 @@
 %
-% Main function for software "BIA_QL3" for creating BIAS summary plots intended
-% to be delivered to, and used by, LESIA/ROC.
+% Main function for software "BIA_QL3" for creating BIAS summary plots. The
+% software is intended to be delivered to, and used by, LESIA/ROC.
 %
 % See irfu-matlab/mission/solar_orbiter/bia_ql3/README.TXT for more
 % documentation of "BIA_QL3".
@@ -13,9 +13,8 @@
 %
 % INTERFACE REQUIREMENTS FOR THIS FUNCTION
 % ========================================
-% See
+% LESIA/ROC requries a certain OS SHELL interface. See
 %   https://gitlab.obspm.fr/ROC/RCS/BICAS/-/issues/42
-% for the OS SHELL interface requested by ROC.
 %   > shellExecutable YYYYMMDD input_bia_path input_lfr_wf_e_path output_dir log_dir
 % This function's interface mirrors the bash/OS script interface to simplify the
 % bash wrapper script. The function is therefore not very versatile.
@@ -29,6 +28,8 @@
 %   NOTE: Can handle the absence of matching datasets/directories, but fails on
 %   multiple matching datasets (assertion).
 % * Works for both CDAG/non-CDAG filenames.
+% * Code does not use other "library" code, in particular not solo.adm for
+%   parsing filenames.
 %
 %
 % ARGUMENTS

diff --git a/mission/solar_orbiter/+solo/+sp/plot_HK.m b/mission/solar_orbiter/+solo/+sp/plot_HK.m
@@ -214,7 +214,8 @@
 
 
 
-% Utility function
+% Utility function. Given a string pattern with space for an integer, e.g.
+% 'HK_BIA_BIAS%i', produce one version for each antenna.
 function zvNameTripletCa = ZV_name_triplet(zvNamePattern)
 zvNameTripletCa = {};
 for iAnt = 1:3

diff --git a/mission/solar_orbiter/bia_ql3/roc/bia_ql3 b/mission/solar_orbiter/bia_ql3/roc/bia_ql3
@@ -68,6 +68,11 @@ declare -r log_dir="$6"
 
 
 
+# NOTE: Uses the location of the current script to set paths:
+#       bin_dir:
+#           Used for locating other bash script without relying on PATH.
+#       irfumatlab_so_dir, irfumatlab_dir:
+#           Used for setting MATLAB path (for finding MATLAB source code).
 declare -r log_file="${log_dir}/bia_ql_${YYYYMMDD}.log"    # Filename format as requested from ROC.
 declare -r temp=$(dirname "$0")
 declare -r bin_dir=$(readlink -f "$temp")