Annotation of /MITgcm_contrib/timing/README

A series of scripts to process the STDOUT* files of MITgcm when the
"-ts" or "-papis"/"-pcls" flags were used with genmake2.

To install place the *.awk files in a directory $HOME/awk and the rest
of the mitgcm_* files in a directory $HOME/bin and make sure the
latter is in your path.

All scripts produce the number of time series data points used for
statistics followed by:

arithmetic mean, standard deviation, geometric mean, minimum, maximum

In the case of mitgcm_time, three sets of the above statistics are
produced on one line, each within parentheses, for user time, system
time and wallclock time per timestep.

mitgcm_time:            user, system and wallclock time per timestep stats
mitgcm_mflops:          user Mflop/s per timestep stats
mitgcm_mflops_w:        wallclock Mflop/s per timestep stats
mitgcm_mflops2:         user Mflop/s per timestep stats (adjoint mode)
mitgcm_mflops_w2:       wallclock Mflop/s per timestep stats (adjoint mode)
mitgcm_ipc:             user IPC per timestep stats
mitgcm_ipc_w:           wallclock IPC per timestep stats
mitgcm_ipc2:            user IPC per timestep stats (adjoint mode)
mitgcm_ipc_w2:          wallclock IPC per timestep stats (adjoint mode)

To use

script_name STDOUT_filename 

or

script_name STDOUT_filename start firstn skip

where "start" is the timestep number assigned to the first occurence of
the Mflop/s or IPC information in the STDOUT_filename, "firstn" is the
timestep number that specifies how many of the initial timesteps are
ignored for the purpose of generating statistics and "skip" is used to
specify a period between timing or counter information that is to be
skipped because for example it contains a lot of I/O and skews the
statistics. The default values are 1, 1 and 1000000 respectively. A
careful choice of these 3 should handle most cases.

The mitgcm_mflops(_w) scripts automatically discard the very first
hardware performance counter information that precedes any timestep.

STDOUT_filename can be a file compressed with compress (.Z) or gzip
(.gz) and the script transparently handles that.
1	ce107	1.1	A series of scripts to process the STDOUT* files of MITgcm when the
2			"-ts" or "-papis"/"-pcls" flags were used with genmake2.
3
4			To install place the *.awk files in a directory $HOME/awk and the rest
5			of the mitgcm_* files in a directory $HOME/bin and make sure the
6			latter is in your path.
7
8			All scripts produce the number of time series data points used for
9			statistics followed by:
10
11			arithmetic mean, standard deviation, geometric mean, minimum, maximum
12
13			In the case of mitgcm_time, three sets of the above statistics are
14			produced on one line, each within parentheses, for user time, system
15			time and wallclock time per timestep.
16
17			mitgcm_time: user, system and wallclock time per timestep stats
18			mitgcm_mflops: user Mflop/s per timestep stats
19			mitgcm_mflops_w: wallclock Mflop/s per timestep stats
20			mitgcm_mflops2: user Mflop/s per timestep stats (adjoint mode)
21			mitgcm_mflops_w2: wallclock Mflop/s per timestep stats (adjoint mode)
22			mitgcm_ipc: user IPC per timestep stats
23			mitgcm_ipc_w: wallclock IPC per timestep stats
24			mitgcm_ipc2: user IPC per timestep stats (adjoint mode)
25			mitgcm_ipc_w2: wallclock IPC per timestep stats (adjoint mode)
26
27			To use
28
29			script_name STDOUT_filename
30
31			or
32
33			script_name STDOUT_filename start firstn skip
34
35			where "start" is the timestep number assigned to the first occurence of
36			the Mflop/s or IPC information in the STDOUT_filename, "firstn" is the
37			timestep number that specifies how many of the initial timesteps are
38			ignored for the purpose of generating statistics and "skip" is used to
39			specify a period between timing or counter information that is to be
40			skipped because for example it contains a lot of I/O and skews the
41			statistics. The default values are 1, 1 and 1000000 respectively. A
42			careful choice of these 3 should handle most cases.
43
44			The mitgcm_mflops(_w) scripts automatically discard the very first
45			hardware performance counter information that precedes any timestep.
46
47			STDOUT_filename can be a file compressed with compress (.Z) or gzip
48			(.gz) and the script transparently handles that.