source: trunk/libIGCM/libIGCM_config/libIGCM_config.ksh @ 444

Last change on this file since 444 was 444, checked in by sdipsl, 13 years ago

The FirstInitialize? variable must remain true during mpi execution so that comp.driver can use that information...

Invisible in DRYRUN mode...

  • Property licence set to
    The following licence information concerns ONLY the libIGCM tools
    ==================================================================

    Copyright © Centre National de la Recherche Scientifique CNRS
    Commissariat à l'Énergie Atomique CEA

    libIGCM : Library for Portable Models Computation of IGCM Group.

    IGCM Group is the french IPSL Global Climate Model Group.

    This library is a set of shell scripts and functions whose purpose is
    the management of the initialization, the launch, the transfer of
    output files, the post-processing and the monitoring of datas produce
    by any numerical program on any plateforme.

    This software is governed by the CeCILL license under French law and
    abiding by the rules of distribution of free software. You can use,
    modify and/ or redistribute the software under the terms of the CeCILL
    license as circulated by CEA, CNRS and INRIA at the following URL
    "http://www.cecill.info".

    As a counterpart to the access to the source code and rights to copy,
    modify and redistribute granted by the license, users are provided only
    with a limited warranty and the software's author, the holder of the
    economic rights, and the successive licensors have only limited
    liability.

    In this respect, the user's attention is drawn to the risks associated
    with loading, using, modifying and/or developing or reproducing the
    software by the user in light of its specific status of free software,
    that may mean that it is complicated to manipulate, and that also
    therefore means that it is reserved for developers and experienced
    professionals having in-depth computer knowledge. Users are therefore
    encouraged to load and test the software's suitability as regards their
    requirements in conditions enabling the security of their systems and/or
    data to be ensured and, more generally, to use and operate it in the
    same conditions as regards security.

    The fact that you are presently reading this means that you have had
    knowledge of the CeCILL license and that you accept its terms.
  • Property svn:keywords set to Revision Author Date
