File	Date	Author	Commit
ESMF_Arb2ArbGridRedist	2020-01-03	Silverio Vasquez	[292676] Update Copyright to 2002-2020.
ESMF_AttributeCIM2ESG	2016-02-12	Ryan O'Kuinghttons	[284e33] add NOTE about broken documentation links
ESMF_BundleRedist	2020-01-03	Silverio Vasquez	[292676] Update Copyright to 2002-2020.
ESMF_ComponentHierarchy	2019-02-19	Gerhard Theurich	[b4bed2] Enable the ESMF_ComponentHierarchy UTC for nigh...
ESMF_Regrid	2014-08-07	Silverio Vasquez	[62bcf0] Change makefiles so that the perl script that p...
ESMF_SparseMatMul	2020-01-03	Silverio Vasquez	[292676] Update Copyright to 2002-2020.
ESMF_StateBenchOps	2014-08-07	Silverio Vasquez	[62bcf0] Change makefiles so that the perl script that p...
ESMF_StateBenchReconcile	2019-02-12	Walter Spector	[9e2a73] Ensure wall times are used for reconcile timing...
ESMF_StateReconcile	2020-01-03	Silverio Vasquez	[292676] Update Copyright to 2002-2020.
ESMF_WaterML	2017-05-19	Ryan O'Kuinghttons	[15c3fd] change to ESMF_AttCopy_Flag
scripts	2019-02-13	Silverio Vasquez	[8de66d] Added missing "@".
README	2020-05-15	Gerhard Theurich	[7a952b] Fix outdated info and get ready for the 8.0.1 r...
makefile	2019-02-19	Gerhard Theurich	[b4bed2] Enable the ESMF_ComponentHierarchy UTC for nigh...

Read Me

============================================================================

           README:  USE TEST CASES
      REVISIONTAG:  ESMF_8_0_1

============================================================================

PURPOSE
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
repository.

DOWNLOAD
The use_test_cases module can be obtained from the SourceForge Git repository:

git clone https://git.code.sf.net/p/esmf/use_test_cases --branch <REVISIONTAG> --depth 1

REVISIONTAG
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 8.0.0 you must specify ESMF_8_0_0 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)
 dry_run_use_test_cases : obtain large data files needed to run, in case that
                          the run target is executed on nodes with restricted 
                          internet access
 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


================================================================================
$Id$