Annotation of /MITgcm_contrib/jmc_script/README

Some basic scripts are gather here.

a) the restart test : "2+2=4"

script: tst_2+2
- to use in a run dir. after a successful "testreport"
- input argument: '0','1','2','3','4' or 'All':
  proceed step by step or all steps at once
- tst_2+2 (no argument) -> print "usage"
- know problems: specific restart procedure (with fizhi pkg or offline pkg)
  not yet implemented

script: do_test_2+2
- call restart test "tst_2+2" multiple times, in every test experiment.
- needs to be in MITgcm/verification (with a copy of tst_2+2i script)
  and can only be used after a successful "testreport"
- do_test_2+2 -help -> print "usage"

script: tst_2+2_cpl
 = version of tst_2+2 adapted for coupled set-up (verification/cpl_aim+ocn)

b) PBS-batch script that re-submit itself (loop).
script: runScript

- used (and tested) on myrinet-3 cluster.
- suffer from a lack of meaningful comments.
- not specially design to be general and obviously
  need to be modified/customized for each set-up.

c) A short script to split the ASCII Diagnostics-Stats output file
   into separated files (one per field) that are easy to read/load
   (e.g., in matlab, just use "load" command)
script: extract_StD
 no known dependency
+ A matlab script to load in 1 array all the separated files:
matlab-script: read_StD
 no known dependency

d) script: rn_pickup
- Rename 'pickup*.ckpt[A,B].*' files to 'pickup*.[10-digits-iter].*'
  with several selection options
- rn_pickup (no argument) -> print "usage"
1	jmc	1.6	Some basic scripts are gather here.
2
3			a) the restart test : "2+2=4"
4
5			script: tst_2+2
6			- to use in a run dir. after a successful "testreport"
7			- input argument: '0','1','2','3','4' or 'All':
8			proceed step by step or all steps at once
9			- tst_2+2 (no argument) -> print "usage"
10			- know problems: specific restart procedure (with fizhi pkg or offline pkg)
11			not yet implemented
12
13			script: do_test_2+2
14			- call restart test "tst_2+2" multiple times, in every test experiment.
15			- needs to be in MITgcm/verification (with a copy of tst_2+2i script)
16			and can only be used after a successful "testreport"
17			- do_test_2+2 -help -> print "usage"
18	jmc	1.1
19	jmc	1.5	script: tst_2+2_cpl
20	jmc	1.6	= version of tst_2+2 adapted for coupled set-up (verification/cpl_aim+ocn)
21	jmc	1.5
22	jmc	1.1	b) PBS-batch script that re-submit itself (loop).
23			script: runScript
24
25	jmc	1.6	- used (and tested) on myrinet-3 cluster.
26			- suffer from a lack of meaningful comments.
27			- not specially design to be general and obviously
28			need to be modified/customized for each set-up.
29
30	jmc	1.3	c) A short script to split the ASCII Diagnostics-Stats output file
31	jmc	1.6	into separated files (one per field) that are easy to read/load
32	jmc	1.3	(e.g., in matlab, just use "load" command)
33			script: extract_StD
34			no known dependency
35	jmc	1.6	+ A matlab script to load in 1 array all the separated files:
36	jmc	1.4	matlab-script: read_StD
37			no known dependency
38	jmc	1.3
39	jmc	1.6	d) script: rn_pickup
40			- Rename 'pickup.ckpt[A,B].' files to 'pickup.[10-digits-iter].'
41			with several selection options
42			- rn_pickup (no argument) -> print "usage"