Changeset 39

Timestamp:

11/26/08 11:06:43 (15 years ago)

Author:

pinsard

Message:

ResST comments in shell scripts

Location:

trunk

Files:

• adm (added)
• detectbarotropicmode.sh (modified) (1 diff)
• geomag.kml (modified) (1 diff, 1 prop)
• geomag_profile.sh (modified) (3 diffs)
• getmodelout.sh (modified) (5 diffs, 1 prop)
• step2_diff.sh (modified) (2 diffs)

trunk/detectbarotropicmode.sh

@@ -1 @@
-#!/bin/sh
-#
-# module :
-# build file for detection of barotropic mode
-#
-# example :
-# $ detectbarotropicmode.sh -l ${GEOMAG_OD}/list_G42 -r ORCA025 -exp G42 -g gridT \
-# -latmin -50 -latmax -30 -longmin 295 -longmax 335
-#
-# update :
+#! /bin/sh
+#
+#+
+#
+# NAME
+# ====
+#
+# detectbarotropicmode.sh - build file for detection of barotropic mode
+#
+# SYNOPSYS
+# ========
+#
+# ::
+#
+#  $ detectbarotropicmode.sh -l list -r resolution -exp experience -g grid \
+#  -latmin latmin -latmax latmax -longmin longmin -longmax longmax
+#
+# DESCRIPTION
+# ===========
+#
+#
+# EXAMPLES
+# ========
+#
+# For detection on DRAKKAR G42 experiment with ORCA025 resolution on T points
+# in the box [-50,30] [295,335]:
+# ::
+#
+#  $ detectbarotropicmode.sh -l ${GEOMAG_OD}/list_G42 -r ORCA025 -exp G42 -g gridT \
+#  -latmin -50 -latmax -30 -longmin 295 -longmax 335
+#
+# EVOLUTIONS
+# ==========
+#
 # $Id$
+#
 # pas fini ++
-# reee522 2007-11-26T11:33:42Z rhodes (IRIX64)
-# externalization of  copy of data file in getmodelout.sh
-# reee522 2007-11-26T10:55:44Z rhodes (IRIX64)
-# add ncks, ncrcat and some informations inspired by
-# http://dods.ipsl.jussieu.fr/projets_ES/misc/myls
-# fplod 2007-11-23T17:02:56Z aedon.locean-ipsl.upmc.fr (Darwin)
-# creation
+#
+# - reee522 2007-11-26T11:33:42Z rhodes (IRIX64)
+#
+#   * externalization of  copy of data file in getmodelout.sh
+#
+# - reee522 2007-11-26T10:55:44Z rhodes (IRIX64)
+#
+#   * add ncks, ncrcat and some informations inspired by
+#     http://dods.ipsl.jussieu.fr/projets_ES/misc/myls
+#
+# - fplod 2007-11-23T17:02:56Z aedon.locean-ipsl.upmc.fr (Darwin)
+#
+#   * creation
+#
+#-
 #
 command=detectbarotropicmode.sh

trunk/geomag.kml

@@ -6 +6 @@
 
 update :
+++ l'afrique et l'antarctique (20 ° Est) et entre l'australie et l'antarctique (147 ° Est)
 $Id$
 fplod 2007-11-27T10:59:53Z aedon.locean-ipsl.upmc.fr (Darwin)

trunk/geomag_profile.sh

@@ -1 @@
-# !/bin/sh -xv
-#
-# module :
+#! /bin/sh -xv
+#
+#+
+#
+# NAME
+# ====
+#
+# geomag_profile.sh - define GEOMAG environnement
+#
+# SYNOPSYS
+# ========
+#
+# Online usage
+#
+# ::
+#
+# $ . geomag_profile.sh -d directory -i indir -o outdir -t tempdir
+#
+# In ${HOME}/.profile, add the following line
+#
+# ::
+#
+# . geomag_profile.sh -d directory  -i indir -o outdir -t tempdir
+#
+# DESCRIPTION
+# ===========
+#
 # define GEOMAG environnement
 #
