summaryrefslogtreecommitdiff
path: root/doc/source/dev/development_environment.rst
diff options
context:
space:
mode:
authorPauli Virtanen <pav@iki.fi>2019-12-01 14:48:25 +0200
committerPauli Virtanen <pav@iki.fi>2019-12-01 16:37:50 +0200
commita0e6571670d1af81f277df36e0d4ce6191add043 (patch)
tree5cc262d7fec45c4edc78f2110020dc4c1c5b8d5a /doc/source/dev/development_environment.rst
parent2ae28b0df570768c9c685e8ba8ee71c4717c902a (diff)
downloadnumpy-a0e6571670d1af81f277df36e0d4ce6191add043.tar.gz
DOC: document the NPY_AVAILABLE_MEM test mechanism
Diffstat (limited to 'doc/source/dev/development_environment.rst')
-rw-r--r--doc/source/dev/development_environment.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/dev/development_environment.rst b/doc/source/dev/development_environment.rst
index 874d277d8..c20b6fe40 100644
--- a/doc/source/dev/development_environment.rst
+++ b/doc/source/dev/development_environment.rst
@@ -59,6 +59,16 @@ Using ``runtests.py`` is the recommended approach to running tests.
There are also a number of alternatives to it, for example in-place
build or installing to a virtualenv. See the FAQ below for details.
+.. note::
+
+ Some of the tests in the test suite require a large amount of
+ memory, and are skipped if your system does not have enough.
+
+ To override the automatic detection of available memory, set the
+ environment variable ``NPY_AVAILABLE_MEM``, for example
+ ``NPY_AVAILABLE_MEM=32GB``, or using pytest ``--available-memory=32GB``
+ target option.
+
Building in-place
-----------------