This software was produced by NIST, an agency of the U.S. government,
and by statute is not subject to copyright in the United States.
Recipients of this software assume all responsibilities associated
with its operation, modification and maintenance. However, to
facilitate maintenance we ask that before distributing modified
versions of this software, you first contact the authors at
oof_manager@nist.gov.

------------------------------------------------------------------------------

This directory contains tests that ensure that OOF2 is installed and
is running correctly.  The tests in this directory only test aspects
of the program that are not related to graphical user interface.  The
GUI subdirectory contains tests for the user interface.

To run the tests, type

    oof2-test

This will run the full suite of tests and create a lot of output.  The
tests were successful if the last output line is "All tests completed
successfully!"  It is not necessary to be in this directory to run the
tests.

It's not necessary to run the whole test suite every time. To get
a list of the individual parts of the suite, type

    oof2-test --list

You can run any one of the tests by typing

    oof2-test <name>

where <name> is the name of the test as reported by --list.  You can
run more than one test

    oof2-test <name1> <name2>

You don't need to type the full name of a test.  Test names can be
abbreviated using Python regular expressions.  For example,
 
    oof2-test "micro.*"

is equivalent to

    oof2-test microstructure_test
    
For other options, type

    oof2-test --help

If any of the tests fail, please send a note to oof_bugs@nist.gov.
Include the output from the test, and let us know the OOF2 version
number, what kind of computer you're using (including the operating
system, compiler, and python version numbers), and how you built and
installed OOF2.

To run the graphical tests, read the TODO file in the GUI subdirectory.