ecearth3/sources/tm5mp/tools/ttb/README

TTB - TM Test Bench
===================

DESCRIPTION

  Tools to test TM5 runs while working on the code.

USAGE

  (0) The script:
        
        ttb/bin/ttb_compare.py

      let you compare two hdf or netCDF files. It can be called from the
      command line:

         ttb_compare.py file1 file2

      or as a module inside other python script:

         import ttb_compare

         try:
             ttb_compare.df_files(r1.restart, r2.restart)
         except:
             print "\n  FAILED"
         else:
             print "\n  SUCCESS"


  (1) Typical usage of TTB is:

          bin/ttb  rc/ttb.rc
     
      The 'ttb' script is able to setup and submit one or more TM runs,
      and afterwards check the output of the run(s) on differences.
      Setup of the runs is defined through a rcfile, see 'rc/ttb.rc'
      for inspiration.


  (2) A more general TM5 class (rctm5) is also available. It is an extension
      of the RcFile class available in rc.py, which add TM5 dedicated derived
      attributes, and methods. See header for tips.


HISTORY
  2010, Arjo Segers
  2011, Philippe Le Sager for 'rctm5' class, a simplified version of the one
          found in the 'obsolete' subdir.