Skip to content

Commit 3123456

Browse files
author
Ben Cipollini
committed
DOC: add documentation of advanced testing.
1 parent 795580f commit 3123456

File tree

3 files changed

+43
-1
lines changed

3 files changed

+43
-1
lines changed

doc/source/devel/advanced_testing.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. -*- mode: rst -*-
2+
.. ex: set sts=4 ts=4 sw=4 et tw=79:
3+
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
4+
#
5+
# See COPYING file distributed along with the NiBabel package for the
6+
# copyright and license terms.
7+
#
8+
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
9+
10+
.. _advanced_testing:
11+
12+
************
13+
Advanced Testing
14+
************
15+
16+
Setup
17+
-----
18+
19+
Before running advanced tests, please update all submodules of nibabel, by running ``git submodule update --init``
20+
21+
22+
Long-running tests
23+
------------------
24+
25+
Long-running tests are not enabled by default, and can be resource-intensive. To run these tests:
26+
27+
* Set environment variable ``NIPY_EXTRA_TESTS=slow``
28+
* Run ``nosetests``.
29+
30+
Note that some tests may require a machine with >4GB of RAM.
31+
32+
.. include:: ../links_names.txt

doc/source/devel/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ Developer documentation page
1414
add_image_format
1515
devdiscuss
1616
make_release
17+
advanced_testing

doc/source/installation.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,11 @@ Just install the modules by invoking::
114114
If sudo is not configured (or even installed) you might have to use
115115
``su`` instead.
116116

117-
Now fire up Python and try importing the module to see if everything is fine.
117+
118+
Validating your install
119+
-----------------------
120+
121+
For a basic test of your installation, fire up Python and try importing the module to see if everything is fine.
118122
It should look something like this::
119123

120124
Python 2.7.8 (v2.7.8:ee879c0ffa11, Jun 29 2014, 21:07:35)
@@ -123,4 +127,9 @@ It should look something like this::
123127
>>> import nibabel
124128
>>>
125129

130+
131+
To run the nibabel test suite, from the terminal run ``nosetests nibabel`` or ``python -c "import nibabel; nibabel.test()``.
132+
133+
To run an extended test suite that validates ``nibabel`` for long-running and resource-intensive cases, please see :ref:`advanced_testing`.
134+
126135
.. include:: links_names.txt

0 commit comments

Comments
 (0)