README: USE TEST CASES
The use test cases (UTCs) are examples of how ESMF functions would be
implemented in realistic situations. They require realistic inputs and processor
counts. Unlike the unit and system tests, the UTCs routinely require large data
files that are too cumbersome to be bundled with the ESMF distribution,
necessitating that they must be checked out separately from the SourceForge
The use_test_cases module can be obtained from the main ESMF SourceForge CVS
repository by following the instructions on that page for checking out modules
by the anonymous CVS access.
cvs -z3 -d:pserver:email@example.com:/cvsroot/esmf co -P -rREVISIONTAG use_test_cases
The above cvs command specifies a REVISIONTAG indicating the precise tag that
is downloaded. This REVISIONTAG must match the ESMF version you are using. For
instance, if you are using ESMF version 2.2.2r you must specify ESMF_2_2_2r as
the REVISIONTAG when downloading the UTC sources.
BUILDING AND RUNNING
The makefiles included in the UTC source tree are designed to link into the
ESMF library build system. For this integration to work seamlessly it is
required that the use_test_cases directory created by the above cvs command be
placed into the ESMF source tree under the ./src subdirectory. In case the
cvs command was not executed while in ./src the use_test_cases directory should
be moved into ./src before proceeding.
The integration of the UTC makefiles into the ESMF library build system
furthermore requires that the appropriate ESMF_ environment variables are set
prior to building or running the use test cases. Please consult the main ESMF
README and the ESMF User's Guide for details.
In addition to these common ESMF_ environment variables one further environment
variable exists that only applies to the execution of use test cases:
ESMF_MAX_PROCS - if set it will serve as the upper limit up to which
processor count UTC targets will be run.
The UTC makefile targets are:
use_test_cases : build and run UTCs
use_test_cases_uni : build UTCs and run them in uni-processor mode
build_use_test_cases : build UTCs (don't run)
run_use_test_cases : run UTCs (don't build)
run_use_test_cases_uni : run UTCs in uni-processor mode (don't build)
clean_use_test_cases : remove UTC executables only