From 387298bff059dc20c40f38ffe4dc0e2d4f0b6503 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Wed, 10 Apr 2013 22:23:51 -0400 Subject: [PATCH] Added readme to tests directory. --- tests/readme.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 tests/readme.rst diff --git a/tests/readme.rst b/tests/readme.rst new file mode 100644 index 000000000..fcc4d737f --- /dev/null +++ b/tests/readme.rst @@ -0,0 +1,32 @@ +================= +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 by no means +complete and should not be viewed as a comprehensive unit test suite will full +coverage. Until more effort can be put into actual unit testing, this suite is a +simple means of making sure that new features added into the code don't break +existing features. + +The test suite is designed to run with the third-party Python package +nose_. Running the test suite is as simple as going to the tests/ directory and +running: + +.. sh:: + nosetests + +However, usually testing is split into two parts: compilation and running. To +run the compilation tests, use: + +.. sh:: + nosetests test_compile + +Then, to run all the normal tests (which require that an OpenMC executable is +already built): + +.. sh:: + nosetests --exclude-dir=test_compile + +.. _nose: https://nose.readthedocs.org