setenv <infile> <path name>
setenv <reportfile> <path name>
m3stat [<infile> [<reportfile>]] [<DEFAULT>]
<and respond to the prompts>
where infile is the logical name
of the input file, and reportfile is the logical name of the
report file (to which the statistical report is printed).
If reportfile is not present, the report will go either to
the log file (if it is set) or
to the screen. If neither is present, the program will prompt the
user for both input file and report file logical names. If DEFAULT
is the last command-line argument, then m3stat does the
default statistical analysis.
For what fraction of the grid does OZONE in this file exceed 0.120?
For each time step for each selected variable, the program reports statistics on that variable to the program log or to an optional user-selected report file.
Before you run the program, you need to assign a logical name to the physical file names of both the input file and the report file (if any), according to Models-3 conventions, using the operation
"setenv <lname> <pname>"
The program will prompt you for the logical name you
have chosen for the input file, the logical name for the optional
report file (Enter "NONE" for the file name if you want an
interactive report or a report to the program log), and then extensively
for the options to choose; the prompts will have default responses which
can be accepted by hitting <RETURN>. The specification of
starting date and time, and duration for the analysis follow Models-3
date and time conventions.
Note that the set of analyses which can be performed by one
execution of M3STAT is quite complex, being dependent upon the
variables and other structures in the file being analyzed. If you
want to run this program in batch mode (i.e.,
from a script), the recommended way to develop the script is to
run the program once interactively while noting the pattern of
responses to prompts which generate the particular analysis you
want. The pattern of responses then becomes either a
command-input file which is redirected into the program's
execution by the script, or becomes a "here-document"
fed into the execution. The following is an excerpt of a script
which does the default analysis on /tmp/myfile.A
using the here-document approach:
...
setenv FOO /tmp/myfile.A
m3stat << !DONE
FOO
Yes, I want the default analysis
# use the default run length: entire duration of the files
!DONE
...
Source code for program m3statis available
under the GNU GPL License, Version 2,
and can be downloaded here from CMAS or
here from GitHub.
To: Models-3/EDSS I/O API: The Help Pages