New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
all_functions.sh in branches/2013/dev_MERGE_2013/NEMOGCM/SETTE – NEMO

source: branches/2013/dev_MERGE_2013/NEMOGCM/SETTE/all_functions.sh @ 4310

Last change on this file since 4310 was 4245, checked in by cetlod, 10 years ago

dev_locean_cmcc_ingv_ukmo_merc : merge in the MERC_UKMO dev branch with trunk rev 4119
  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 14.7 KB
Line 
1######################################################
2# Author : Simona Flavoni for NEMO
3# Contact : sflod@locean-ipsl.upmc.fr
4#
5# ----------------------------------------------------------------------
6# NEMO/SETTE , NEMO Consortium (2010)
7# Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
8# ----------------------------------------------------------------------
9#
10# Some scripts called by sette.sh
11# all_functions.sh   : all functions used by sette.sh 
12######################################################
13#set -x
14set -o posix
15#set -u
16#set -e
17#+
18#
19# ================
20# all_functions.sh
21# ================
22#
23# ----------------------------------------------
24# Set of functions used by sette.sh (NEMO tests)
25# ----------------------------------------------
26#
27# SYNOPSIS
28# ========
29#
30# ::
31#
32#  $ ./set_namelist INPUT_NAMELIST VARIABLE VALUE
33#  $ post_test_tidyup
34#
35#
36# DESCRIPTION
37# ===========
38#
39# function superegrep
40#   input variable value
41#
42# function set_namelist
43#   input namelist_name variable value
44#   output namelist
45#
46# function post_test_tidyup
47#   creates nemo_validation tree, and save output & debug files
48#   this function creates tree of validation in NEMO_VALIDATION_DIR as follows :
49#
50# NEMO_VALIDATION_DIR/WCONFIG_NAME/WCOMPILER_NAME/REVISION_NUMBER(or DATE)/TEST_NAME
51#
52# NEMO_VALIDATION_DIR           : is choosen in param.cfg
53#
54# WCONFIG_NAME                  : set by makenemo at the moment of compilation
55#
56# WCOMPILER_NAME                : set by makenemo at the moment of compilation
57#
58# REVISION_NUMBER(or DATE)      : revision number by svn info, if problems with svn date is taken
59#
60# TEST_NAME                     : set in sette.sh for each configuration to be tested (directory TEST_NAME is created under ${NEW_CONF} directory )
61#
62# EXAMPLES
63# ========
64#
65# ::
66#
67#  $ ./set_namelist namelist          nn_itend        75
68#  $ ./set_namelist namelist_ice_lim2 cn_icerst_in  \"00101231_restart_ice\"
69#  $ post_test_tidyup
70#
71#
72# TODO
73# ====
74#
75# option debug
76#
77#
78# EVOLUTIONS
79# ==========
80#
81# $Id$
82#
83#   * creation
84#-
85# function to find namelists parameters
86supergrep () {
87            grep "^ *$1 *=" $2 | sed -e "s% *\!.*%%"
88    }
89
90usage=" Usage : set_namelist input_namelist variable_name value"
91usage=" if value is a string ths is neede syntax : ./set_namelist namelist_name var_name \"new_value\" "
92
93# function to set namelists parameters
94set_namelist () {
95   minargcount=3
96   if [ ${#} -lt ${minargcount} ]
97   then
98      echo "not enough arguments for set_namelist"
99      echo "${usage}"
100      exit 1
101   fi
102   unset minargcount
103   if [  ! -f ${SETTE_DIR}/output.sette ] ; then
104                touch ${SETTE_DIR}/output.sette
105        fi
106
107        echo "executing script : set_namelist $@" >> ${SETTE_DIR}/output.sette
108        echo "################" >> ${SETTE_DIR}/output.sette
109     
110   VAR_NAME=$( supergrep $2 ${EXE_DIR}/$1 )
111   if [ ${#VAR_NAME} -eq 0 ] 
112   then
113      echo "doing \"set_namelist $@\". "  >> ${SETTE_DIR}/output.sette
114      echo "variable: \"$2\" not found in \"${EXE_DIR}/$1\" "  >> ${SETTE_DIR}/output.sette
115                NAMREF=$( basename $1 _cfg )_ref
116      echo "doing more : search in ${EXE_DIR}/$NAMREF " >> ${SETTE_DIR}/output.sette
117                VAR_NAME=$( supergrep $2 ${EXE_DIR}/$NAMREF )
118           if [ ${#VAR_NAME} -eq 0 ] 
119           then
120                    echo " variable $VAR_NAME not found in ${EXE_DIR}/$1 nor in ${EXE_DIR}/$NAMREF "
121                    echo " check your variable name "
122            echo "exit"
123            echo "error in executing script : set_namelist $@" >> ${SETTE_DIR}/output.sette
124            echo "....." >> ${SETTE_DIR}/output.sette
125            exit 1
126                fi
127                LINEVAR=$( grep -s -n "$VAR_NAME" ${EXE_DIR}/$NAMREF | awk -F: '{ { print $1} }' )
128                echo " $VAR_NAME found in ${EXE_DIR}/$NAMREF at line $LINEVAR " >> ${SETTE_DIR}/output.sette
129#   search for namelist group name
130                NAMGRP=$( head -n$LINEVAR ${EXE_DIR}/$NAMREF | grep --line-buffered "^&nam" | tail -1 | awk -F" " '{ { print $1} }' ) 
131                echo " variable $VAR_NAME will be added in $NAMGRP namelist-group of namelist file ${EXE_DIR}/$1 " >> ${SETTE_DIR}/output.sette
132# Add $VARNAME in namelist file ${EXE_DIR}/$1 in namelist group $NAMGRP
133# on mac osx, replace sed --posix by gsed (available with mac port)
134set -vx
135                sed --posix "/${NAMGRP} /a\ ${VAR_NAME} " ${EXE_DIR}/$1 > ${EXE_DIR}/$1.tmp || gsed --posix "/${NAMGRP} /a\ ${VAR_NAME} " ${EXE_DIR}/$1 > ${EXE_DIR}/$1.tmp
136set +vx
137# if file not empty replace ${EXE_DIR}/$1
138                if [ -s ${EXE_DIR}/$1.tmp ] ; then
139                   mv ${EXE_DIR}/$1.tmp ${EXE_DIR}/$1 
140                else
141                echo "file ${EXE_DIR}/$1.tmp is empty. sed command went wrong "; exit 200
142                fi
143   fi
144
145        sed -e "s:${VAR_NAME}.*:${VAR_NAME}:" ${EXE_DIR}/$1 > ${EXE_DIR}/$1.tmp
146        mv ${EXE_DIR}/$1.tmp ${EXE_DIR}/$1
147        sed -e "s:${VAR_NAME}:$2=$3:"  ${EXE_DIR}/$1 > ${EXE_DIR}/$1.tmp
148        mv ${EXE_DIR}/$1.tmp ${EXE_DIR}/$1
149
150        echo "finished script : set_namelist $@" >> ${SETTE_DIR}/output.sette
151        echo "++++++++++++++++" >> ${SETTE_DIR}/output.sette
152        echo "                " >> ${SETTE_DIR}/output.sette
153}
154
155
156# function to tidy up after each test and populate the NEMO_VALIDATION store
157post_test_tidyup () {
158#
159# requires the following variables defined and exported from the calling script:
160#  SETTE_DIR
161#  INPUT_DIR
162#  EXE_DIR
163#  CONFIG_DIR
164#  NEMO_VALIDATION_DIR
165#  NEW_CONF
166#  CMP_NAM
167#  TEST_NAME
168echo "SETTE directory is : ${SETTE_DIR}"
169echo "INPUT directory is : ${INPUT_DIR}"
170echo "EXECUTION directory is : ${EXE_DIR}"
171echo "CONFIG directory is : ${CONFIG_DIR}"
172echo "VALIDATION directory is : ${NEMO_VALIDATION_DIR}"
173echo "NEW CONFIGURATION is : ${NEW_CONF}"
174echo "COMPILER is : ${CMP_NAM}"
175echo "TEST is : ${TEST_NAME}"
176################################################################
177# SMALL DEBUG
178    if [ ! -r ${EXE_DIR}/ocean.output ]
179        then
180        grep "E R R O R" ${EXE_DIR}/ocean.output && echo "Some ERRORS at execution time, see ${EXE_DIR}/ocean.output"
181        exit 2
182    fi
183
184    if [ ! -r ${EXE_DIR}/time.step ]
185        then
186        echo "file time.step does not exist"   >> ${SETTE_DIR}/output.sette
187        echo "some problems during execution of model"  >> ${SETTE_DIR}/output.sette
188        exit 1
189    else
190        echo "file time.step exists"  >> ${SETTE_DIR}/output.sette
191        echo "execution of model time step loop started"   >> ${SETTE_DIR}/output.sette
192    fi
193
194################################################################
195
196################################################################
197# Creation of NEMO_VALIDATION tree
198    export LANG=en_US
199    cd ${CONFIG_DIR}
200    cd ../
201    REVISION_NB=`svn info | grep -i "Revision:" | sed -e "s/ //" | cut -d ":" -f 2`
202    if [ ${#REVISION_NB} -eq 0 ]
203    then
204      echo "some problems with svn info command"
205      echo "some problems with svn info command" >> ${SETTE_DIR}/output.sette
206      REVISION_NB=`date +%Y%m%d`
207      echo "put in ${REVISION_NB} date"
208      echo "put in ${REVISION_NB} date" >> ${SETTE_DIR}/output.sette
209    else
210    echo "value of revision number of NEMOGCM: ${REVISION_NB}"
211    fi
212    cd ${NEMO_VALIDATION_DIR}
213    `mkdir -p ${NEMO_VALIDATION_DIR}/W${NEW_CONF}/${CMP_NAM}/${REVISION_NB}/${TEST_NAME}`
214    NEMO_VALID=${NEMO_VALIDATION_DIR}/W${NEW_CONF}/${CMP_NAM}/${REVISION_NB}/${TEST_NAME}
215    if [ -d ${NEMO_VALID} ] ; then
216   echo "created ${NEMO_VALID} directory"   >> ${SETTE_DIR}/output.sette
217    else
218   echo "problems in creating ${NEMO_VALID} directory"   >> ${SETTE_DIR}/output.sette
219   echo "EXIT,"
220   exit 1
221    fi
222    # Save output & debug files in NEMO_VALIDATION tree
223    echo "saving ocean & ice output, solver.stat, tracer.stat files ...." >> ${SETTE_DIR}/output.sette
224    echo "            " >> ${SETTE_DIR}/output.sette
225    [ -f ${EXE_DIR}/ocean.output ] && cp ${EXE_DIR}/*ocean.output ${NEMO_VALID}/.
226    [ -f ${EXE_DIR}/solver.stat ] && cp ${EXE_DIR}/*solver.stat ${NEMO_VALID}/.
227    [ -f ${EXE_DIR}/output.namelist.dyn ] && cp ${EXE_DIR}/*output.nam* ${NEMO_VALID}/.
228    [ -f ${EXE_DIR}/tracer.stat ] && cp ${EXE_DIR}/*tracer.stat ${NEMO_VALID}/.
229
230    if [ -n "$(ls ${NEMO_VALID}/*solver*)" ] ; then
231   echo "moved solver.stat in ${NEMO_VALID} directory"  >> ${SETTE_DIR}/output.sette
232   echo "moved solver.stat in ${NEMO_VALID} directory" 
233    else
234   echo "problem in looking for solver.stat file in ${NEMO_VALID} directory"  >> ${SETTE_DIR}/output.sette
235   echo "solver.stat IS NOT in ${NEMO_VALID} directory" 
236    fi
237    if [ -n "$(ls ${NEMO_VALID}/*ocean.output*)" ] ; then
238   echo "moved ocean.output in ${NEMO_VALID} directory"  >> ${SETTE_DIR}/output.sette
239   echo "moved ocean.output in ${NEMO_VALID} directory" 
240    else
241   echo "problem in looking for ocean.output file in ${NEMO_VALID} directory"  >> ${SETTE_DIR}/output.sette
242   echo "ocean.output IS NOT in ${NEMO_VALID} directory" 
243    fi
244    if [ -n "$(ls ${NEMO_VALID}/*tracer.stat*)" ] ; then
245        echo "moved tracer.stat in ${NEMO_VALID} directory"  >> ${SETTE_DIR}/output.sette
246        echo "moved tracer.stat in ${NEMO_VALID} directory"
247    else
248        echo "problem in looking for tracer.stat file in ${NEMO_VALID} directory"  >> ${SETTE_DIR}/output.sette
249        echo "tracer.stat IS NOT in ${NEMO_VALID} directory"
250    fi
251}
252
253#############################################################
254# extra functions to manipulate settings in the iodef.xml file
255#
256# Examples:
257#   set_xio_file_type    iodef.xml one_file
258#   set_xio_using_server iodef.xml true
259#   set_xio_buffer_size  iodef.xml 50000000
260#
261#############################################################
262
263usage2=" Usage : set_xio_file_type input_iodef.xml one_file||multiple_file"
264usage3=" Usage : set_xio_using_server input_iodef.xml true||false"
265usage4=" Usage : set_xio_buffer_size input_iodef.xml int_buffer_size"
266
267set_xio_file_type () {
268        minargcount=2
269        if [ ${#} -lt ${minargcount} ]
270        then
271                echo "not enough arguments for set_xio_file_type"
272                echo "${usage2}"
273                exit 1
274        fi
275        if [ $2 != "one_file" ] && [ $2 != "multiple_file" ]
276        then
277                echo "unrecognised argument for set_xio_file_type"
278                echo "${usage2}"
279                echo $2
280                exit 1
281        fi
282        unset minargcount
283        if [  ! -f ${SETTE_DIR}/output.sette ] ; then
284                touch ${SETTE_DIR}/output.sette
285        fi
286
287        echo "executing script : set_xio_file_type $@" >> ${SETTE_DIR}/output.sette
288        echo "################" >> ${SETTE_DIR}/output.sette
289
290        VAR_NAME=$( grep "^.*<.*file_definition.*type.*=" ${EXE_DIR}/$1 | sed -e "s% *\!.*%%" )
291        if [ ${#VAR_NAME} -eq 0 ]
292        then
293                echo "doing \"set_xio_file_type $@\". "
294                echo "xml_tag: file_definition with variable: type is empty"
295                echo "confirm that an appropriate file_definition is in \"${EXE_DIR}/$1\" "
296                echo "exit"
297                echo "error in executing script : set_xio_file_type $@" >> ${SETTE_DIR}/output.sette
298                echo "....." >> ${SETTE_DIR}/output.sette
299                exit 1
300        fi
301        if [ $2 == "one_file" ] 
302        then
303           sed -e "s:multiple_file:one_file:" ${EXE_DIR}/$1 > ${EXE_DIR}/$1.tmp
304        else
305           sed -e "s:one_file:multiple_file:" ${EXE_DIR}/$1 > ${EXE_DIR}/$1.tmp
306        fi
307        mv ${EXE_DIR}/$1.tmp ${EXE_DIR}/$1
308
309        echo "finished script : set_xio_file_type $@" >> ${SETTE_DIR}/output.sette
310        echo "++++++++++++++++" >> ${SETTE_DIR}/output.sette
311        echo "                " >> ${SETTE_DIR}/output.sette
312}
313
314set_xio_using_server () {
315        minargcount=2
316        if [ ${#} -lt ${minargcount} ]
317        then
318                echo "not enough arguments for set_xio_using_server"
319                echo "${usage2}"
320                exit 1
321        fi
322        if [ $2 != "true" ] && [ $2 != "false" ]
323        then
324                echo "unrecognised argument for set_xio_using_server"
325                echo "${usage2}"
326                echo $2
327                exit 1
328        fi
329        unset minargcount
330        if [  ! -f ${SETTE_DIR}/output.sette ] ; then
331                touch ${SETTE_DIR}/output.sette
332        fi
333
334        echo "executing script : set_xio_using_server $@" >> ${SETTE_DIR}/output.sette
335        echo "################" >> ${SETTE_DIR}/output.sette
336
337        VAR_NAME=$( grep "^.*<.*variable id.*=.*using_server.*=.*boolean" ${EXE_DIR}/$1 | sed -e "s% *\!.*%%" )
338        if [ ${#VAR_NAME} -eq 0 ]
339        then
340                echo "doing \"set_xio_using_server $@\". "
341                echo "xml_tag: "variable id=using_server" with variable: boolean is empty"
342                echo "confirm that an appropriate variable id is in \"${EXE_DIR}/$1\" "
343                echo "exit"
344                echo "error in executing script : set_xio_using_server $@" >> ${SETTE_DIR}/output.sette
345                echo "....." >> ${SETTE_DIR}/output.sette
346                exit 1
347        fi
348        if [ $2 == "false" ]
349        then
350           sed -e "/using_server/s:true:false:" ${EXE_DIR}/$1 > ${EXE_DIR}/$1.tmp
351           export USING_MPMD=no
352        else
353           sed -e "/using_server/s:false:true:" ${EXE_DIR}/$1 > ${EXE_DIR}/$1.tmp
354           export USING_MPMD=yes
355        fi
356        mv ${EXE_DIR}/$1.tmp ${EXE_DIR}/$1
357
358        echo "finished script : set_xio_using_server $@" >> ${SETTE_DIR}/output.sette
359        echo "++++++++++++++++" >> ${SETTE_DIR}/output.sette
360        echo "                " >> ${SETTE_DIR}/output.sette
361}
362
363set_xio_buffer_size () {
364        minargcount=2
365        if [ ${#} -lt ${minargcount} ]
366        then
367                echo "not enough arguments for set_xio_buffer_size"
368                echo "${usage4}"
369                exit 1
370        fi
371        unset minargcount
372        if [  ! -f ${SETTE_DIR}/output.sette ] ; then
373                touch ${SETTE_DIR}/output.sette
374        fi
375
376        echo "executing script : set_xio_buffer_size $@" >> ${SETTE_DIR}/output.sette
377        echo "################" >> ${SETTE_DIR}/output.sette
378
379        VAR_NAME=$( grep "^.*<.*variable id.*=.*buffer_size.*=.*integer" ${EXE_DIR}/$1 | sed -e "s% *\!.*%%" )
380        if [ ${#VAR_NAME} -eq 0 ]
381        then
382                echo "doing \"set_xio_buffer_size $@\". "
383                echo "xml_tag: "variable id=buffer_size" with variable: integer is empty"
384                echo "confirm that an appropriate variable id is in \"${EXE_DIR}/$1\" "
385                echo "exit"
386                echo "error in executing script : set_xio_buffer_size $@" >> ${SETTE_DIR}/output.sette
387                echo "....." >> ${SETTE_DIR}/output.sette
388                exit 1
389        fi
390        sed -e "/buffer_size/s:>.*<:>$2<:" ${EXE_DIR}/$1 > ${EXE_DIR}/$1.tmp
391        mv ${EXE_DIR}/$1.tmp ${EXE_DIR}/$1
392
393        echo "finished script : set_xio_buffer_size $@" >> ${SETTE_DIR}/output.sette
394        echo "++++++++++++++++" >> ${SETTE_DIR}/output.sette
395        echo "                " >> ${SETTE_DIR}/output.sette
396}
397
Note: See TracBrowser for help on using the repository browser.