Manual:External utilities:oct-run regression test.pl
From OctopusWiki
Contents |
NAME
oct-run_regression_test.pl - Script to create and run octopus regression tests
SYNOPSIS
oct-run_regression_test.pl [ option ] ... [ file ] ...
DESCRIPTION
This script is one of the octopus utilities.
This script can be used to generate and run the octopus regression tests.
The man pages of octopus and of the auxiliary octopus sub-programs (oct-something) are not intended to contain the documentation of the programs, but only their basic description. For where to find more documentation, see the "SEE ALSO" section below.
-n
- Dry run. Don't run the test. Only print what would be executed.
-v
- Run in verbose mode. Useful for debugging the script.
-h
- Show a brief summary of command line options.
-e *file*
- Specify the name of the Octopus executable. The default is octopus.
-c *file*
- Create a template for a Octopus regression test. This should always be used if you create a new regression test.
-f *file*
- This option specifies the input file for a regression test.
-d *directory*
- Use *directory* as working directory. The default is a randomly generated directory in /tmp.
-i
- Print content of the octopus inputfile which is used for the current test to stdout.
-p
- Preserve working directory. Don't clean up the temporary working directory after the run.
EXAMPLES
To create a template for a regression test run e.g.
$ oct-run_regression_test.pl -c finite_systems_3d/sodium.test
Running a test can be achieved with
$ oct-run_regression_test.pl -f finite_systems_3d/sodium.test
If a test run fails it might be useful for bug tracing to preserve the working directory of this run and to print out the input file
$ oct-run_regression_test.pl -pi -f finite_systems_3d/sodium.test
Run a MPI test with a local directory as working directory
$ oct-run_regression_test.pl -d./tmp -f benzene.test -e `pwd`/../src/octopus-mpi
AUTHOR
Written by H. Appel.
REPORTING BUGS
Report bugs to <appel@physik.fu-berlin.de>.
COPYRIGHT
Copyright (C) 2005 H. Appel.
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
SEE ALSO
The largest source of documentation is expected to be at the Octopus wiki: http://www.tddft.org/programs/octopus/wiki/.
