[Numpy-svn] r8579 - in branches/1.5.x/doc/source: reference user

numpy-svn@scip... numpy-svn@scip...
Sun Aug 1 06:20:19 CDT 2010


Author: rgommers
Date: 2010-08-01 06:20:19 -0500 (Sun, 01 Aug 2010)
New Revision: 8579

Modified:
   branches/1.5.x/doc/source/reference/arrays.dtypes.rst
   branches/1.5.x/doc/source/user/basics.byteswapping.rst
   branches/1.5.x/doc/source/user/index.rst
   branches/1.5.x/doc/source/user/install.rst
Log:
DOC: wiki merge, rst docs.

Modified: branches/1.5.x/doc/source/reference/arrays.dtypes.rst
===================================================================
--- branches/1.5.x/doc/source/reference/arrays.dtypes.rst	2010-08-01 11:20:00 UTC (rev 8578)
+++ branches/1.5.x/doc/source/reference/arrays.dtypes.rst	2010-08-01 11:20:19 UTC (rev 8579)
@@ -246,7 +246,7 @@
    on the shape if it is greater than 1-d. NumPy allows a modification
    on the format in that any string that can uniquely identify the
    type can be used to specify the data-type in a field.
-   The generated data-type fields are named ``'f0'``, ``'f2'``, ...,
+   The generated data-type fields are named ``'f0'``, ``'f1'``, ...,
    ``'f<N-1>'`` where N (>1) is the number of comma-separated basic
    formats in the string. If the optional shape specifier is provided,
    then the data-type for the corresponding field describes a sub-array.

Modified: branches/1.5.x/doc/source/user/basics.byteswapping.rst
===================================================================
--- branches/1.5.x/doc/source/user/basics.byteswapping.rst	2010-08-01 11:20:00 UTC (rev 8578)
+++ branches/1.5.x/doc/source/user/basics.byteswapping.rst	2010-08-01 11:20:19 UTC (rev 8579)
@@ -1,5 +1,5 @@
-************
-Broadcasting
-************
+*************
+Byte-swapping
+*************
 
 .. automodule:: numpy.doc.byteswapping

Modified: branches/1.5.x/doc/source/user/index.rst
===================================================================
--- branches/1.5.x/doc/source/user/index.rst	2010-08-01 11:20:00 UTC (rev 8578)
+++ branches/1.5.x/doc/source/user/index.rst	2010-08-01 11:20:19 UTC (rev 8579)
@@ -13,12 +13,16 @@
 
    This "User Guide" is still a work in progress; some of the material
    is not organized, and several aspects of NumPy are not yet covered
-   in sufficient detail. However, we are continually working to
-   improve the documentation.
+   sufficient detail.  We are an open source community continually
+   working to improve the documentation and eagerly encourage interested
+   parties to contribute.  For information on how to do so, please visit
+   the NumPy `doc wiki <http://docs.scipy.org/numpy/Front%20Page>`_.
 
    More documentation for NumPy can be found on the `numpy.org
    <http://www.numpy.org>`__ website.
 
+   Thanks!
+
 .. toctree::
    :maxdepth: 2
 

Modified: branches/1.5.x/doc/source/user/install.rst
===================================================================
--- branches/1.5.x/doc/source/user/install.rst	2010-08-01 11:20:00 UTC (rev 8578)
+++ branches/1.5.x/doc/source/user/install.rst	2010-08-01 11:20:19 UTC (rev 8579)
@@ -15,11 +15,21 @@
 <http://www.enthought.com/products/epd.php>`_ (which provides binary
 installers for Windows, OS X and Redhat) and `Python (x, y)
 <http://www.pythonxy.com>`_. Both of these packages include Python, NumPy and
-many additional packages. A lightweight alternative is to download the Python
+many additional packages.
+
+A lightweight alternative is to download the Python
 installer from `www.python.org <http://www.python.org>`_ and the NumPy
 installer for your Python version from the Sourceforge `download site <http://
 sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103>`_
 
+The NumPy installer includes binaries for different CPU's (without SSE
+instructions, with SSE2 or with SSE3) and installs the correct one
+automatically. If needed, this can be bypassed from the command line with ::
+
+  numpy-<1.y.z>-superpack-win32.exe /arch nosse
+
+or 'sse2' or 'sse3' instead of 'nosse'.
+
 Linux
 -----
 
@@ -95,15 +105,15 @@
 Choosing the fortran compiler
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To build with g77:
+To build with g77::
 
     python setup.py build --fcompiler=gnu
 
-To build with gfortran:
+To build with gfortran::
 
     python setup.py build --fcompiler=gnu95
 
-For more information see:
+For more information see::
 
     python setup.py build --help-fcompiler
 
@@ -116,19 +126,27 @@
 has been used. If both are dependencies, this means both have been used, which
 is almost always a very bad idea.
 
+Disabling ATLAS and other accelerater libraries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Usage of ATLAS and other accelerated libraries in Numpy can be disabled
+via::
+
+    BLAS=None LAPACK=None ATLAS=None python setup.py build
+
 Building with ATLAS support
 ---------------------------
 
 Ubuntu 8.10 (Intrepid) and 9.04 (Jaunty)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You can install the necessary packages for optimized ATLAS with this command:
+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 suppport (SSE, SSE2, etc...), you should
 also install the corresponding package for optimal performances. For example,
-for SSE2:
+for SSE2::
 
     sudo apt-get install libatlas3gf-sse2
 
@@ -142,12 +160,12 @@
 Ubuntu 8.04 and lower
 ~~~~~~~~~~~~~~~~~~~~~
 
-You can install the necessary packages for optimized ATLAS with this command:
+You can install the necessary packages for optimized ATLAS with this command::
 
     sudo apt-get install atlas3-base-dev
 
 If you have a recent CPU with SIMD suppport (SSE, SSE2, etc...), you should
 also install the corresponding package for optimal performances. For example,
-for SSE2:
+for SSE2::
 
     sudo apt-get install atlas3-sse2



More information about the Numpy-svn mailing list