-# usage :
-# online usage
-# $ . geomag_profile.sh -d directory -i indir -o outdir -t tempdir
-#
-# in ${HOME}/.profile, add the following line
-# . geomag_profile.sh -d directory  -i indir -o outdir -t tempdir
-#
-# examples :
-# for fplod, on aedon.locean-ipsl.upmc.fr 
-# $ cd /usr/home/fplod/incas/geomag/geomag_ws
-# $  . geomag_profile.sh -d /usr/home/fplod/incas/geomag/geomag_ws/ -i ${HOME}/geomag_d/ -o ${HOME}/geomag_d/ -t /usr/temp/${LOGNAME}/log/
-#
-# for reee522 on rhodes.idris.fr
-# $ cd ${HOME}/incas/geomag/geomag_ws/
-# $ . geomag_profile.sh -d ${HOME}/incas/geomag/geomag_ws/ -i ${HOMEGAYA}/geomag_d/ -o ${HOMEGAYA}/geomag_d/ -t /tmp/${LOGNAME}/log/
+# ${GEOMAG}
+#
+# ${GEOMAG_LOG}
+#
+# ${GEOMAG_ID}
+#
+# ${GEOMAG_OD}
+#
+# MANPATH++
+#
+# EXAMPLES
+# ========
+#
+# For fplod, on aedon.locean-ipsl.upmc.fr:
+# ::
+#
+#  $ cd /usr/home/fplod/incas/geomag/geomag_ws
+#  $ . geomag_profile.sh -d /usr/home/fplod/incas/geomag/geomag_ws/ -i ${HOME}/geomag_d/ -o ${HOME}/geomag_d/ -t /usr/temp/${LOGNAME}/log/
+#
+# For reee522 on rhodes.idris.fr:
+# ::
+#
+#  $ cd ${HOME}/incas/geomag/geomag_ws/
+#  $ . geomag_profile.sh -d ${HOME}/incas/geomag/geomag_ws/ -i ${HOMEGAYA}/geomag_d/ -o ${HOMEGAYA}/geomag_d/ -t /tmp/${LOGNAME}/log/
+#
+#
+# FILES
+# =====
 #
 # original location
-# geomag_profile.sh sur aedon.lodyc.jussieu.fr
-#
-# update :
+# ~~~~~~~~~~~~~~~~~
+#
+# /usr/home/fplod/incas/geomag/geomag_ws/geomag_profile.sh sur aedon.locean-ipsl.upmc.fr
+#
+# EVOLUTIONS
+# ==========
+#
 # ++ option bavarde
+#
 # ++ machine dependant
+#
 # ++ besoin de posix
+#
 # ++ pas de MANPATH defini par déubt sur zeus
-# reee522 2007-06-14T14:25:00Z rhodes (IRIX64)
-# add -i, -o and -t parameters to be more flexible
-# some bug fixes
-# more checking
-# fplod 2007-03-13T16:12:41Z zeus.locean-ipsl.upmc.fr (Linux)
-# add creation of $GEOMAG_ID and $GEOMAG_OD if they don't exist
-# reee522 2006-11-23T11:41:41Z rhodes (IRIX64)
-# pas de set -o posix sur rhodes (IRIX64)
+#
 # $Id$
-# fplod 2006-03-22T10:13:38Z aedon.lodyc.jussieu.fr (Darwin)
-# creation
-#
+#
+# - reee522 2007-06-14T14:25:00Z rhodes (IRIX64)
+#
+#   * add -i, -o and -t parameters to be more flexible
+#   * some bug fixes
+#   * more checking
+#
+# - fplod 2007-03-13T16:12:41Z zeus.locean-ipsl.upmc.fr (Linux)
+#
+#   * add creation of $GEOMAG_ID and $GEOMAG_OD if they don't exist
+#
+# - reee522 2006-11-23T11:41:41Z rhodes (IRIX64)
+#
+#   * pas de set -o posix sur rhodes (IRIX64)
+#
+# - fplod 2006-03-22T10:13:38Z aedon.lodyc.jussieu.fr (Darwin)
+#
+#   * creation
+#
+#-
 #
 command=geomag_profile.sh
@@ -129 +183 @@
 GEOMAG_LOG=${tempdir}
 export GEOMAG_LOG
-if [ ! -d ${GEOMAG_LOG} ] 
+if [ ! -d ${GEOMAG_LOG} ]
 then
   mkdir -p ${GEOMAG_LOG}
   echo "${command} : iii : creation of \${GEOMAG_LOG}"
-fi 
+fi
 # check for permission on GEOMAG_LOG
 if [ ! -x ${GEOMAG_LOG} ]
@@ -154 +208 @@
 GEOMAG_ID=${indir}
 export GEOMAG_ID
-if [ ! -d ${GEOMAG_ID} ] 
+if [ ! -d ${GEOMAG_ID} ]
 then
   mkdir -p ${GEOMAG_ID}
   echo "${command} : iii : creation of \${GEOMAG_ID}"
-fi 
+fi
 # check for permission on GEOMAG_ID
 if [ ! -x ${GEOMAG_ID} ]

trunk/getmodelout.sh

@@ -1 @@
-#!/bin/sh
+#! /bin/sh
 #
-# module :
-# get model data output file in ${GEOMAG_ID)
+#+
 #
-# usage :
-# $ getmodelout.sh -r orcares -exp drakkar_exp -g grid -yearmin yyyy -yearmax yyyy -o list
+# NAME
+# ====
 #
-# example :
-# $ getmodelout.sh -r ORCA025 -exp G42 -g gridT -yearmin 9 -yearmax 10 -o ${GEOMAG_OD}/list_G42
+# getmodelout.sh - get model data output file in ${GEOMAG_ID}
 #
