Changeset 5761 for branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST/trusting_help.txt

Timestamp:

2015-09-24T17:34:59+02:00 (9 years ago)

Author:

nicolasmartin

Message:

Add help section

File:

• branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST/trusting_help.txt (modified) (1 diff)

branches/2015/dev_r5092_CNRS_SETTE/NEMOGCM/TRUST/trusting_help.txt

@@ -1 @@
-----------------------------------------------------------------------------
-Usage: trusting [-h] [-d] [-p] configuration
+Usage: ./trusting.sh -m $ARCH -u $USER [OPTIONS]
+Launch trusting test on $ARCH machine from $USER installation
+Example: './trusting.sh -m X64_CURIE -u romr005 -p -b nemo_v3_6_STABLE'
 
-# ($ARCH & ./cfg/$ARCH.cfg file and at least arch-$ARCH.fcm file in NEMO ARCH dir are mandatory)
+Mandatory (default settings):
+    Files to source in ./config ($ARCH.cfg & $USER.cfg)
+    -m,--machine    Architecture settings (environment configuration)
+    -u,--user       User            ""    (NEMO directories & settings)       
 
-Options:
-   -h, --help, -help
-       Print this manual
-   -d, --debug
-       set -v
-   -p, --publish
-       Publish on dods server
+SVN working copy:
+    -b,--branch       SVN branch to test (trunk|nemo_v3_6_STABLE|...
+    -v,--version    Action on working copy ('svn status' by default)
+               '{'YYYY-MM-DD'}' Update to revision available at this date
+               [0-9]*              ""   "" revision number
+               HEAD|up|update     ""   "" last revision
+               st|status    Show differences with repository
 
-Examples:"
-   $ trusting -p IPSLCM5A
+NEMO Configuration:
+    -a,--archive    Forcing input files archive to extract downloaded from ESGF/DODS server 
+    -n,--newconf    Testing   configuration created in ./CONFIG
+    -r,--refconf    Reference      " "     
 
-Notes:
-   - To reset the trusting dashboard, type manually :
-     $ rm -rf $CCCWORKDIR/trusting/configuration
-     $ rm -rf $CCCWORKDIR/../../dods/public/${LOGNAME}/trusting/configuration
-   - Output will be saved at :
-     $ ls $CCCSTOREDIR/IGCM_OUT
+Compiling & computation:
+    -j,--job        Number of processes for compiling
+    -t,--time       Timeout for computation (s)
+
+Output control:
+    -d,--debug      Verbose output for debugging purpose (`set -vx`)
+    -e,--email      Email trusting digest report to following addresses only on failure
+    -h,--help       Print this help & exit
+    -p,--publish    Share trusting result