/[CCFs]/bin/mlovccf
ViewVC logotype

Contents of /bin/mlovccf

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.13 - (show annotations)
Fri Apr 1 12:22:28 2016 UTC (8 years, 8 months ago) by ccflib
Branch: MAIN
Changes since 1.12: +95 -15 lines
Added new mailnotify function to notify on errors and process completion

1 #! /bin/bash
2
3 # mlovccf (make list of valid ccfs)
4 #
5 # Makes the list of valid CCFs. These are all CCFs, among those published since the
6 # beginning of the project, that are required to process any ODF at a given date,
7 # typically the current date. This list will change with time as far as new
8 # CCFs are issued to deal with new calibration data and/or replace obsolete ones.
9 #
10 # To identify the set of CCFs required to process a given ODF is the job of task cifbuild.
11 # To make such identification, cifbuild needs only the start time of the observation.
12 # Therefore, if we provide a list of all observed ODFs at a given date together with their
13 # respective start time, we could compute all the CCFs required to process them.
14 # For such a moment, that list is the list of valid CCFs required to process
15 # any observed ODF.
16 #
17 # We need as input the list of all observed ODFs at a given date.
18 # This is obtained from the report of all observations that the XSA makes to CDS,
19 # xsaobslog.txt (http://nxsa.esac.esa.int/ftp_public/cfs_obslog/xsaobslog.txt).
20 #
21 # $Id: mlovccf,v 1.12 2016/03/23 15:36:37 ccflib Exp $
22
23 # Next two lines allow to submit this script to the grid
24 # request Bourne shell as shell for job
25 #$ -S /bin/bash
26
27 adminmail="eduardo.ojero@esa.int"
28
29 VALID_CCF="$HOME/valid_ccf"
30
31 mailfile="${VALID_CCF}/mailfile"
32
33 host=`hostname | cut -d. -f1`
34
35 now=`date +'%Y%m%d_%H%M'`
36 now_table=`date +'%Y-%m-%dT%H:%M:%S'`
37
38
39 # +++ Function mailnotify
40 #
41 # This function is used to notify adminmail on any issue while runnning this procedure
42 #
43 # Needs a subject as $1 and body as local file to be send.
44
45 mailnotify ()
46 {
47
48 [ "$#" -ne "2" ] && return
49
50 subject=$1
51
52 bodyfile=$2
53
54 [ ! -f "${bodyfile}" ] && return
55
56 mailx -s "${subject}" "${adminuser}" < ${bodyfile}
57
58 }
59
60
61
62 # +++ Function getxsaobslog
63 #
64 # We need to get the list of all observed ODFs at the current date.
65 # This is obtained from http://nxsa.esac.esa.int/ftp_public/cds_obslog/xsaobslog.txt.
66
67 getxsaobslog ()
68 {
69
70 XSAOBSURL="http://nxsa.esac.esa.int/ftp_public/cds_obslog/xsaobslog.txt"
71
72 # Remove any xsaobslog.txt previously downloaded.
73
74 [ -f "${VALID_CCF}/xsaobslog.txt" ] && rm -rf ${VALID_CCF}/xsaobslog.txt
75
76 # Get the list latest list of ODFs available from nXSA server.
77
78 wget -q ${XSAOBSURL} -O ${VALID_CCF}/xsaobslog.txt
79
80 # Rename xsaobslog.txt to xsaobslog_${now}.txt just to have a reference
81 # of which list of ODFs was used to compute the list of valid CCFs.
82
83 mv ${VALID_CCF}/xsaobslog.txt ${VALID_CCF}/xsaobslog_${now}.txt
84
85 }
86
87
88
89 # +++ Function find_latest_mif to get the latest XMM_CALINDEX from given directory
90
91 find_latest_mif()
92 {
93
94 [ -z "$1" ] && return
95
96 CCFPATH="$1"
97
98 maxissue="0"
99 for mif in `ls -1 ${CCFPATH}/XMM_CALINDEX_*.CCF`
100 do
101 mifbase=`basename $mif`
102 issue=`echo $mifbase | awk -F"." '{print $1}' | awk -F"_" '{print $3}'`
103 [ "$issue" -ge "$maxissue" ] && maxissue="$issue"
104 done
105
106 MIF=${CCFPATH}/XMM_CALINDEX_${maxissue}.CCF
107
108 }
109
110
111
112 # +++Function get_ccf_list to list on stdout the table of CCFs in a given CIF.
113 #
114 # Requires that Heasoft is initialised. Otherwise exits with error.
115
116 get_ccf_list()
117 {
118 [ -z "$1" ] && return
119
120 cif_to_process="$1"
121
122 noversion=`which fversion | grep -c no`
123
124 if [ "${noversion}" != "0" ] ; then
125 echo "Error: Heasoft not initialised !"
126 [ -f "${mailfile}" ] && rm -rf ${mailfile}
127 echo "Running of fversion produced the following output:" >> $mailfile
128 echo "$noversion" >> $mailfile
129 mailnotify "mvloccf: Error: Heasoft not initialised!" $mailfile
130 rm ${mailfile}
131 exit
132 fi
133
134 fdump ${cif_to_process} prhead=no showcol=no showrow=no page=no \
135 columns="SCOPE TYPEID ISSUE" \
136 rows=- STDOUT
137 }
138
139
140
141
142 # +++ Fill in the valid_constituents directory with the Valid CCF set
143 #
144 # The directory to be filled in is ${VALIDCONSTITUENTSDISR}.
145 # This directory is synchronized with the similar directory in the
146 # external ftp server.
147 #
148 # In addition to that, we also use this function to fill in the
149 # /ccf/valid directory available for users in the intranet.
150
151 fillvalidccfdir()
152 {
153
154 [ -z "$1" ] && return
155
156 validccflist=$1
157
158 if [ ! -f "${VALID_CCF}/${validccflist}" ] ; then
159 echo "Error: ${VALID_CCF}/${validccflist} not found - Abort!"
160 [ -f "${mailfile}" ] && rm -rf ${mailfile}
161 echo "The list of valid CCF ${VALID_CCF}/${validccflist} is not found" >> $mailfile
162 mailnotify "mvloccf: Error: ${VALID_CCF}/${validccflist} not found - Abort!" $mailfile
163 rm ${mailfile}
164 exit
165 fi
166
167 VALIDCONSTITUENTSDIR="/home/ccflib/ftp-area/valid_constituents"
168 rm -rf ${VALIDCONSTITUENTSDIR}/*
169
170 VALIDCCFDIRINTRANET="/ccf/valid"
171 rm -rf ${VALIDCCFDIRINTRANET}/*
172
173 CONSTITUENTSDIR="/home/ccflib/ftp-area/constituents"
174 n=0
175 while read ccf
176 do
177 n=$((n + 1))
178 echo "$n cp -a ${CONSTITUENTSDIR}/${ccf} ${VALIDCONSTITUENTSDIR}/"
179 cp -a ${CONSTITUENTSDIR}/${ccf} ${VALIDCONSTITUENTSDIR}/
180 echo "$n cp -a ${CONSTITUENTSDIR}/${ccf} ${VALIDCCFDIRINTRANET}/"
181 cp -a ${CONSTITUENTSDIR}/${ccf} ${VALIDCCFDIRINTRANET}/
182 done < ${VALID_CCF}/${validccflist}
183
184 }
185
186
187 #
188 # M a i n p r o g r a m
189 #
190 # 1. Get the list of all ODFs
191
192
193 xsaobslogsize="0"
194
195 getxsaobslog
196
197 xsaobslogsize=`stat --format=%s ${VALID_CCF}/xsaobslog_${now}.txt`
198
199 if [ "$xsaobslogsize" = "0" ] ; then
200 echo "Error: Failure to download the XSA Obs. Log file - Abort"
201 [ -f "${mailfile}" ] && rm -rf ${mailfile}
202 echo "The XSA Obs. Log file has 0 size - Not downloaded?" >> $mailfile
203 echo "." >> $mailfile
204 mailnotify "mlovccf: Error: Failure to download the XSA Obs. Log file - Abort" "$mailfile"
205 rm ${mailfile}
206 exit
207 fi
208
209 # 2. Sets SAS_CCFPATH and initialises HEADAS and SAS depending on host
210
211 case "$host" in
212 xvsoc01|xmm)
213 export SAS_CCFPATH="/data/xmm/ccflib/ftp-area/constituents"
214 export SAS_DIR=/data/xmm/ccflib/sas
215 export SAS_PATH=$SAS_DIR
216 source $SAS_DIR/sas-setup.sh
217 ;;
218 sasbld01|sasbld02)
219 export SAS_CCFPATH="/home/ccflib/ftp-area/constituents"
220 /sas/bin/confsas
221 export HEADAS=/sasbuild/local/${host}/headas/architecture
222 . $HEADAS/headas-init.sh
223 # To be able to mix several jobs on the same ccflib account
224 [ ! -d "${HOME}/pfiles/${host}" ] && mkdir ${HOME}/pfiles/${host}
225 export PFILES="${HOME}/pfiles/${host};${HEADAS}/syspfiles"
226 echo -n "HEADAS version: "
227 fversion
228 source $HOME/setsas.sh 1> /dev/null
229 echo "SAS Version: "
230 sasversion -V 1
231 export SAS_VERBOSITY=0
232 ;;
233 scigrid6|cn-*)
234 export SAS_CCFPATH="/home/ccflib/ftp-area/constituents"
235 /sas/bin/confsas
236 export HEADAS=/sasbuild/local/sasbld02/headas/architecture
237 . $HEADAS/headas-init.sh
238 # To be able to mix several jobs on the same ccflib account
239 [ ! -d "${HOME}/pfiles/${host}" ] && mkdir ${HOME}/pfiles/${host}
240 export PFILES="${HOME}/pfiles/${host};${HEADAS}/syspfiles"
241 echo -n "HEADAS version: "
242 fversion
243 source $HOME/setsas.sh 1> /dev/null
244 echo "SAS Version: "
245 sasversion -V 1
246 export SAS_VERBOSITY=0
247 ;;
248 *) echo "Error: Do not know how to do it in host $host" ; exit ;;
249 esac
250
251 # 3. Finds the latest MIF issue
252
253 find_latest_mif "${SAS_CCFPATH}"
254
255
256 # 4. Scans the list of OBDS ID registered in the previous list to get the start time
257 # Then runs cifbuild to get the respective CIF.
258 # all_ccfs_${now}.txt is filled recursively on each iteration. Therefore we start
259 # with an empty file.
260
261 # Output file : ${VALID_CCF}/all_ccfs_${now}.txt
262
263 touch ${VALID_CCF}/all_ccfs_${now}.txt
264
265 n=0
266
267 while read line
268 do
269 obsid=`echo $line | awk -F"|" '{print $2}'`
270 stime=`echo $line | awk -F"|" '{print $9}'`
271 stime=`echo $stime | tr " " "T"`
272 n=$((n+1))
273 echo "($n) Processing $obsid $stime" ; echo
274
275 # Run cifbuild
276
277 cif_file=${VALID_CCF}/${obsid}.cif
278
279 cifbuild --withmasterindexset='yes' \
280 --masterindexset=${MIF} \
281 --withobservationdate='yes' \
282 --observationdate=${stime} \
283 --analysisdate='now' \
284 --calindexset=${cif_file}
285
286
287 # Gets the list of CCFs included in the CIF
288
289 get_ccf_list "${cif_file}" > ${VALID_CCF}/${obsid}_ccfs.tmp
290
291 while read line
292 do
293 [ "$line" = "" ] && continue
294 class=`echo $line | awk -F" " '{print $1"_"$2}'`
295 issue=`echo $line | awk -F" " '{print $3}'`
296 issue=`printf "%04d" ${issue}`
297 echo ${class}_${issue}.CCF >> ${VALID_CCF}/${obsid}_ccfs.txt
298
299 done < ${VALID_CCF}/${obsid}_ccfs.tmp
300
301 rm ${VALID_CCF}/${obsid}_ccfs.tmp
302
303 mv ${VALID_CCF}/all_ccfs_${now}.txt ${VALID_CCF}/all_ccfs_${now}.tmp
304
305 cat ${VALID_CCF}/${obsid}_ccfs.txt ${VALID_CCF}/all_ccfs_${now}.tmp | sort -u > ${VALID_CCF}/all_ccfs_${now}.txt
306
307 rm ${cif_file}
308 rm ${VALID_CCF}/${obsid}_ccfs.txt
309 rm ${VALID_CCF}/all_ccfs_${now}.tmp
310
311 done < ${VALID_CCF}/xsaobslog_${now}.txt
312
313 # 5. Make a table of classes and issues with the style "Pipeline Release Notes"
314 # To get a classification, we need first to obtain all available classes.
315 #
316
317
318 # Lists all CCF classes
319
320 ccf_classes="${VALID_CCF}/ccf_classes.txt"
321
322 while read line
323 do
324 class=`echo $line | awk -F"_" '{print $1"_"$2}'`
325 echo $class >> ${ccf_classes}
326 done < ${VALID_CCF}/all_ccfs_${now}.txt
327
328 cat ${ccf_classes} | sort -u > ${VALID_CCF}/kk.txt
329 mv ${VALID_CCF}/kk.txt ${ccf_classes}
330
331
332
333 # Output final file is named all_ccfs_${now}_table.txt
334
335 total_number_of_ccfs=0
336
337 all_ccfs_table="${VALID_CCF}/all_ccfs_${now}_table.txt"
338
339 [ -f "${all_ccfs_table}" ] && rm ${all_ccfs_table}
340
341 echo "Table of valid CCFs at $now_table" >> ${all_ccfs_table}
342 echo >> ${all_ccfs_table}
343 echo "|================================|=============|=======|" >> ${all_ccfs_table}
344 echo "| Calibration File | Issue range | Count |" >> ${all_ccfs_table}
345 echo "|================================|=============|=======|" >> ${all_ccfs_table}
346
347 while read ccf_class
348 do
349 echo -n "Processing class $ccf_class ..."
350 issues_file="${VALID_CCF}/ccf_issues_for_${ccf_class}.txt"
351 [ -f "${issues_file}" ] && rm ${issues_file}
352 while read line
353 do
354 class=`echo $line | awk -F"_" '{print $1"_"$2}'`
355 [ "$class" != "$ccf_class" ] && continue
356 issue=`echo $line | awk -F"_" '{print $3}' | cut -d. -f1`
357 echo $issue >> ${issues_file}
358 done < ${VALID_CCF}/all_ccfs_${now}.txt
359
360 cat ${issues_file} | sort -u > kk.txt
361 mv kk.txt ${issues_file}
362 real_number_of_issues_for_this_class=`wc -l ${issues_file} | awk -F" " '{print $1}'`
363
364 first_issue=`head -1 ${issues_file}`
365 last_issue=`tail -1 ${issues_file}`
366
367 li=$((10#$last_issue))
368 fi=$((10#$first_issue))
369
370 sequential_number_of_issues_for_this_class=$((li - fi + 1))
371
372 asterisk=" "
373 [ "${real_number_of_issues_for_this_class}" -lt "${sequential_number_of_issues_for_this_class}" ] && asterisk="(*)"
374
375 total_number_of_ccfs=$((real_number_of_issues_for_this_class + total_number_of_ccfs))
376
377 rn=$real_number_of_issues_for_this_class
378
379 if [ "${first_issue}" != "${last_issue}" ] ; then
380 if [ "$asterisk" = "(*)" ] ; then
381 printf "| %-30s | %4s-%4s(*)| %4s |\n" ${ccf_class} ${first_issue} ${last_issue} ${rn} >> ${all_ccfs_table}
382 else
383 printf "| %-30s | %4s-%4s | %4s |\n" ${ccf_class} ${first_issue} ${last_issue} ${rn} >> ${all_ccfs_table}
384 fi
385 else
386 printf "| %-30s | %4s | %4s |\n" ${ccf_class} ${first_issue} ${rn} >> ${all_ccfs_table}
387 fi
388
389
390 echo "done"
391 done < ${ccf_classes}
392
393 echo "|================================|=============|=======|" >> ${all_ccfs_table}
394 echo >> ${all_ccfs_table}
395 echo "(*): Incomplete range." >> ${all_ccfs_table}
396 echo "" >> ${all_ccfs_table}
397 echo "Total number of valid CCFs required : ${total_number_of_ccfs}" >> ${all_ccfs_table}
398 rm ${VALID_CCF}/ccf_classes.txt
399 rm ${VALID_CCF}/ccf_issues_for*.txt
400
401
402
403 # 6. Fill in the Valid CCF Set dir with the proper CCFs
404
405 fillvalidccfdir "all_ccfs_${now}.txt"
406
407 [ -f "${mailfile}" ] && rm -rf ${mailfile}
408 echo "Valid CCF Set successfully copied to ${VALIDCONSTITUENTSDIR}" >> $mailfile
409 echo "Valid CCF Set successfully copied to ${VALIDCCFDIRINTRANET}" >> $mailfile
410 mailnotify "mvloccf: Valid CCF Set created successfully" $mailfile
411 rm ${mailfile}

  ViewVC Help
Powered by ViewVC 1.1.27