-# update :
+# #
+# SYNOPSYS
+# ========
+#
+# ::
+#
+#  $ getmodelout.sh -r orcares -exp drakkar_exp -g grid -yearmin yyyy -yearmax yyyy -o list
+#
+# DESCRIPTION
+# ===========
+#
+# get model data output file in ${GEOMAG_ID}
+#
+# EXAMPLES
+# ========
+#
+#
+# To get DRAKKAR G42 experiment output on grid T points beteween year 9 and 10:
+# ::
+#
+#  $ getmodelout.sh -r ORCA025 -exp G42 -g gridT -yearmin 9 -yearmax 10 -o ${GEOMAG_OD}/list_G42
+#
+# EVOLUTIONS
+# ==========
+#
 # $Id$
-# reee522 2007-11-26T11:21:37Z rhodes (IRIX64)
-# creation
-# 
+# - reee522 2007-11-26T11:21:37Z rhodes (IRIX64)
+#
+#   * creation
+#-
 #
 command=getmodelout.sh
@@ -35 +58 @@
     shift
  ;;
- -yearmin) 
+ -yearmin)
    yearmin=${2}
    shift
  ;;
- -yearmax) 
+ -yearmax)
    yearmax=${2}
    shift
  ;;
- -o) 
+ -o)
    list=${2}
    shift
@@ -83 +106 @@
 iyear=${yearmin}
 while [ ${iyear} -le ${yearmax} ]
-do 
+do
   cyear=`printf "%4.4d" ${iyear}`
   ls ${dirref}/${orcares}/${orcares}-${drakkar_exp}-S/${cyear}/${orcares}-${drakkar_exp}_y${cyear}m??d??_${grid}.nc >> ${listfull}
@@ -89 +112 @@
   # iyear=$(( ${iyear} + 1 )) ++ pas ok sur rhodes
   # iyear=$(expr  ${iyear} + 1 )  ++ pas ok sur rhodes
-  iyear=`expr  ${iyear} + 1 ` 
+  iyear=`expr  ${iyear} + 1 `
 done
 #
@@ -96 +119 @@
 #ls -l `cat ${listfull}` | \
 #awk 'NF>4 {print $5, $9}' | \
-#awk 'sum=$1/'$unitsop'+sum {printf("%08.3f '$units' -- %s\n",$1/'$unitsop', $2)} 
+#awk 'sum=$1/'$unitsop'+sum {printf("%08.3f '$units' -- %s\n",$1/'$unitsop', $2)}
 #
 # put files in ${GEOMAG_ID}
-# ++ ln cp ou scp 
-# ++ -f ou test si deja existant 
+# ++ ln cp ou scp
+# ++ -f ou test si deja existant
 for file in  `cat ${listfull}`
 do
   ln -sf ${file} ${GEOMAG_ID}
   echo ${GEOMAG_ID}/`basename ${file}` >> ${list}
-done 
+done
 #
 # end

trunk/step2_diff.sh

@@ -1 @@
-# !/bin/sh
-# module :
-# launch step2_diff.pro with year argument
+#! /bin/sh
 #
-# source :
-# step2_diff.sh
+#+
 #
-# example :
-# ./step2_diff.sh -y 1994
+# NAME
+# ====
 #
-# update :
+# step2_diff.sh - launch step2_diff.pro with year argument
+#
+#
+# SYNOPSYS
+# ========
+#
+# ::
+#
+#  $  step2_diff.sh -y year
+#
+# EXAMPLES
+# ========
+#
+# For test on year 1994:
+# ::
+#
+#  $ ./step2_diff.sh -y 1994
+#
+# FILES
+# =====
+#
+# original location
+# ~~~~~~~~~~~~~~~~~
+#
+# /usr/home/fplod/incas/geomag/geomag_ws/step2_diff.sh sur aedon.locean-ipsl.upmc.fr
+#
+# EVOLUTIONS
+# ==========
+#
 # $Id$
-# fplod 2007-08-22T08:50:02Z aedon.locean-ipsl.upmc.fr (Darwin)
-# creation to avoid retall and redefinition of file1 and file2
 #
-set -o posix
-command=$(basename ${0} .sh)
-# 
+# - fplod 2007-08-22T08:50:02Z aedon.locean-ipsl.upmc.fr (Darwin)
+#
+#   * creation to avoid retall and redefinition of file1 and file2
+#
+#-
+#
+system=$(uname)
+case "${system}" in
+AIX|IRIX64)
+ echo " www : no specific posix checking"
+;;
+*)
+ set -o posix
+;;
+esac
+#
+command=$(basename ${0})
+#
 usage=" Usage : ${command} -y year"
 #
@@ -54 +92 @@
 #
 # end
-exit 0 
+exit 0