diff --git a/docs/source/devguide/workflow.rst b/docs/source/devguide/workflow.rst index b3733fab8b..78dfb6b5f3 100644 --- a/docs/source/devguide/workflow.rst +++ b/docs/source/devguide/workflow.rst @@ -38,7 +38,7 @@ following criteria must be satisfied for all proposed changes: - Changes have a clear purpose and are useful. - Compiles under all conditions (MPI, OpenMP, HDF5, etc.). This is checked as - part of the test suite (see `test_compile.py`_). + part of the test suite. - Passes the regression suite. - If appropriate, test cases are added to regression suite. - No memory leaks (checked with valgrind_). @@ -152,7 +152,6 @@ from your private repository into a public fork. .. _git: http://git-scm.com/ .. _GitHub: https://github.com/ .. _git flow: http://nvie.com/git-model -.. _test_compile.py: https://github.com/mit-crpg/openmc/blob/develop/tests/test_compile/test_compile.py .. _valgrind: http://valgrind.org/ .. _style guide: http://mit-crpg.github.io/openmc/devguide/styleguide.html .. _pull request: https://help.github.com/articles/using-pull-requests diff --git a/tests/readme.rst b/tests/readme.rst index 139a6da2a8..3a340582b7 100644 --- a/tests/readme.rst +++ b/tests/readme.rst @@ -5,7 +5,7 @@ OpenMC Test Suite The purpose of this test suite is to ensure that OpenMC compiles using various combinations of compiler flags and options and that all user input options can be used successfully without breaking the code. The test suite is based on -regression or integrated testing where different types of input files are +regression or integrated testing where different types of input files are configured and the full OpenMC code is executed. Results from simulations are compared with expected results. The test suite is comprised of many build configurations (e.g. debug, mpi, hdf5) and the actual tests which @@ -14,27 +14,31 @@ reside in sub-directories in the tests directory. The test suite is designed to integrate with cmake using ctest_. To run the full test suite run: -.. sh:: +.. code-block:: sh + python run_tests.py A subset of build configurations and/or tests can be run. To see how to use the script run: -.. sh:: +.. code-block:: sh + python run_tests.py --help As an example, say we want to run all tests with debug flags only on tests -that have cone and plot in their name. Also, we would like to run this on +that have cone and plot in their name. Also, we would like to run this on 4 processors. We can run: -.. sh:: +.. code-block:: sh + python run_tests.py -j 4 -C debug -R "cone|plot" Note that standard regular expression syntax is used for selecting build configurations and tests. To print out a list of build configurations, we can run: -.. sh:: +.. code-block:: sh + python run_tests.py -p .. _ctest: http://www.cmake.org/cmake/help/v2.8.8/ctest.html