Changeset 2500 for branches/nemo_v3_3_beta/NEMOGCM/SETTE/sette.sh

Timestamp:

2010-12-21T16:58:15+01:00 (13 years ago)

Author:

flavoni

Message:

changed comments in SETTE scripts, to have doc with sphinx, see ticket #752

File:

• branches/nemo_v3_3_beta/NEMOGCM/SETTE/sette.sh (modified) (4 diffs)

branches/nemo_v3_3_beta/NEMOGCM/SETTE/sette.sh

@@ +1 @@
+#!/bin/sh
+#############################################################
+# Author : Simona Flavoni for NEMO
+# Contact : sflod@locean-ipsl.upmc.fr
+#
+# sette.sh   : principal script of SET TEsts for NEMO (SETTE)
+#############################################################
+#set -x
+set -o posix
+#set -u
+#set -e
+#+
+#
+# ================
+# sette.sh
+# ================
+#
+# ----------------------------------------------
+# Set of tests for NEMO
+# ----------------------------------------------
+#
+# SYNOPSIS
+# ========
+#
+# ::
+#
+#  $ ./sette.sh
+#
+# DESCRIPTION
+# ===========
+#
+#
+# EXAMPLES
+# ========
+#
+# ::
+#
+#  $ ./sette.sh 
 #
 #
@@ -6 +44 @@
 # option debug
 #
-#
 # EVOLUTIONS
 # ==========
 #
-# $Id: sette.sh 2158 2010-10-28 12:30:03Z sflod $
+# $Id$
 #
 #   * creation
+#
 #-
 #
-# This is the principal script of SETTE 
-# here are described some examples to run nemo
-# this script creates MY_CONFIG directory and in this one there is VALIDATION directory
-# in which are stored output files
-# at this point of developpement there is no automatic diff of solver.stat files
-# user have to set duration of the run with set_namelist function
-# and if he wants to do a restart (again with set_namelist function)
-# and then he has to compare by hand output solver.stat
-#
-# USER MODIFICATIONS
-# in sette.sh script :
-#     SETTE_DIR : base directory for SETTE
-#     makenemo -m : machine (compilator); see ./makenemo -m help 
-#         -n : config name (in examples config_name_nproci_nprocj), see ./makenemo -n help 
-#         -r : reference configuration (if you don't give it you have to choise directories to install)
-#         add_key : to add list of keys (for example to test reproductibility: add_key mpp_rep)
-#         del_key : to del list of keys
-#     and for more details and options of makenemo see ./makenemo -h
-#     set_namelist : to set namelist values 
-                        (example : to set 75 time steps for one test : namelist nn_itend 75)
-                        (        : to change cn_icerst_in name : namelist_ice cn_icerst_in  \"test_00101231_restart_icemod.nc\")
-                        (        : to activate control print : namelist ln_ctl \".false.\" )
-#     fcm_job.sh needs input: input_CONFIG_NAME and TOTAL NUMBER OF PROCS used
-#
-SETTE_DIR=PATH OF SETTE
+SETTE_DIR=/PATH/OF/SETTE
 
-echo "starting first test"
-sleep 3
-
-# first example: create test for GYRE with nproci=1, nprocj=1, run for 75 time steps
 cd ${SETTE_DIR}
 . ../CONFIG/makenemo -m ifort_linux -n GYRE_1_1 -r GYRE
@@ -54 +64 @@
 cd ${SETTE_DIR}
 . ./fcm_job.sh input_GYRE.cfg 1
-echo "finished first test"
-echo "###################"
-sleep 3
 
-echo "starting second test"
-sleep 3
-
-# second example: create test for ORCA2_LIM with nproci=1, nprocj=2, run for 75 time steps
 cd ${SETTE_DIR}
 . ../CONFIG/makenemo -n ORCA2_LIM_1_2 add_key "key_mpp_mpi key_nproci=1 key_nprocj=2"
@@ -71 +74 @@
 cd ${SETTE_DIR}
 . ./fcm_job.sh input_ORCA2_LIM.cfg 2
-echo "finished second test"
-sleep 3