summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Brett <matthew.brett@gmail.com>2016-02-13 15:15:59 -0800
committerMatthew Brett <matthew.brett@gmail.com>2016-03-07 15:18:10 -0800
commit2932da9766ebb253d8a83b6633137c8b91c2b5e3 (patch)
tree63617c2326cdb147d888f07a66f642460bdf75f3
parent9d6cdc1946073dd6fc5195a18f77785800d71db2 (diff)
downloadnumpy-2932da9766ebb253d8a83b6633137c8b91c2b5e3.tar.gz
DOC: description of _distribution_init for release
Add description of ``numpy/_distribution_init.py`` file and init hook to release notes for 1.12.0.
-rw-r--r--doc/release/1.12.0-notes.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/release/1.12.0-notes.rst b/doc/release/1.12.0-notes.rst
index 62c056c55..754427370 100644
--- a/doc/release/1.12.0-notes.rst
+++ b/doc/release/1.12.0-notes.rst
@@ -106,6 +106,18 @@ Building against the BLAS implementation provided by the BLIS library is now
supported. See the ``[blis]`` section in ``site.cfg.example`` (in the root of
the numpy repo or source distribution).
+Hook in ``numpy/__init__.py`` to run distribution-specific checks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Binary distributions of numpy may need to run specific hardware checks or load
+specific libraries during numpy initialization. For example, if we are
+distributing numpy with a BLAS library that requires SSE2 instructions, we
+would like to check the machine on which numpy is running does have SSE2 in
+order to give an informative error.
+
+Add a hook in ``numpy/__init__.py`` to import a ``numpy/_distributor_init.py``
+file that will remain empty (bar a docstring) in the standard numpy source,
+but that can be overwritten by people making binary distributions of numpy.
Improvements
============