From b12d0784116d7740a4ce3be18925d0cf7e7db5df Mon Sep 17 00:00:00 2001
From: Stefan van der Walt <stefan@sun.ac.za>
Date: Wed, 14 May 2008 12:51:23 +0000
Subject: Merge docstrings from wiki.

---
 numpy/__init__.py | 63 +++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 57 insertions(+), 6 deletions(-)

(limited to 'numpy/__init__.py')

diff --git a/numpy/__init__.py b/numpy/__init__.py
index 00494fb37..c304f542d 100644
--- a/numpy/__init__.py
+++ b/numpy/__init__.py
@@ -1,14 +1,65 @@
 """
 NumPy
-==========
+=====
+
 Provides
-   1) An array object of arbitrary homogeneous items
-   2) Fast mathematical operations over arrays
-   3) Linear Algebra, Fourier Transforms, Random Number Generation
+  1. An array object of arbitrary homogeneous items
+  2. Fast mathematical operations over arrays
+  3. Linear Algebra, Fourier Transforms, Random Number Generation
+
+Documentation is available in the docstrings and at http://www.scipy.org
+
+Available subpackages
+---------------------
+core
+    Defines a multi-dimensional array and useful procedures
+    for Numerical computation.
+lib
+    Basic functions used by several sub-packages and useful
+    to have in the main name-space.
+random
+    Core Random Tools
+linalg
+    Core Linear Algebra Tools
+fft
+    Core FFT routines
+testing
+    Numpy testing tools
+
+The following sub-packages must be explicitly imported:
+
+f2py
+    Fortran to Python Interface Generator.
+distutils
+    Enhancements to distutils with support for
+    Fortran compilers support and more.
+
+
+Global symbols from subpackages
+-------------------------------
+========  =================================
+core      all (use numpy.* not numpy.core.*)
+lib       all (use numpy.* not numpy.lib.*)
+testing   NumpyTest
+========  =================================
+
+
+Utility tools
+-------------
 
-Documentation is available in the docstrings and at
+test
+    Run numpy unittests
+pkgload
+    Load numpy packages
+show_config
+    Show numpy build configuration
+dual
+    Overwrite certain functions with high-performance Scipy tools
+matlib
+    Make everything matrices.
+__version__
+    Numpy version string
 
-http://www.scipy.org
 """
 
 # We first need to detect if we're being called as part of the numpy setup
-- 
cgit v1.2.1