File size: 31.9 KB
Line 
1#!/bin/ksh
2
3#**************************************************************
4# Author: Sebastien Denvil, Martial Mancip
5# Contact: Sebastien.Denvil__at__ipsl.jussieu.fr Martial.Mancip__at__ipsl.jussieu.fr
6# $Revision::                                          $ Revision of last commit
7# $Author::                                            $ Author of last commit
8# $Date::                                              $ Date of last commit
9# IPSL (2006)
10#  This software is governed by the CeCILL licence see libIGCM/libIGCM_CeCILL.LIC
11#
12#**************************************************************
13
14#===================================
15function IGCM_config_Initialize
16{
17    IGCM_debug_PushStack "IGCM_config_Initialize"
18
19    # Debug Print :
20    echo
21    IGCM_debug_Print 1 "IGCM_config_Initialize :"
22    echo
23
24    if [ ! -r ${SUBMIT_DIR}/run.card ]; then 
25        #================================================#
26        #         The file run.card doesn't exist        #
27        #================================================#
28        FirstInitialize=true
29        #copy initial run.card
30        IGCM_sys_Cp ${SUBMIT_DIR}/run.card.init ${SUBMIT_DIR}/run.card
31    else
32        FirstInitialize=false
33    fi
34
35    # Test modipsl tree existence.
36    IGCM_sys_TestDir ${MODIPSL}
37    [ $? != 0 ] && IGCM_debug_Exit "IGCM_sys_TestDirArchive"
38    IGCM_sys_TestDir ${libIGCM}
39    [ $? != 0 ] && IGCM_debug_Exit "IGCM_sys_TestDirArchive"
40    IGCM_sys_TestDir ${R_EXE}
41    [ $? != 0 ] && IGCM_debug_Exit "IGCM_sys_TestDirArchive"
42    IGCM_sys_TestDir ${SUBMIT_DIR}
43    [ $? != 0 ] && IGCM_debug_Exit "IGCM_sys_TestDirArchive"
44
45    if ( $DEBUG_debug ) ; then
46        echo "Keep trace of inital SUBMIT_DIR : "
47        ls -lta ${SUBMIT_DIR}
48    fi
49
50    #==================================
51
52    typeset option auxprint CompatibilityTag
53    # Read libIGCM compatibility version in config.card
54    IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/config.card Compatibility libIGCM
55    eval CompatibilityTag=${config_Compatibility_libIGCM} > /dev/null 2>&1     
56
57    if [ ! "${CompatibilityTag}" = "${libIGCM_CurrentTag}" ] ; then
58        IGCM_debug_Exit "config.card is not compatible with libIGCM version ${libIGCM_CurrentTag} see libIGCM FAQ http://wiki.ipsl.jussieu.fr/wiki_ipsl/IGCMG/libIGCM/DocUtilisateur/FAQ ."
59    fi
60
61    #==================================
62    IGCM_card_DefineArrayFromSection ${SUBMIT_DIR}/config.card UserChoices
63
64    for option in ${config_UserChoices[*]} ; do
65        IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/config.card UserChoices ${option}
66    done
67
68    IGCM_debug_Print 1 "DefineArrayFromOption  : config_UserChoices"
69    # Name Space of this experience
70    if [ X${config_UserChoices_SpaceName} != X ] ; then
71        IGCM_debug_PrintVariables 3 config_UserChoices_SpaceName
72    fi
73    # Expericence class of the run
74    if [ X${config_UserChoices_ExperimentName} != X ] ; then
75        IGCM_debug_PrintVariables 3 config_UserChoices_ExperimentName
76    fi
77    IGCM_debug_PrintVariables 3 config_UserChoices_JobName
78    if [ 3 -le ${Verbosity} ] ; then
79        echo "--------------Debug3-->" "config_UserChoices_LongName="
80        echo "--------------Debug3-->" \"${config_UserChoices_LongName}\"
81    fi
82    IGCM_debug_PrintVariables 3 config_UserChoices_TagName
83    IGCM_debug_PrintVariables 3 config_UserChoices_CalendarType
84    IGCM_debug_PrintVariables 3 config_UserChoices_DateBegin
85    IGCM_debug_PrintVariables 3 config_UserChoices_DateEnd
86    IGCM_debug_PrintVariables 3 config_UserChoices_PeriodLength
87
88    #==================================
89
90    IGCM_card_DefineArrayFromSection ${SUBMIT_DIR}/config.card ListOfComponents
91
92    echo
93    IGCM_debug_Print 1 "DefineArrayFromSection : ListOfComponents"
94    IGCM_debug_Print 3 ${config_ListOfComponents[*]}
95    echo
96
97    NbComponents=${#config_ListOfComponents[*]}
98
99    #==================================
100    # Define principal executable
101
102    IGCM_card_DefineArrayFromSection   ${SUBMIT_DIR}/config.card Executable
103    IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/config.card Executable Name
104   
105    #==================================
106    # Define Outputs Name
107    IGCM_debug_Print 1 "Define Script_Output_Prefix and Exe_Output"
108    eval Script_Output_Prefix=${config_UserChoices_Script_Output_Prefix:='Script_Output'}
109    IGCM_debug_Print 3 "Script_Output_Prefix = ${Script_Output_Prefix}"
110    eval Exe_Output=out_${config_Executable_Name}
111    IGCM_debug_Print 3 "Exe_Output           = ${Exe_Output}"
112
113    #==================================
114
115    #===================================================================#
116    # Prepare variables available for ${COMP}.card and ${COMP}.driver   #
117    #             But available to any son functions                    #
118    #===================================================================#
119
120    # Convert yyyy-mm-dd date to gregorian yyyymmdd
121    DateBegin=$( IGCM_date_ConvertFormatToGregorian ${config_UserChoices_DateBegin} )
122    DateEnd=$( IGCM_date_ConvertFormatToGregorian ${config_UserChoices_DateEnd} )
123
124    # Period Length In Days between DateBegin and DateEnd
125    (( ExperienceLengthInDays=$( IGCM_date_DaysBetweenGregorianDate ${DateEnd} ${DateBegin} )  + 1 ))
126    if [ ${ExperienceLengthInDays} -lt 0 ] ; then
127        IGCM_debug_Print 1 "Problem with dates in config.card : ${DateEnd} < ${DateBegin} ! You must check that."
128        IGCM_debug_Exit "IGCM_config_Initialize" " Wrong Dates."
129        IGCM_debug_Verif_Exit
130    fi
131
132    # Day and Year of Initial State (Given in julian format)
133    InitDay=$(( $( IGCM_date_ConvertGregorianDateToJulian $DateBegin ) % 1000 ))
134    InitYear=$(( $( IGCM_date_ConvertGregorianDateToJulian $DateBegin ) / 1000 ))
135
136    #==================================
137    # Restarts : Gerneral rule or local for each component ?
138    IGCM_card_DefineArrayFromSection ${SUBMIT_DIR}/config.card Restarts
139
140    echo
141    IGCM_debug_Print 1 "DefineArrayFromOption : config_Restarts"
142
143    for option in ${config_Restarts[*]} ; do
144        IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/config.card Restarts ${option}
145        eval auxprint=\${config_Restarts_${option}}
146        IGCM_debug_Print 3 "${option} : ${auxprint}"
147    done
148
149    #================================================================#
150    #                  Test and Prepare directories                  #
151    #================================================================#
152
153    # ==> 4 kinds of input files :
154    #     1) R_INIT  : Initial State Files   (Etat0, carteveg)
155    #     2) R_BC    : Boundary Conditions   (Forcages, lai)
156    #     3) Parameters files (allready define through ${SUBMIT_DIR})
157    #     4) Restarts files   (allready define in IGCM_config_Initialize)
158
159    # Here we offer the possibility to redefine R_INIT, R_BC
160    # and PeriodNb through config.card
161    R_INIT=${config_UserChoices_R_INIT:=${R_IN}/INIT}
162    echo
163    IGCM_debug_Print 1 "(Re)Define R_INIT, R_BC and PeriodNb"
164    IGCM_debug_Print 3 "R_INIT=${R_INIT}"
165    R_BC=${config_UserChoices_R_BC:=${R_IN}/BC}
166    IGCM_debug_Print 3  "R_BC=${R_BC}"
167    PeriodNb=${config_UserChoices_PeriodNb:=${PeriodNb}}
168    IGCM_debug_Print 3  "Loop in main Job with ${PeriodNb} period(s)"
169
170    # Test Archive input/output.
171    IGCM_sys_TestDirArchive ${ARCHIVE}
172    [ $? != 0 ] && IGCM_debug_Exit "IGCM_sys_TestDirArchive"
173    IGCM_sys_TestDirArchive ${R_IN}
174    [ $? != 0 ] && IGCM_debug_Exit "IGCM_sys_TestDirArchive"
175
176    #====================================================
177    #R_SAVE : Job output directory
178    if ( [ ! X${config_UserChoices_SpaceName} = X ] && [ ! X${config_UserChoices_ExperimentName} = X ] ) ; then
179        FreeName=$( echo ${config_UserChoices_JobName} | sed 's/.*_//' )
180        R_SAVE=${R_OUT}/${config_UserChoices_TagName}/${config_UserChoices_SpaceName}/${config_UserChoices_ExperimentName}/${FreeName}
181        R_DODS=${config_UserChoices_TagName}/${config_UserChoices_SpaceName}/${config_UserChoices_ExperimentName}/${FreeName}
182    else
183        R_SAVE=${R_OUT}/${config_UserChoices_TagName}/${config_UserChoices_JobName}
184        R_DODS=${config_UserChoices_TagName}/${config_UserChoices_JobName}
185    fi
186
187    if ( ${FirstInitialize} ) ; then
188        IGCM_sys_MkdirArchive ${R_SAVE}
189    else
190        #Test state of run in run.card
191        IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/run.card Configuration PeriodState
192        if ( [ ${run_Configuration_PeriodState} != "Start" ] && [ ${run_Configuration_PeriodState} != "Running" ] && [ ${run_Configuration_PeriodState} != "OnQueue" ] && [ ${run_Configuration_PeriodState} != "Continue" ] ) ; then
193            echo
194            IGCM_debug_Print 1 "!!!! IGCM_config_Initialize Error PeriodState : " ${run_Configuration_PeriodState} "!!!!!!!!!!"
195            echo
196            IGCM_debug_Exit "IGCM_config_Initialize Error PeriodState : " ${run_Configuration_PeriodState}
197            IGCM_debug_Verif_Exit
198        fi
199    fi
200    IGCM_sys_TestDirArchive ${R_SAVE}
201    [ $? != 0 ] && IGCM_debug_Exit "IGCM_sys_TestDirArchive"
202
203    #==================================
204    # Post :
205    IGCM_card_DefineArrayFromSection ${SUBMIT_DIR}/config.card Post
206
207    echo
208    IGCM_debug_Print 1 "DefineArrayFromOption : config_Post"
209
210    for option in ${config_Post[*]} ; do
211        IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/config.card Post ${option}
212        eval auxprint=\${config_Post_${option}}
213        IGCM_debug_Print 3 "${option} : ${auxprint}"
214    done
215
216    #====================================================
217    # Define REBUILD_DIR : where we store files needing rebuild process
218    if [ X${config_Post_RebuildFromArchive} = Xtrue ] ; then
219        REBUILD_DIR=${R_SAVE}/TMP
220        IGCM_sys_MkdirArchive ${REBUILD_DIR}
221    else
222        REBUILD_DIR=${BIG_DIR}/${config_UserChoices_TagName}/${config_UserChoices_JobName}
223        IGCM_sys_MkdirWork ${REBUILD_DIR}
224    fi
225
226    #====================================================
227    # Experience type : DEB(ug), DEV(elopment), RUN
228    if [ X${JobType} != XRUN ] ; then
229        echo
230        echo "===================================================="
231        echo "libIGCM JOB is NOT in RUN type mode."
232        echo "!! OUTPUT files will NOT be PROTECTED !!"
233        echo "Be carefull : you can ERASE the result of this job !"
234
235        case ${JobType} in
236            DEB)
237                echo "DEBUG mode : activation of 'set -vx' mode."
238                echo "DEBUG mode : no protection for output files."
239                echo "DEBUG mode : if active force asynchronous rebuild frequency to PeriodLength frequency."
240                ;;
241            DEV)
242                echo "DEVelopment mode : no protection for output files."
243                echo "DEVelopment mode : if active force asynchronous rebuild frequency to PeriodLength frequency."
244                ;;
245        esac
246
247        if ( [ X${config_Post_RebuildFrequency} != XNONE ] && [ ${DRYRUN} -eq 0 ] ) ; then
248            if [ X${config_Post_RebuildFrequency} != X${config_UserChoices_PeriodLength} ] ; then
249                echo "------------"
250                echo "WARNING : Job is NOT in RUN mode then we will force REBUILD Frequency"
251                echo "          to PeriodLength : ${config_UserChoices_PeriodLength}"
252                echo "------------"
253                config_Post_RebuildFrequency=${config_UserChoices_PeriodLength}
254            fi
255        fi
256        echo "===================================================="
257        echo
258    fi
259
260    #====================================================
261    #R_OUT_KSH : Storage place for job output
262    #R_OUT_EXE : Storage place for binary used during simulation
263    R_OUT_KSH=${R_SAVE}/Out
264    R_OUT_EXE=${R_SAVE}/Exe
265
266    IGCM_debug_PopStack "IGCM_config_Initialize"
267}
268
269#===================================
270function IGCM_config_Analyse_PeriodLength
271{
272    IGCM_debug_PushStack "IGCM_config_Analyse_PeriodLength"
273
274    typeset i
275
276    # Determine number of day(s) in PeriodLength :
277    case ${config_UserChoices_PeriodLength} in
278        *Y|*y)
279            PeriodLengthInYears=$( echo ${config_UserChoices_PeriodLength} | sed -e 's/[yY]//' ) 
280            IGCM_debug_Print 1 "Number of years for PeriodLength : ${PeriodLengthInYears}"
281            PeriodLengthInDays=0
282            i=0
283            until [ $i -ge $PeriodLengthInYears ] ; do 
284                (( PeriodLengthInDays = PeriodLengthInDays + $( IGCM_date_DaysInYear $(( year + i )) ) )) 
285                (( i=i+1 )) 
286            done 
287            ;;
288        *M|*m)
289            PeriodLengthInMonths=$( echo ${config_UserChoices_PeriodLength} | sed -e 's/[mM]//' ) 
290            IGCM_debug_Print 1 "Number of months for PeriodLength : ${PeriodLengthInMonths}"
291            PeriodLengthInDays=0
292            i=0
293            until [ $i -ge $PeriodLengthInMonths ] ; do
294                if [ $(( month + i )) -lt 13 ] ; then 
295                    (( PeriodLengthInDays  = PeriodLengthInDays + $( IGCM_date_DaysInMonth $year $(( month + i )) ) )) 
296                else 
297                    (( PeriodLengthInDays  = PeriodLengthInDays + $( IGCM_date_DaysInMonth $year $(( month + i - 12 )) ) )) 
298                fi 
299                (( i=i+1 )) 
300            done 
301            ;;
302        *D|*d) 
303            PeriodLengthInMonths=0
304            PeriodLengthInDays=$( echo ${config_UserChoices_PeriodLength} | sed -e 's/[dD]//' );;
305        *) 
306            IGCM_debug_Exit "IGCM_config_Analyse_PeriodLength " ${config_UserChoices_PeriodLength} " invalid period length : choose in *Y, *M, *D."
307            IGCM_debug_Verif_Exit ;;
308    esac
309
310    IGCM_debug_PopStack "IGCM_config_Analyse_PeriodLength"
311}
312
313#===================================
314function IGCM_config_Check
315{
316    IGCM_debug_PushStack "IGCM_config_Check"
317
318    # If one of the following modulo is not zero :
319    # we will issue an error then explain and exit in
320    # AA_job IGCM_debug_Verif_Exit call before binary submission
321
322    echo
323    IGCM_debug_Print 1 "IGCM_config_Check :"
324    echo
325
326    typeset i
327
328    if ( [ ! X${config_Post_RebuildFrequency} = X${NULL_STR} ] || [ ! X${config_Post_RebuildFrequency} = XNONE ] ) ; then
329        AsynchronousRebuild=true
330        IGCM_debug_Print 1 "Asynchronous rebuild has been activated."
331        echo
332        # modulo (RebuildFrequency and PeriodLength/TimeSeriesFrequency/SeasonalFrequency) must be zero
333        IGCM_post_CheckModuloFrequency config_Post_RebuildFrequency config_UserChoices_PeriodLength
334        IGCM_post_CheckModuloFrequency config_Post_TimeSeriesFrequency config_Post_RebuildFrequency
335        IGCM_post_CheckModuloFrequency config_Post_SeasonalFrequency config_Post_RebuildFrequency
336    else
337        AsynchronousRebuild=false
338        IGCM_debug_Print 1 "Asynchronous rebuild has not been activated"
339        IGCM_debug_Print 1 "Proceed with standard post-treatment pathway"
340        echo
341        #modulo (TimeSeriesFrequency/SeasonalFrequency and PeriodLenght) must be zero
342        IGCM_post_CheckModuloFrequency config_Post_TimeSeriesFrequency config_UserChoices_PeriodLength
343        IGCM_post_CheckModuloFrequency config_Post_SeasonalFrequency   config_UserChoices_PeriodLength
344    fi
345
346    #modulo (TimeSeriesFrequency and all Chunck2D) must be zero
347    NbJob=${#CHUNCK2D_SIZE[@]}
348    i=0
349    until [ $i -ge $NbJob ]; do
350        value=${CHUNCK2D_SIZE[${i}]}
351        IGCM_post_CheckModuloFrequency value config_Post_TimeSeriesFrequency
352        case ${value} in 
353            *Y|*y) ;;
354            *)  IGCM_debug_Print 3 "All ChunckJob2D frequency must be expressed in year *Y|*y in comp.card"
355                IGCM_debug_Exit "This will stop the job" ;;
356        esac
357        (( i=i+1 ))
358    done
359
360    #modulo (TimeSeriesFrequency and all Chunck3D) must be zero
361    NbJob=${#CHUNCK3D_SIZE[@]}
362    i=0
363    until [ $i -ge $NbJob ]; do
364        value=${CHUNCK3D_SIZE[${i}]}
365        IGCM_post_CheckModuloFrequency value config_Post_TimeSeriesFrequency
366        case ${value} in 
367            *Y|*y) ;;
368            *)  IGCM_debug_Print 3 "All ChunckJob3D frequency must be expressed in year *Y|*y in comp.card"
369                IGCM_debug_Exit "This will stop the job" ;;
370        esac
371        (( i=i+1 ))
372    done
373
374    IGCM_debug_PopStack "IGCM_config_Check"
375}
376
377#===================================
378function IGCM_config_PeriodStart
379{
380    IGCM_debug_PushStack "IGCM_config_PeriodStart"
381
382    echo
383    IGCM_debug_Print 1 "IGCM_config_PeriodStart :"
384    echo
385
386    if ( ${FirstInitialize} ) ; then
387        #================================================#
388        #         Initialize date/period information     #
389        #================================================#
390
391        IGCM_date_GetYearMonth $DateBegin year month
392        year_m1=$(( year - 1 ))
393        year_p1=$(( year + 1 )) 
394        IGCM_config_Analyse_PeriodLength
395
396        eval PeriodDateBegin=${DateBegin} > /dev/null 2>&1
397        PeriodDateEnd=$( IGCM_date_AddDaysToGregorianDate ${DateBegin} $(( ${PeriodLengthInDays} - 1 )) )
398        eval CumulPeriod=1 > /dev/null 2>&1
399
400        #=================================================#
401        #              Write updated run.card             #
402        #=================================================#
403
404        #Correct run.card Configuration for this period
405        IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration PeriodDateBegin ${PeriodDateBegin}
406        IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration PeriodDateEnd ${PeriodDateEnd}
407        IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration CumulPeriod ${CumulPeriod}
408        IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration SubmitPath ${SUBMIT_DIR}
409
410        IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration PeriodState "Running"
411 
412    else
413        #================================================#
414        #         The file run.card allready exist       #
415        #================================================#
416
417        #Test state of run in run.card
418        IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/run.card Configuration PeriodState
419        if ( [ ${run_Configuration_PeriodState} != "Running" ] && [ ${run_Configuration_PeriodState} != "OnQueue" ] && [ ${run_Configuration_PeriodState} != "Continue" ] ) ; then
420            echo
421            IGCM_debug_Print 1 "!!!!!! IGCM_config_PeriodStart Error PeriodState : " ${run_Configuration_PeriodState} "!!!!!!!!!!"
422            echo
423            IGCM_debug_Exit "IGCM_config_PeriodStart Error PeriodState : " ${run_Configuration_PeriodState}
424            IGCM_debug_Verif_Exit
425        fi
426
427        #===================================#
428        #        Read updated run.card      #
429        #===================================#
430
431        IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/run.card Configuration OldPrefix
432        IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/run.card Configuration PeriodDateBegin
433        IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/run.card Configuration PeriodDateEnd
434        IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/run.card Configuration CumulPeriod
435
436        PeriodDateBegin=$( IGCM_date_ConvertFormatToGregorian ${run_Configuration_PeriodDateBegin} )
437        PeriodDateEnd=$( IGCM_date_ConvertFormatToGregorian ${run_Configuration_PeriodDateEnd} )
438        eval CumulPeriod="${run_Configuration_CumulPeriod}" > /dev/null 2>&1
439
440        if [ ${Period} = 1 ]; then
441           # save last Job output
442            typeset LastPeriod iLastPeriod Last_Script_Output_Name
443            (( LastPeriod=CumulPeriod-PeriodNb ))
444            iLastPeriod=$( printf "%06d" ${LastPeriod} )
445            Last_Script_Output_Name="${Script_Output_Prefix}_${config_UserChoices_JobName}.${iLastPeriod}"
446            Last_run_card="run.card.${iLastPeriod}"
447            #eval ls -l ${SUBMIT_DIR}/${Last_Script_Output_Name}
448            #eval IGCM_sys_Put_Out ${SUBMIT_DIR}/${Last_Script_Output_Name} ${R_OUT_KSH}/${Last_Script_Output_Name} > /dev/null 2>&1
449            IGCM_debug_Print 1 "Try to save previous ksh job output"
450            IGCM_sys_Cd ${SUBMIT_DIR}/
451            IGCM_sys_Put_Out ${Last_Script_Output_Name} ${R_OUT_KSH}/${Last_Script_Output_Name}.$$ rw
452            IGCM_sys_Put_Out ${SUBMIT_DIR}/run.card ${R_OUT_KSH}/${Last_run_card}.$$ rw
453            IGCM_sys_Cd ${RUN_DIR}
454        else
455            unset FileToBeDeleted
456        fi
457
458        IGCM_date_GetYearMonth $PeriodDateBegin year month
459        year_m1=$(( year - 1 ))
460        year_p1=$(( year + 1 )) 
461        IGCM_config_Analyse_PeriodLength
462
463        IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration PeriodState "Running"
464
465    fi   
466    OldPrefix=${config_UserChoices_JobName}_${PeriodDateEnd}
467 
468    #===================================================================#
469    # Prepare variables available for ${COMP}.card and ${COMP}.driver   #
470    #             But available to any son functions                    #
471    #===================================================================#
472
473    # Period Length In Days between DateBegin and DateCurrent (at end of period == PeriodDateEnd !)
474    (( SimulationLengthInDays = $( IGCM_date_DaysBetweenGregorianDate ${PeriodDateEnd} ${DateBegin} ) + 1 ))
475
476    # Debug Print :
477    IGCM_debug_Print 1 "IGCM_config_PeriodStart : Before Execution"
478    IGCM_debug_Print 3 "Year of simulation      : ${year}"
479    IGCM_debug_Print 3 "Month of simulation     : ${month}"
480    IGCM_debug_Print 3 "PeriodLengthInDays      : ${PeriodLengthInDays}"
481    IGCM_debug_Print 3 "PeriodDateBegin         : ${PeriodDateBegin}"
482    IGCM_debug_Print 3 "PeriodDateEnd           : ${PeriodDateEnd}"
483    IGCM_debug_Print 3 "SimulationLengthInDays  : ${SimulationLengthInDays}"
484    IGCM_debug_Print 3 "ExperienceLengthInDays  : ${ExperienceLengthInDays}"
485
486    #================================================================#
487    #         Prepare variables available for comp_finalyze          #
488    #================================================================#
489
490    # Period for save files
491    eval DatesPeriod=${PeriodDateBegin}_${PeriodDateEnd} > /dev/null 2>&1
492
493    # Prefix for save files of this period
494    eval PREFIX=${config_UserChoices_JobName}_${DatesPeriod}  > /dev/null 2>&1
495
496    # List of files that will be deleted in RUN_DIR after run
497    [ -f stack ] && FileToBeDeleted[0]="stack"
498
499    # Test if the same run as already been saved :
500    if [ X${JobType} = XRUN ] ; then
501        if [ ${DRYRUN} -le 0 ] ; then
502            if ( IGCM_sys_TestFileArchive ${R_OUT_KSH}/${PREFIX}_${Exe_Output} ) ; then
503                IGCM_debug_Exit "IGCM_config_PeriodStart" "You are currently RErunning an old job."
504                IGCM_debug_Print 1 "Because of readonly permissions, you can't RErun a job when saved files"
505                IGCM_debug_Print 1 " are still in the ARCHIVE directory. You must deleted those files, or "
506                IGCM_debug_Print 1 " the whole ${R_SAVE} tree. See clean_month.job in ${libIGCM} directory."
507                IGCM_debug_Print 1 " This exit has been initiated because at least ${R_OUT_KSH}/${PREFIX}_${Exe_Output} exists."
508                IGCM_debug_Verif_Exit
509            fi
510        fi
511    else
512        if ( IGCM_sys_TestFileArchive ${R_OUT_KSH}/${PREFIX}_${Exe_Output} ) ; then
513            IGCM_debug_Print 1 "IGCM_config_PeriodStart" "RErun an old job. DEBUG of DEV mode."
514        fi
515    fi
516
517    IGCM_debug_PopStack "IGCM_config_PeriodStart"
518}
519
520#===================================
521function IGCM_config_PeriodEnd
522{
523    IGCM_debug_PushStack "IGCM_config_PeriodEnd"
524
525    echo
526    IGCM_debug_Print 1 "IGCM_config_PeriodEnd :"
527    echo
528
529    if ( ${FirstInitialize} ) ; then
530        # It's no more the first time
531        FirstInitialize=false
532    fi
533
534    #==================================#
535    #         Save Job output          #
536    #==================================#
537    IGCM_sys_Put_Out ${Exe_Output} ${R_OUT_KSH}/${PREFIX}_${Exe_Output}
538    eval FileToBeDeleted[${#FileToBeDeleted[@]}]="${Exe_Output}"
539
540    IGCM_sys_Put_Out ${SUBMIT_DIR}/run.card ${R_OUT_KSH}/run.card rw
541   
542    typeset LS_comp LS_bin ExeDate ExeCpuLog ExeSize NextExeSize LastCompExeSize
543    typeset comp i   
544    typeset ExeNameIn ExeNameOut
545
546    #==================================#
547    #        Get last Exe Size         #
548    #==================================#
549
550    if [ ${DRYRUN} -le 1 ] ; then
551        (( i=0 ))
552        if ( ${FirstInitialize} ) ; then
553            run_Log_LastExeSize=""
554            for comp in ${config_ListOfComponents[*]} ; do
555                run_Log_LastExeSize[$i]=0
556                (( i=i+1 ))
557            done
558        else
559            IGCM_card_DefineArrayFromOption ${SUBMIT_DIR}/run.card Log LastExeSize
560        fi
561    fi
562    #==================================#
563    #         And Build ExeDate        #
564    #==================================#
565
566    # ExeDate = ATM_Jun_12_09:34-SRF_Jun_12_09:34-OCE_Jun_12_09:34-ICE_Jun_12_09:34-CPL_Jun_12_09:33
567    # Would be nice to have next line but no way to format ls output (need to ls -l --time-style "+%Y-%m-%dT%H:%M")
568    # ExeDate = ATM_2009-06-12T09:34+SRF_2009-06-12T09:34+OCE_2009-06-12T09:34+ICE_2009-06-12T09:34+CPL_2009-06-12T09:34
569    ExeDate=""
570    NextExeSize="( "
571    (( i=0 ))
572
573    for comp in ${config_ListOfComponents[*]} ; do
574
575        IGCM_debug_Print 1 ${comp}
576
577        eval ExeNameIn=\${config_Executable_${comp}[0]}
578        eval ExeNameOut=\${config_Executable_${comp}[1]}
579        # Only if we really have an executable for the component :
580        if [ X${ExeNameIn} = X\"\" ] ; then
581            # If there is no exe file for this component
582            (( ExeSize=0 ))
583        else
584            eval LS_bin=${R_EXE}/${ExeNameIn}
585            IGCM_sys_FileSize ${LS_bin} ExeSize
586
587            set +A LS_comp -- $( LC_TIME=en_US ls -l ${LS_bin} )
588            if [ X${ExeDate} = X ] ; then 
589                # First component exe date
590                ExeDate=${comp}_${LS_comp[5]}_${LS_comp[6]}
591            else
592                ExeDate=${ExeDate}-${comp}_${LS_comp[5]}_${LS_comp[6]}
593            fi
594            ExeDate=${ExeDate}_${LS_comp[7]}
595        fi
596
597        if [ ${i} -eq 0 ] ; then
598            # First component
599            NextExeSize="( "${ExeSize}
600        else
601            NextExeSize=${NextExeSize}", "${ExeSize}
602        fi
603        eval LastCompExeSize=${run_Log_LastExeSize[$i]}
604        (( i=i+1 ))
605
606        if [ ${DRYRUN} -le 1 ] ; then
607            if [ ${ExeSize} -ne ${LastCompExeSize} ] ; then
608                if ( ${FirstInitialize} ) ; then
609                    IGCM_debug_Print 1 "Put first ${ExeNameIn} in ${R_OUT_EXE} !"
610                else
611                    IGCM_debug_Print 1 "${ExeNameIn} has changed in ${R_EXE} !"
612                    eval FileToBeDeleted[${#FileToBeDeleted[@]}]=${ExeNameOut}
613                fi
614                eval IGCM_sys_Put_Out ${ExeNameOut} ${R_OUT_EXE}/${PREFIX}_${ExeNameIn} rw
615            fi
616        fi
617    done
618
619    if [ ${DRYRUN} -le 1 ] ; then
620        tail -1500 ${Exe_Output} > ${Exe_Output}_tail.txt
621        ExeCpuLog=$( gawk -f ${libIGCM}/libIGCM_sys/IGCM_add_out.awk ${Exe_Output}_tail.txt )
622        RET=$?
623        if [ $RET -eq 0 ] ; then
624            # ExeCpuLog variable contents 5 fields
625            echo "${CumulPeriod} ${PeriodDateBegin} ${PeriodDateEnd} ${ExeCpuLog} ${ExeDate}" |   \
626             gawk '{printf("# %11d | %15s | %15s | %19s | %19s | %15.5f | %15.5f | %15.5f | %s\n", \
627                              $1,$2,$3,$4,$5,$6,$7,$8,$9)}' >> ${SUBMIT_DIR}/run.card
628        fi
629        eval FileToBeDeleted[${#FileToBeDeleted[@]}]="${Exe_Output}_tail.txt"
630    fi
631
632    NextExeSize=${NextExeSize}" )"
633    IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Log LastExeSize "${NextExeSize}"
634
635    # All was right ? no ? then we stop.
636    IGCM_debug_Verif_Exit
637
638    # If all was OK, we can delete all files not necessary for next Job
639    IGCM_debug_Print 1 "Files that will be deleted before next period-run : "
640
641    if [ ${DRYRUN} -le 2 ] ; then
642        for f in ${FileToBeDeleted[@]} ; do [ -f ${f} ] && ls -la $f ; [ -f ${f} ] && rm -f $f ; done
643    else
644        echo ${FileToBeDeleted[@]}
645    fi
646
647    #=================================================#
648    #         Modification of libIGCM behaviour       #
649    #=================================================#
650
651    # To use this function, one must copy libIGCM.card from ${libIGCM} directory
652    # and put it in ${SUBMIT_DIR} directory. Ater modifications of ${SUBMIT_DIR}/libIGCM.card,
653    # variables define inside [UserChanges] will be modified for next Period of libIGCM main loop.
654    if [ -f ${SUBMIT_DIR}/libIGCM.card ] ; then
655        echo
656        echo "########################################################################"
657        echo "!!!                 Modification of libIGCM behaviour                !!!"
658        echo
659
660        IGCM_debug_Print 1 "DefineArrayFromOption  : libIGCM_UserChanges in libIGCM.card"
661        IGCM_card_DefineArrayFromSection ${SUBMIT_DIR}/libIGCM.card UserChanges
662        IGCM_debug_Print 2 "libIGCM_UserChanges" ${libIGCM_UserChanges[*]}
663
664        # Special treatments for libIGCM internals
665        for option in ${libIGCM_UserChanges[*]} ; do
666            IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/libIGCM.card UserChanges ${option}
667
668            echo "We will change : ${option}."
669            eval echo "Previous value : " \${${option}}
670            eval echo "Change to : " \${libIGCM_UserChanges_${option}}
671           
672            eval ${option}=\${libIGCM_UserChanges_${option}}
673
674            case ${option} in
675                config_UserChoices_DateEnd)
676                    IGCM_debug_PrintVariables 3 config_UserChoices_DateEnd
677                    DateEnd=$( IGCM_date_ConvertFormatToGregorian ${config_UserChoices_DateEnd} )
678
679                    # Period Length In Days between DateBegin and DateEnd
680                    (( ExperienceLengthInDays=$( IGCM_date_DaysBetweenGregorianDate ${DateEnd} ${DateBegin} )  + 1 ))
681                    if [ ${ExperienceLengthInDays} -lt 0 ] ; then
682                        IGCM_debug_Print 1 "Problem with dates in libIGCM.card : ${DateEnd} < ${DateBegin} ! You must check that."
683                        IGCM_debug_Exit "IGCM_PeriodEnd" " Wrong Dates."
684                        IGCM_debug_Verif_Exit
685                    fi
686                    ;;
687                config_UserChoices_PeriodLength)
688                    ;;
689                PeriodNb)
690                    IGCM_debug_Print 3  "Loop in main Job with ${PeriodNb} period(s)"
691                    ;;
692                config_Post_RebuildFrequency)
693                    IGCM_debug_Print 3  "Change config_Post_RebuildFrequency=${config_Post_RebuildFrequency} : IGCM_post_Configure"
694                    IGCM_post_Configure
695                    ;;
696                config_Post_TimeSeriesFrequency)
697                    IGCM_debug_Print 3  "Change config_Post_TimeSeriesFrequency = ${config_Post_TimeSeriesFrequency} : IGCM_post_Initialize"
698                    IGCM_post_Configure
699                    ;;
700                config_Post_SeasonalFrequency)
701                    IGCM_debug_Print 3  "Change config_Post_SeasonalFrequency = ${config_Post_SeasonalFrequency} : IGCM_post_Initialize"
702                    IGCM_post_Configure
703                    ;;
704            esac
705        done
706
707        echo
708        echo "########################################################################"
709        echo
710    fi
711
712    #=================================================#
713    #         Determine next computed period          #
714    #=================================================#
715
716    PeriodDateBegin=$( IGCM_date_AddDaysToGregorianDate ${PeriodDateEnd} 1 )
717    IGCM_date_GetYearMonth $PeriodDateBegin year month
718    year_m1=$(( year - 1 ))
719    year_p1=$(( year + 1 ))
720    IGCM_config_Analyse_PeriodLength
721    PeriodDateEnd=$( IGCM_date_AddDaysToGregorianDate ${PeriodDateBegin} $(( ${PeriodLengthInDays} - 1 )) )
722
723    # Debug Print :
724    echo
725    IGCM_debug_Print 1 "IGCM_config_PeriodEnd : Preparing Next Execution"
726    IGCM_debug_Print 3 "PeriodDateBegin       : ${PeriodDateBegin}"
727    IGCM_debug_Print 3 "PeriodDateEnd         : ${PeriodDateEnd}"
728    IGCM_debug_Print 3 "PeriodLengthInDays    : ${PeriodLengthInDays}"
729
730    PeriodDateBegin=$( IGCM_date_ConvertFormatToHuman ${PeriodDateBegin} )
731    PeriodDateEnd=$( IGCM_date_ConvertFormatToHuman ${PeriodDateEnd} )
732
733    (( CumulPeriod = CumulPeriod + 1 ))
734
735    # Debug Print :
736    echo
737    IGCM_debug_Print 3 "PeriodDateBegin Human : ${PeriodDateBegin}"
738    IGCM_debug_Print 3 "PeriodDateEnd Human   : ${PeriodDateEnd}"
739    IGCM_debug_Print 3 "CumulPeriod           : ${CumulPeriod}"
740
741    #=================================================#
742    #             Write updated run.card              #
743    #=================================================#
744
745    IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration OldPrefix ${OldPrefix}
746    IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration PeriodDateBegin ${PeriodDateBegin}
747    IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration PeriodDateEnd ${PeriodDateEnd}
748    IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration CumulPeriod ${CumulPeriod}
749
750    IGCM_debug_PopStack "IGCM_config_PeriodEnd"
751}
752
753#===================================
754function IGCM_config_Finalize
755{
756    IGCM_debug_PushStack "IGCM_config_Finalize"
757
758    echo
759    IGCM_debug_Print 1 "IGCM_config_Finalize :"
760    echo
761
762    if [ ${SimulationLengthInDays} -ge ${ExperienceLengthInDays} ] ; then
763        #==========================#
764        # End of entire simulation #
765        #==========================#
766
767        # Mail notification
768        IGCM_sys_SendMail
769
770        #
771        IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration PeriodState "Completed"
772        IGCM_debug_Print 1 "Normal End of computation."
773        if ( $DEBUG_debug ) ; then
774            echo
775            IGCM_debug_Print 1 "Your files on ${R_OUT} :"
776            IGCM_sys_Tree ${R_SAVE}
777        fi
778    else
779        #=================#
780        # Submit next job #
781        #=================#
782
783        IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration PeriodState "OnQueue"
784
785        # Name of next Ksh Script output :
786        eval Script_Output="${Script_Output_Prefix}_${config_UserChoices_JobName}.$( printf "%06d" ${CumulPeriod} )"
787
788        IGCM_debug_Print 1 "Submit next job"
789        # SUBMIT NEXT JOB from SUBMIT_DIR and come back in RUN_DIR
790        IGCM_sys_Cd ${SUBMIT_DIR}
791        # Keep only the 5 latest ${Script_Output_Prefix}_${config_UserChoices_JobName}
792        ScriptTot=$( ls ${Script_Output_Prefix}_${config_UserChoices_JobName}.?????? 2>/dev/null | wc -l )
793        [ ${ScriptTot} -gt 5 ] && rm -f $( ls ${Script_Output_Prefix}_${config_UserChoices_JobName}.?????? | head -$(( ${ScriptTot} - 5 )) )
794        # Submit next job and come back
795        IGCM_sys_Qsub ${SUBMIT_DIR}/Job_${config_UserChoices_JobName}
796        IGCM_sys_Cd -
797    fi
798
799    # Supress Non Deleted Boundary files
800    if [ ${DRYRUN} -le 2 ] ; then
801        IGCM_comp_DelFixeBoundaryFiles
802        ls -la
803    fi
804   
805    # Clean ${RUN_DIR}=${RUN_DIR_PATH}/${config_UserChoices_TagName}/${config_UserChoices_JobName}
806    # Only for production run (No clean up in DEV or DEB mode)
807    # and command sent from .. directory.
808    IGCM_sys_Cd ..
809    [ X${JobType} = XRUN ] && IGCM_sys_Rm -rf ${RUN_DIR}
810
811    IGCM_debug_PopStack "IGCM_config_Finalize"
812}
813
814#===================================
Note: See TracBrowser for help on using the repository browser.