numpy.__init__ (version 1.3.0)
index
/usr/lib/python2.6/dist-packages/numpy/__init__.py

NumPy
=====
 
Provides
  1. An array object of arbitrary homogeneous items
  2. Fast mathematical operations over arrays
  3. Linear Algebra, Fourier Transforms, Random Number Generation
 
How to use the documentation
----------------------------
Documentation is available in two forms: docstrings provided
with the code, and a loose standing reference guide, available from
`the NumPy homepage <http://www.scipy.org>`_.
 
We recommend exploring the docstrings using
`IPython <http://ipython.scipy.org>`_, an advanced Python shell with
TAB-completion and introspection capabilities.  See below for further
instructions.
 
The docstring examples assume that `numpy` has been imported as `np`::
 
  >>> import numpy as np
 
Code snippets are indicated by three greater-than signs::
 
  >>> x = x + 1
 
Use the built-in ``help`` function to view a function's docstring::
 
  >>> help(np.sort)
 
For some objects, ``np.info(obj)`` may provide additional help.  This is
particularly true if you see the line "Help on ufunc object:" at the top
of the help() page.  Ufuncs are implemented in C, not Python, for speed.
The native Python help() does not know how to view their help, but our
np.info() function does.
 
To search for documents containing a keyword, do::
 
  >>> np.lookfor('keyword')
 
General-purpose documents like a glossary and help on the basic concepts
of numpy are available under the ``doc`` sub-module::
 
  >>> from numpy import doc
  >>> help(doc)
 
Available subpackages
---------------------
doc
    Topical documentation on broadcasting, indexing, etc.
lib
    Basic functions used by several sub-packages.
random
    Core Random Tools
linalg
    Core Linear Algebra Tools
fft
    Core FFT routines
testing
    Numpy testing tools
f2py
    Fortran to Python Interface Generator.
distutils
    Enhancements to distutils with support for
    Fortran compilers support and more.
 
Utilities
---------
test
    Run numpy unittests
show_config
    Show numpy build configuration
dual
    Overwrite certain functions with high-performance Scipy tools
matlib
    Make everything matrices.
__version__
    Numpy version string
 
Viewing documentation using IPython
-----------------------------------
Start IPython with the NumPy profile (``ipython -p numpy``), which will
import `numpy` under the alias `np`.  Then, use the ``cpaste`` command to
paste examples into the shell.  To see which functions are available in
`numpy`, type ``np.<TAB>`` (where ``<TAB>`` refers to the TAB key), or use
``np.*cos*?<ENTER>`` (where ``<ENTER>`` refers to the ENTER key) to narrow
down the list.  To view the docstring for a function, use
``np.cos?<ENTER>`` (to view the docstring) and ``np.cos??<ENTER>`` (to view
the source code).
 
Copies vs. in-place operation
-----------------------------
Most of the functions in `numpy` return a copy of the array argument
(e.g., `sort`).  In-place versions of these functions are often
available as array methods, i.e. ``x = np.array([1,2,3]); x.sort()``.
Exceptions to this rule are documented.

 
Modules
       
numpy.add_newdocs
numpy.core.defchararray
numpy.core
numpy.ctypeslib
numpy.lib.scimath
numpy.fft
numpy.lib
numpy.linalg
numpy.ma
math
numpy.random
numpy.core.records

 
Functions
       
pkgload(*packages, **options)
Load one or more packages into parent package top-level namespace.
 
This function is intended to shorten the need to import many
subpackages, say of scipy, constantly with statements such as
 
  import scipy.linalg, scipy.fftpack, scipy.etc...
 
Instead, you can say:
 
  import scipy
  scipy.pkgload('linalg','fftpack',...)
 
or
 
  scipy.pkgload()
 
to load all of them in one call.
 
If a name which doesn't exist in scipy's namespace is
given, a warning is shown.
 
Parameters
----------
 *packages : arg-tuple
      the names (one or more strings) of all the modules one
      wishes to load into the top-level namespace.
 verbose= : integer
      verbosity level [default: -1].
      verbose=-1 will suspend also warnings.
 force= : bool
      when True, force reloading loaded packages [default: False].
 postpone= : bool
      when True, don't load packages [default: False]

 
Data
        __all__ = ['add_newdocs', '__version__', 'pkgload', 'PackageLoader', 'show_config', 'char', 'rec', 'memmap', 'newaxis', 'ndarray', 'flatiter', 'ufunc', 'arange', 'array', 'zeros', 'empty', 'broadcast', 'dtype', 'fromstring', 'fromfile', ...]
__file__ = '/usr/lib/python2.6/dist-packages/numpy/__init__.pyc'
__name__ = 'numpy.__init__'
__package__ = 'numpy'