summaryrefslogtreecommitdiff
path: root/INSTALL.txt
diff options
context:
space:
mode:
authorJulian Taylor <jtaylor.debian@googlemail.com>2014-10-14 01:09:15 +0200
committerJulian Taylor <jtaylor.debian@googlemail.com>2014-10-28 22:24:40 +0100
commit461bf423e1e8caae40f6f624f925644e95a0256d (patch)
tree410aacf122033c076ea7a70ce9d884cfb09633f4 /INSTALL.txt
parent23d546176e2fe0b4d7d2e9100032bbf8107927e1 (diff)
downloadnumpy-461bf423e1e8caae40f6f624f925644e95a0256d.tar.gz
DOC: update installation instructions
Diffstat (limited to 'INSTALL.txt')
-rw-r--r--INSTALL.txt63
1 files changed, 36 insertions, 27 deletions
diff --git a/INSTALL.txt b/INSTALL.txt
index 278aab9ef..9c12ba602 100644
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -35,6 +35,21 @@ Building NumPy requires the following software installed:
Python__ http://www.python.org
nose__ http://somethingaboutorange.com/mrl/projects/nose/
+Basic Installation
+==================
+
+To install numpy run:
+
+ python setup.py build -j 4 install --prefix $HOME/.local
+
+This will compile numpy on 4 CPUs and install it into the specified prefix.
+To perform an inplace build that can be run from the source folder run:
+
+ python setup.py build_ext --inplace -j 4
+
+The number of build jobs can also be specified via the environment variable
+NPY_NUM_BUILD_JOBS.
+
Fortran ABI mismatch
====================
@@ -65,40 +80,34 @@ this means that g77 has been used. If libgfortran.so is a dependency,
gfortran has been used. If both are dependencies, this means both have been
used, which is almost always a very bad idea.
-Building with ATLAS support
-===========================
-
-Ubuntu 8.10 (Intrepid)
-----------------------
-
-You can install the necessary packages for optimized ATLAS with this
-command:
-
- sudo apt-get install libatlas-base-dev
-
-If you have a recent CPU with SIMD support (SSE, SSE2, etc...), you should
-also install the corresponding package for optimal performance. For
-example, for SSE2:
+Building with optimized BLAS support
+====================================
- sudo apt-get install libatlas3gf-sse2
+Ubuntu/Debian
+-------------
-*NOTE*: if you build your own atlas, Intrepid changed its default fortran
-compiler to gfortran. So you should rebuild everything from scratch,
-including lapack, to use it on Intrepid.
+In order to build with optimized a BLAS providing development package must be installed.
+Options are for example:
-Ubuntu 8.04 and lower
----------------------
+ - libblas-dev
+ reference BLAS not very optimized
+ - libatlas-base-dev
+ generic tuned ATLAS, it is recommended to tune it to the available hardware,
+ see /usr/share/doc/libatlas3-base/README.Debian for instructions
+ - libopenblas-base
+ fast and runtime detected so no tuning required but as of version 2.11 still
+ suffers from correctness issues on some CPUs, test your applications
+ thoughly.
-You can install the necessary packages for optimized ATLAS with this
-command:
+The actual implementation can be exchanged also after installation via the
+alternatives mechanism:
- sudo apt-get install atlas3-base-dev
+ update-alternatives --config libblas.so.3
+ update-alternatives --config liblapack.so.3
-If you have a recent CPU with SIMD support (SSE, SSE2, etc...), you should
-also install the corresponding package for optimal performance. For
-example, for SSE2:
+Or by preloading a specific BLAS library with
+ LD_PRELOAD=/usr/lib/atlas-base/atlas/libblas.so.3 python ...
- sudo apt-get install atlas3-sse2
Windows 64 bits notes
=====================