[Scipy-svn] r4849 - in scipy-docs/trunk: . source source/_static source/_templates

scipy-svn@scip... scipy-svn@scip...
Sun Oct 26 12:55:07 CDT 2008


Author: ptvirtan
Date: 2008-10-26 12:54:24 -0500 (Sun, 26 Oct 2008)
New Revision: 4849

Added:
   scipy-docs/trunk/Makefile
   scipy-docs/trunk/README.txt
   scipy-docs/trunk/postprocess.py
   scipy-docs/trunk/source/
   scipy-docs/trunk/source/_static/
   scipy-docs/trunk/source/_static/scipy.css
   scipy-docs/trunk/source/_static/scipyshiny_small.png
   scipy-docs/trunk/source/_templates/
   scipy-docs/trunk/source/_templates/indexsidebar.html
   scipy-docs/trunk/source/cluster.distance.rst
   scipy-docs/trunk/source/cluster.hierarchy.rst
   scipy-docs/trunk/source/cluster.rst
   scipy-docs/trunk/source/cluster.vq.rst
   scipy-docs/trunk/source/conf.py
   scipy-docs/trunk/source/constants.rst
   scipy-docs/trunk/source/fftpack.rst
   scipy-docs/trunk/source/generated/
   scipy-docs/trunk/source/index.rst
   scipy-docs/trunk/source/integrate.rst
   scipy-docs/trunk/source/interpolate.rst
   scipy-docs/trunk/source/io.rst
   scipy-docs/trunk/source/linalg.rst
   scipy-docs/trunk/source/maxentropy.rst
   scipy-docs/trunk/source/misc.rst
   scipy-docs/trunk/source/ndimage.rst
   scipy-docs/trunk/source/odr.rst
   scipy-docs/trunk/source/optimize.rst
   scipy-docs/trunk/source/signal.rst
   scipy-docs/trunk/source/sparse.linalg.rst
   scipy-docs/trunk/source/sparse.rst
   scipy-docs/trunk/source/special.rst
   scipy-docs/trunk/source/stats.rst
   scipy-docs/trunk/source/weave.rst
Log:
Import initial version of Scipy documentation

Added: scipy-docs/trunk/Makefile
===================================================================
--- scipy-docs/trunk/Makefile	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/Makefile	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,100 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = LANG=C sphinx-build
+PAPER         =
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  dist      to make a distribution-ready tree"
+	@echo "  html      to make standalone HTML files"
+	@echo "  pickle    to make pickle files (usable by e.g. sphinx-web)"
+	@echo "  htmlhelp  to make HTML files and a HTML help project"
+	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview over all changed/added/deprecated items"
+	@echo "  linkcheck to check all external links for integrity"
+
+clean:
+	-rm -rf build/* source/generated
+
+dist: html
+	test -d build/latex || make latex
+	-make -C build/latex all-pdf
+	-rm -rf build/dist
+	mkdir -p build/dist
+	cp -r build/html build/dist/reference
+	touch build/dist/index.html
+	perl -pi -e 's#^\s*(<li><a href=".*?">SciPy.*?Reference Guide.*?&raquo;</li>)$$#<li><a href="/">Numpy and Scipy Documentation</a> &raquo;</li> $$1#;' build/dist/*.html build/dist/*/*.html build/dist/*/*/*.html
+	(cd build/html && zip -9qr ../dist/scipy-html.zip .)
+	cp build/latex/*.pdf build/dist
+	cd build/dist && tar czf ../dist.tar.gz *
+
+generate: build/generate-stamp
+build/generate-stamp: $(wildcard source/*.rst) ext
+	mkdir -p build
+	./ext/autosummary_generate.py source/*.rst \
+		-p dump.xml -o source/generated 
+	touch build/generate-stamp
+
+ext:
+	svn co http://sphinx.googlecode.com/svn/contrib/trunk/numpyext ext
+
+html: generate
+	mkdir -p build/html build/doctrees
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
+	python postprocess.py html build/html/*.html
+	@echo
+	@echo "Build finished. The HTML pages are in build/html."
+
+pickle: generate
+	mkdir -p build/pickle build/doctrees
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files or run"
+	@echo "  sphinx-web build/pickle"
+	@echo "to start the sphinx-web server."
+
+web: pickle
+
+htmlhelp: generate
+	mkdir -p build/htmlhelp build/doctrees
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in build/htmlhelp."
+
+latex: generate
+	mkdir -p build/latex build/doctrees
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
+	python postprocess.py tex build/latex/*.tex
+	@echo
+	@echo "Build finished; the LaTeX files are in build/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+coverage: build
+	mkdir -p build/coverage build/doctrees
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) build/coverage
+	@echo "Coverage finished; see c.txt and python.txt in build/coverage"
+
+changes: generate
+	mkdir -p build/changes build/doctrees
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
+	@echo
+	@echo "The overview file is in build/changes."
+
+linkcheck: generate
+	mkdir -p build/linkcheck build/doctrees
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in build/linkcheck/output.txt."


Property changes on: scipy-docs/trunk/Makefile
___________________________________________________________________
Name: svn:eol-style
   + native

Added: scipy-docs/trunk/README.txt
===================================================================
--- scipy-docs/trunk/README.txt	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/README.txt	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,12 @@
+SciPy Reference Guide
+=====================
+
+Instructions
+------------
+1. Optionally download an XML dump of the newest docstrings from the doc wiki
+   at ``/pydocweb/dump`` and save it as ``dump.xml``.
+2. Run ``make html`` or ``make dist``
+
+You can also run ``summarize.py`` to see which parts of the Numpy
+namespace are documented.
+


Property changes on: scipy-docs/trunk/README.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Added: scipy-docs/trunk/postprocess.py
===================================================================
--- scipy-docs/trunk/postprocess.py	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/postprocess.py	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,54 @@
+#!/usr/bin/env python
+"""
+%prog MODE FILES...
+
+Post-processes HTML and Latex files output by Sphinx.
+MODE is either 'html' or 'tex'.
+
+"""
+import re, optparse
+
+def main():
+    p = optparse.OptionParser(__doc__)
+    options, args = p.parse_args()
+
+    if len(args) < 1:
+        p.error('no mode given')
+
+    mode = args.pop(0)
+
+    if mode not in ('html', 'tex'):
+        p.error('unknown mode %s' % mode)
+
+    for fn in args:
+        f = open(fn, 'r')
+        try:
+            if mode == 'html':
+                lines = process_html(fn, f.readlines())
+            elif mode == 'tex':
+                lines = process_tex(f.readlines())
+        finally:
+            f.close()
+
+        f = open(fn, 'w')
+        f.write("".join(lines))
+        f.close()
+
+def process_html(fn, lines):
+    return lines
+
+def process_tex(lines):
+    """
+    Remove unnecessary section titles from the LaTeX file.
+    
+    """
+    new_lines = []
+    for line in lines:
+        if re.match(r'^\\(section|subsection|subsubsection|paragraph|subparagraph){(numpy|scipy)\.', line):
+            pass # skip!
+        else:
+            new_lines.append(line)
+    return new_lines
+
+if __name__ == "__main__":
+    main()


Property changes on: scipy-docs/trunk/postprocess.py
___________________________________________________________________
Name: svn:executable
   + 

Added: scipy-docs/trunk/source/_static/scipy.css
===================================================================
--- scipy-docs/trunk/source/_static/scipy.css	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/_static/scipy.css	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,156 @@
+@import "default.css";
+
+/**
+ * Spacing fixes
+ */
+
+div.body p, div.body dd, div.body li {
+  line-height: 125%;
+}
+
+ul.simple { 
+    margin-top: 0;
+    margin-bottom: 0;
+    padding-top: 0;
+    padding-bottom: 0;
+}
+
+/* spacing around blockquoted fields in parameters/attributes/returns */
+td.field-body > blockquote {
+    margin-top: 0.1em;
+    margin-bottom: 0.5em;
+}
+
+/* spacing around example code */
+div.highlight > pre {
+    padding: 2px 5px 2px 5px;
+}
+
+/* spacing in see also definition lists */
+dl.last > dd {
+    margin-top: 1px;
+    margin-bottom: 5px;
+    margin-left: 30px;
+}
+
+/**
+ * Hide dummy toctrees 
+ */
+
+ul { 
+  padding-top: 0;
+  padding-bottom: 0;
+  margin-top: 0;
+  margin-bottom: 0;
+}
+ul li { 
+  padding-top: 0;
+  padding-bottom: 0;
+  margin-top: 0;
+  margin-bottom: 0;
+}
+ul li a.reference { 
+  padding-top: 0;
+  padding-bottom: 0;
+  margin-top: 0;
+  margin-bottom: 0;
+}
+
+/**
+ * Make high-level subsections easier to distinguish from top-level ones
+ */
+div.body h3 { 
+  background-color: transparent;
+}
+
+div.body h4 { 
+  border: none;
+  background-color: transparent;
+}
+
+/** 
+ * Scipy colors
+ */
+
+body { 
+  background-color: rgb(100,135,220);
+}
+
+div.document { 
+  background-color: rgb(230,230,230);
+}
+
+div.sphinxsidebar {
+  background-color: rgb(230,230,230);
+  overflow: hidden;
+}
+
+div.related {
+  background-color: rgb(100,135,220);
+}
+
+div.sphinxsidebar h3 {
+  color: rgb(0,102,204);
+}
+
+div.sphinxsidebar h3 a {
+  color: rgb(0,102,204);
+}
+
+div.sphinxsidebar h4 {
+  color: rgb(0,82,194);
+}
+
+div.sphinxsidebar p {
+  color: black;
+}
+
+div.sphinxsidebar a {
+  color: #355f7c;
+}
+
+div.sphinxsidebar ul.want-points {
+  list-style: disc;
+}
+
+.field-list th {
+  color: rgb(0,102,204);
+}
+
+/** 
+ * Extra admonitions 
+ */
+
+div.tip {
+  background-color: #ffffe4;
+  border: 1px solid #ee6;
+}
+
+/*
+div.admonition-example {
+    background-color: #e4ffe4;
+    border: 1px solid #ccc;
+}*/
+
+
+/**
+ * Styling for field lists
+ */
+
+table.field-list th {
+  border-left: 1px solid #aaa !important;
+  padding-left: 5px;
+}
+
+table.field-list { 
+  border-collapse: separate;
+  border-spacing: 10px;
+}
+
+/** 
+ * Styling for footnotes
+ */
+
+table.footnote td, table.footnote th {
+  border: none;
+}

Added: scipy-docs/trunk/source/_static/scipyshiny_small.png
===================================================================
(Binary files differ)


Property changes on: scipy-docs/trunk/source/_static/scipyshiny_small.png
___________________________________________________________________
Name: svn:mime-type
   + image/png

Added: scipy-docs/trunk/source/_templates/indexsidebar.html
===================================================================
--- scipy-docs/trunk/source/_templates/indexsidebar.html	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/_templates/indexsidebar.html	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,5 @@
+            <h3>Resources</h3>
+            <ul>
+              <li><a href="http://scipy.org/">Scipy.org website</a></li>
+              <li>&nbsp;</li>
+            </ul>

Added: scipy-docs/trunk/source/cluster.distance.rst
===================================================================
--- scipy-docs/trunk/source/cluster.distance.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/cluster.distance.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,6 @@
+=====================================================
+Distance computations (:mod:`scipy.cluster.distance`)
+=====================================================
+
+.. automodule:: scipy.cluster.distance
+   :members:

Added: scipy-docs/trunk/source/cluster.hierarchy.rst
===================================================================
--- scipy-docs/trunk/source/cluster.hierarchy.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/cluster.hierarchy.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,6 @@
+========================================================
+Hierarchical clustering (:mod:`scipy.cluster.hierarchy`)
+========================================================
+
+.. automodule:: scipy.cluster.hierarchy
+   :members:

Added: scipy-docs/trunk/source/cluster.rst
===================================================================
--- scipy-docs/trunk/source/cluster.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/cluster.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,11 @@
+=========================================
+Clustering package (:mod:`scipy.cluster`)
+=========================================
+
+.. toctree::
+
+   cluster.distance
+   cluster.hierarchy
+   cluster.vq
+
+.. automodule:: scipy.cluster

Added: scipy-docs/trunk/source/cluster.vq.rst
===================================================================
--- scipy-docs/trunk/source/cluster.vq.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/cluster.vq.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,6 @@
+====================================================================
+K-means clustering and vector quantization (:mod:`scipy.cluster.vq`)
+====================================================================
+
+.. automodule:: scipy.cluster.vq
+   :members:

Added: scipy-docs/trunk/source/conf.py
===================================================================
--- scipy-docs/trunk/source/conf.py	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/conf.py	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,233 @@
+# -*- coding: utf-8 -*-
+
+import sys, os
+
+# If your extensions are in another directory, add it here. If the directory
+# is relative to the documentation root, use os.path.abspath to make it
+# absolute, like shown here.
+sys.path.append(os.path.abspath('../ext'))
+
+# Check Sphinx version
+import sphinx
+if sphinx.__version__ < "0.5":
+    raise RuntimeError("Sphinx 0.5.dev or newer required")
+
+
+# -----------------------------------------------------------------------------
+# General configuration
+# -----------------------------------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath', 'numpydoc',
+              'phantom_import', 'autosummary', 'sphinx.ext.intersphinx',
+              'sphinx.ext.coverage']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General substitutions.
+project = 'SciPy'
+copyright = '2008, The Scipy community'
+
+# The default replacements for |version| and |release|, also used in various
+# other places throughout the built documents.
+#
+# The short X.Y version.
+version = '0.7'
+# The full version, including alpha/beta/rc tags.
+release = '0.7.dev'
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+default_role = "autolink"
+
+# List of directories, relative to source directories, that shouldn't be searched
+# for source files.
+exclude_dirs = []
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = False
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -----------------------------------------------------------------------------
+# HTML output
+# -----------------------------------------------------------------------------
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'scipy.css'
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+html_title = "%s v%s Reference Guide (DRAFT)" % (project, version)
+
+# The name of an image file (within the static path) to place at the top of
+# the sidebar.
+html_logo = '_static/scipyshiny_small.png'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%b %d, %Y'
+
+# Correct index page
+#html_index = "index"
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+    'index': 'indexsidebar.html'
+}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+html_additional_pages = {}
+
+# If false, no module index is generated.
+html_use_modindex = True
+
+# If true, the reST sources are included in the HTML build as _sources/<name>.
+#html_copy_source = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".html").
+html_file_suffix = '.html'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'NumPydoc'
+
+# Pngmath should try to align formulas properly
+pngmath_use_preview = True
+
+
+# -----------------------------------------------------------------------------
+# LaTeX output
+# -----------------------------------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, document class [howto/manual]).
+_stdauthor = 'Written by the SciPy community'
+latex_documents = [
+  ('index', 'scipy-ref.tex', 'SciPy Reference Guide',
+   _stdauthor, 'manual'),
+#  ('user/index', 'scipy-user.tex', 'SciPy User Guide',
+#   _stdauthor, 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+latex_preamble = r'''
+\usepackage{amsmath}
+
+% In the parameters section, place a newline after the Parameters
+% header
+\usepackage{expdlist}
+\let\latexdescription=\description
+\def\description{\latexdescription{}{} \breaklabel}
+
+% Make Examples/etc section headers smaller and more compact
+\makeatletter
+\titleformat{\paragraph}{\normalsize\py@HeaderFamily}%
+            {\py@TitleColor}{0em}{\py@TitleColor}{\py@NormalColor}
+\titlespacing*{\paragraph}{0pt}{1ex}{0pt}
+\makeatother
+
+% Fix footer/header
+\renewcommand{\chaptermark}[1]{\markboth{\MakeUppercase{\thechapter.\ #1}}{}}
+\renewcommand{\sectionmark}[1]{\markright{\MakeUppercase{\thesection.\ #1}}}
+'''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+latex_use_modindex = False
+
+
+# -----------------------------------------------------------------------------
+# Intersphinx configuration
+# -----------------------------------------------------------------------------
+intersphinx_mapping = {
+        'http://docs.python.org/dev': None,
+        'http://www.elisanet.fi/ptvirtan/tmp/numpy-refguide': None,
+}
+
+
+# -----------------------------------------------------------------------------
+# Numpy extensions
+# -----------------------------------------------------------------------------
+
+# If we want to do a phantom import from an XML file for all autodocs
+phantom_import_file = 'dump.xml'
+
+# Edit links
+#numpydoc_edit_link = '`Edit </pydocweb/doc/%(full_name)s/>`__'
+
+# -----------------------------------------------------------------------------
+# Coverage checker
+# -----------------------------------------------------------------------------
+coverage_ignore_modules = r"""
+    """.split()
+coverage_ignore_functions = r"""
+    test($|_) (some|all)true bitwise_not cumproduct pkgload
+    generic\.
+    """.split()
+coverage_ignore_classes = r"""
+    """.split()
+
+coverage_c_path = []
+coverage_c_regexes = {}
+coverage_ignore_c_items = {}
+
+

Added: scipy-docs/trunk/source/constants.rst
===================================================================
--- scipy-docs/trunk/source/constants.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/constants.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,582 @@
+==================================
+Constants (:mod:`scipy.constants`)
+==================================
+
+.. module:: scipy.constants
+
+Physical and mathematical constants and units.
+
+Mathematical constants
+======================
+
+============  =================================================================
+``pi``        Pi
+``golden``    Golden ratio
+============  =================================================================
+
+Physical constants
+==================
+
+=============  =================================================================
+``c``          speed of light in vacuum
+``mu_0``       the magnetic constant :math:`\mu_0`
+``epsilon_0``  the electric constant (vacuum permittivity), :math:`\epsilon_0`
+``h``          the Planck constant :math:`h`
+``hbar``       :math:`\hbar = h/(2\pi)`
+``G``          Newtonian constant of gravitation
+``g``          standard acceleration of gravity
+``e``          elementary charge
+``R``          molar gas constant
+``alpha``      fine-structure constant
+``N_A``        Avogadro constant
+``k``          Boltzmann constant
+``sigma``      Stefan-Boltzmann constant :math:`\sigma`
+``Wien``       Wien displacement law constant
+``Rydberg``    Rydberg constant
+``m_e``        electron mass
+``m_p``        proton mass
+``m_n``        neutron mass
+=============  =================================================================
+
+
+Constants database
+==================
+
+In addition to the above variables containing physical constants,
+:mod:`scipy.constants` also contains a database of additional physical
+constants.
+
+.. autosummary::
+   :toctree: generated/
+
+   value
+   unit
+   precision
+   find
+
+.. data:: physical_constants
+
+   Dictionary of physical constants, of the format
+   ``physical_constants[name] = (value, unit, uncertainty)``.
+
+   Available constants:
+
+   ======================================================================  ====
+   ``alpha particle mass``
+   ``alpha particle mass energy equivalent``
+   ``alpha particle mass energy equivalent in MeV``
+   ``alpha particle mass in u``
+   ``alpha particle molar mass``
+   ``alpha particle-electron mass ratio``
+   ``alpha particle-proton mass ratio``
+   ``Angstrom star``
+   ``atomic mass constant``
+   ``atomic mass constant energy equivalent``
+   ``atomic mass constant energy equivalent in MeV``
+   ``atomic mass unit-electron volt relationship``
+   ``atomic mass unit-hartree relationship``
+   ``atomic mass unit-hertz relationship``
+   ``atomic mass unit-inverse meter relationship``
+   ``atomic mass unit-joule relationship``
+   ``atomic mass unit-kelvin relationship``
+   ``atomic mass unit-kilogram relationship``
+   ``atomic unit of 1st hyperpolarizablity``
+   ``atomic unit of 2nd hyperpolarizablity``
+   ``atomic unit of action``
+   ``atomic unit of charge``
+   ``atomic unit of charge density``
+   ``atomic unit of current``
+   ``atomic unit of electric dipole moment``
+   ``atomic unit of electric field``
+   ``atomic unit of electric field gradient``
+   ``atomic unit of electric polarizablity``
+   ``atomic unit of electric potential``
+   ``atomic unit of electric quadrupole moment``
+   ``atomic unit of energy``
+   ``atomic unit of force``
+   ``atomic unit of length``
+   ``atomic unit of magnetic dipole moment``
+   ``atomic unit of magnetic flux density``
+   ``atomic unit of magnetizability``
+   ``atomic unit of mass``
+   ``atomic unit of momentum``
+   ``atomic unit of permittivity``
+   ``atomic unit of time``
+   ``atomic unit of velocity``
+   ``Avogadro constant``
+   ``Bohr magneton``
+   ``Bohr magneton in eV/T``
+   ``Bohr magneton in Hz/T``
+   ``Bohr magneton in inverse meters per tesla``
+   ``Bohr magneton in K/T``
+   ``Bohr radius``
+   ``Boltzmann constant``
+   ``Boltzmann constant in eV/K``
+   ``Boltzmann constant in Hz/K``
+   ``Boltzmann constant in inverse meters per kelvin``
+   ``characteristic impedance of vacuum``
+   ``classical electron radius``
+   ``Compton wavelength``
+   ``Compton wavelength over 2 pi``
+   ``conductance quantum``
+   ``conventional value of Josephson constant``
+   ``conventional value of von Klitzing constant``
+   ``Cu x unit``
+   ``deuteron magnetic moment``
+   ``deuteron magnetic moment to Bohr magneton ratio``
+   ``deuteron magnetic moment to nuclear magneton ratio``
+   ``deuteron mass``
+   ``deuteron mass energy equivalent``
+   ``deuteron mass energy equivalent in MeV``
+   ``deuteron mass in u``
+   ``deuteron molar mass``
+   ``deuteron rms charge radius``
+   ``deuteron-electron magnetic moment ratio``
+   ``deuteron-electron mass ratio``
+   ``deuteron-neutron magnetic moment ratio``
+   ``deuteron-proton magnetic moment ratio``
+   ``deuteron-proton mass ratio``
+   ``electric constant``
+   ``electron charge to mass quotient``
+   ``electron g factor``
+   ``electron gyromagnetic ratio``
+   ``electron gyromagnetic ratio over 2 pi``
+   ``electron magnetic moment``
+   ``electron magnetic moment anomaly``
+   ``electron magnetic moment to Bohr magneton ratio``
+   ``electron magnetic moment to nuclear magneton ratio``
+   ``electron mass``
+   ``electron mass energy equivalent``
+   ``electron mass energy equivalent in MeV``
+   ``electron mass in u``
+   ``electron molar mass``
+   ``electron to alpha particle mass ratio``
+   ``electron to shielded helion magnetic moment ratio``
+   ``electron to shielded proton magnetic moment ratio``
+   ``electron volt``
+   ``electron volt-atomic mass unit relationship``
+   ``electron volt-hartree relationship``
+   ``electron volt-hertz relationship``
+   ``electron volt-inverse meter relationship``
+   ``electron volt-joule relationship``
+   ``electron volt-kelvin relationship``
+   ``electron volt-kilogram relationship``
+   ``electron-deuteron magnetic moment ratio``
+   ``electron-deuteron mass ratio``
+   ``electron-muon magnetic moment ratio``
+   ``electron-muon mass ratio``
+   ``electron-neutron magnetic moment ratio``
+   ``electron-neutron mass ratio``
+   ``electron-proton magnetic moment ratio``
+   ``electron-proton mass ratio``
+   ``electron-tau mass ratio``
+   ``elementary charge``
+   ``elementary charge over h``
+   ``Faraday constant``
+   ``Faraday constant for conventional electric current``
+   ``Fermi coupling constant``
+   ``fine-structure constant``
+   ``first radiation constant``
+   ``first radiation constant for spectral radiance``
+   ``Hartree energy``
+   ``Hartree energy in eV``
+   ``hartree-atomic mass unit relationship``
+   ``hartree-electron volt relationship``
+   ``hartree-hertz relationship``
+   ``hartree-inverse meter relationship``
+   ``hartree-joule relationship``
+   ``hartree-kelvin relationship``
+   ``hartree-kilogram relationship``
+   ``helion mass``
+   ``helion mass energy equivalent``
+   ``helion mass energy equivalent in MeV``
+   ``helion mass in u``
+   ``helion molar mass``
+   ``helion-electron mass ratio``
+   ``helion-proton mass ratio``
+   ``hertz-atomic mass unit relationship``
+   ``hertz-electron volt relationship``
+   ``hertz-hartree relationship``
+   ``hertz-inverse meter relationship``
+   ``hertz-joule relationship``
+   ``hertz-kelvin relationship``
+   ``hertz-kilogram relationship``
+   ``inverse fine-structure constant``
+   ``inverse meter-atomic mass unit relationship``
+   ``inverse meter-electron volt relationship``
+   ``inverse meter-hartree relationship``
+   ``inverse meter-hertz relationship``
+   ``inverse meter-joule relationship``
+   ``inverse meter-kelvin relationship``
+   ``inverse meter-kilogram relationship``
+   ``inverse of conductance quantum``
+   ``Josephson constant``
+   ``joule-atomic mass unit relationship``
+   ``joule-electron volt relationship``
+   ``joule-hartree relationship``
+   ``joule-hertz relationship``
+   ``joule-inverse meter relationship``
+   ``joule-kelvin relationship``
+   ``joule-kilogram relationship``
+   ``kelvin-atomic mass unit relationship``
+   ``kelvin-electron volt relationship``
+   ``kelvin-hartree relationship``
+   ``kelvin-hertz relationship``
+   ``kelvin-inverse meter relationship``
+   ``kelvin-joule relationship``
+   ``kelvin-kilogram relationship``
+   ``kilogram-atomic mass unit relationship``
+   ``kilogram-electron volt relationship``
+   ``kilogram-hartree relationship``
+   ``kilogram-hertz relationship``
+   ``kilogram-inverse meter relationship``
+   ``kilogram-joule relationship``
+   ``kilogram-kelvin relationship``
+   ``lattice parameter of silicon``
+   ``Loschmidt constant (273.15 K, 101.325 kPa)``
+   ``magnetic constant``
+   ``magnetic flux quantum``
+   ``Mo x unit``
+   ``molar gas constant``
+   ``molar mass constant``
+   ``molar mass of carbon-12``
+   ``molar Planck constant``
+   ``molar Planck constant times c``
+   ``molar volume of ideal gas (273.15 K, 100 kPa)``
+   ``molar volume of ideal gas (273.15 K, 101.325 kPa)``
+   ``molar volume of silicon``
+   ``muon Compton wavelength``
+   ``muon Compton wavelength over 2 pi``
+   ``muon g factor``
+   ``muon magnetic moment``
+   ``muon magnetic moment anomaly``
+   ``muon magnetic moment to Bohr magneton ratio``
+   ``muon magnetic moment to nuclear magneton ratio``
+   ``muon mass``
+   ``muon mass energy equivalent``
+   ``muon mass energy equivalent in MeV``
+   ``muon mass in u``
+   ``muon molar mass``
+   ``muon-electron mass ratio``
+   ``muon-neutron mass ratio``
+   ``muon-proton magnetic moment ratio``
+   ``muon-proton mass ratio``
+   ``muon-tau mass ratio``
+   ``natural unit of action``
+   ``natural unit of action in eV s``
+   ``natural unit of energy``
+   ``natural unit of energy in MeV``
+   ``natural unit of length``
+   ``natural unit of mass``
+   ``natural unit of momentum``
+   ``natural unit of momentum in MeV/c``
+   ``natural unit of time``
+   ``natural unit of velocity``
+   ``neutron Compton wavelength``
+   ``neutron Compton wavelength over 2 pi``
+   ``neutron g factor``
+   ``neutron gyromagnetic ratio``
+   ``neutron gyromagnetic ratio over 2 pi``
+   ``neutron magnetic moment``
+   ``neutron magnetic moment to Bohr magneton ratio``
+   ``neutron magnetic moment to nuclear magneton ratio``
+   ``neutron mass``
+   ``neutron mass energy equivalent``
+   ``neutron mass energy equivalent in MeV``
+   ``neutron mass in u``
+   ``neutron molar mass``
+   ``neutron to shielded proton magnetic moment ratio``
+   ``neutron-electron magnetic moment ratio``
+   ``neutron-electron mass ratio``
+   ``neutron-muon mass ratio``
+   ``neutron-proton magnetic moment ratio``
+   ``neutron-proton mass ratio``
+   ``neutron-tau mass ratio``
+   ``Newtonian constant of gravitation``
+   ``Newtonian constant of gravitation over h-bar c``
+   ``nuclear magneton``
+   ``nuclear magneton in eV/T``
+   ``nuclear magneton in inverse meters per tesla``
+   ``nuclear magneton in K/T``
+   ``nuclear magneton in MHz/T``
+   ``Planck constant``
+   ``Planck constant in eV s``
+   ``Planck constant over 2 pi``
+   ``Planck constant over 2 pi in eV s``
+   ``Planck constant over 2 pi times c in MeV fm``
+   ``Planck length``
+   ``Planck mass``
+   ``Planck temperature``
+   ``Planck time``
+   ``proton charge to mass quotient``
+   ``proton Compton wavelength``
+   ``proton Compton wavelength over 2 pi``
+   ``proton g factor``
+   ``proton gyromagnetic ratio``
+   ``proton gyromagnetic ratio over 2 pi``
+   ``proton magnetic moment``
+   ``proton magnetic moment to Bohr magneton ratio``
+   ``proton magnetic moment to nuclear magneton ratio``
+   ``proton magnetic shielding correction``
+   ``proton mass``
+   ``proton mass energy equivalent``
+   ``proton mass energy equivalent in MeV``
+   ``proton mass in u``
+   ``proton molar mass``
+   ``proton rms charge radius``
+   ``proton-electron mass ratio``
+   ``proton-muon mass ratio``
+   ``proton-neutron magnetic moment ratio``
+   ``proton-neutron mass ratio``
+   ``proton-tau mass ratio``
+   ``quantum of circulation``
+   ``quantum of circulation times 2``
+   ``Rydberg constant``
+   ``Rydberg constant times c in Hz``
+   ``Rydberg constant times hc in eV``
+   ``Rydberg constant times hc in J``
+   ``Sackur-Tetrode constant (1 K, 100 kPa)``
+   ``Sackur-Tetrode constant (1 K, 101.325 kPa)``
+   ``second radiation constant``
+   ``shielded helion gyromagnetic ratio``
+   ``shielded helion gyromagnetic ratio over 2 pi``
+   ``shielded helion magnetic moment``
+   ``shielded helion magnetic moment to Bohr magneton ratio``
+   ``shielded helion magnetic moment to nuclear magneton ratio``
+   ``shielded helion to proton magnetic moment ratio``
+   ``shielded helion to shielded proton magnetic moment ratio``
+   ``shielded proton gyromagnetic ratio``
+   ``shielded proton gyromagnetic ratio over 2 pi``
+   ``shielded proton magnetic moment``
+   ``shielded proton magnetic moment to Bohr magneton ratio``
+   ``shielded proton magnetic moment to nuclear magneton ratio``
+   ``speed of light in vacuum``
+   ``standard acceleration of gravity``
+   ``standard atmosphere``
+   ``Stefan-Boltzmann constant``
+   ``tau Compton wavelength``
+   ``tau Compton wavelength over 2 pi``
+   ``tau mass``
+   ``tau mass energy equivalent``
+   ``tau mass energy equivalent in MeV``
+   ``tau mass in u``
+   ``tau molar mass``
+   ``tau-electron mass ratio``
+   ``tau-muon mass ratio``
+   ``tau-neutron mass ratio``
+   ``tau-proton mass ratio``
+   ``Thomson cross section``
+   ``unified atomic mass unit``
+   ``von Klitzing constant``
+   ``weak mixing angle``
+   ``Wien displacement law constant``
+   ``{220} lattice spacing of silicon``
+   ======================================================================  ====
+
+
+Unit prefixes
+=============
+
+SI
+--
+
+============  =================================================================
+``yotta``     :math:`10^{24}`
+``zetta``     :math:`10^{21}`
+``exa``       :math:`10^{18}`
+``peta``      :math:`10^{15}`
+``tera``      :math:`10^{12}`
+``giga``      :math:`10^{9}`
+``mega``      :math:`10^{6}`
+``kilo``      :math:`10^{3}`
+``hecto``     :math:`10^{2}`
+``deka``      :math:`10^{1}`
+``deci``      :math:`10^{-1}`
+``centi``     :math:`10^{-2}`
+``milli``     :math:`10^{-3}`
+``micro``     :math:`10^{-6}`
+``nano``      :math:`10^{-9}`
+``pico``      :math:`10^{-12}`
+``femto``     :math:`10^{-15}`
+``atto``      :math:`10^{-18}`
+``zepto``     :math:`10^{-21}`
+============  =================================================================
+
+
+Binary
+------
+
+============  =================================================================
+``kibi``      :math:`2^{10}`
+``mebi``      :math:`2^{20}`
+``gibi``      :math:`2^{30}`
+``tebi``      :math:`2^{40}`
+``pebi``      :math:`2^{50}`
+``exbi``      :math:`2^{60}`
+``zebi``      :math:`2^{70}`
+``yobi``      :math:`2^{80}`
+============  =================================================================
+
+Units
+=====
+
+Weight
+------
+
+=================  ============================================================
+``gram``           :math:`10^{-3}` kg
+``metric_ton``     :math:`10^{3}` kg
+``grain``          one grain in kg
+``lb``             one pound (avoirdupous) in kg
+``oz``             one ounce in kg
+``stone``          one stone in kg
+``grain``          one grain in kg
+``long_ton``       one long ton in kg
+``short_ton``      one short ton in kg
+``troy_ounce``     one Troy ounce in kg
+``troy_pound``     one Troy pound in kg
+``carat``          one carat in kg
+``m_u``            atomic mass constant (in kg)
+=================  ============================================================
+
+Angle
+-----
+
+=================  ============================================================
+``degree``         degree in radians
+``arcmin``         arc minute in radians
+``arcsec``         arc second in radians
+=================  ============================================================
+
+
+Time
+----
+
+=================  ============================================================
+``minute``         one minute in seconds
+``hour``           one hour in seconds
+``day``            one day in seconds
+``week``           one week in seconds
+``year``           one year (365 days) in seconds
+``Julian_year``    one Julian year (365.25 days) in seconds
+=================  ============================================================
+
+
+Length
+------
+
+=================  ============================================================
+``inch``           one inch in meters
+``foot``           one foot in meters
+``yard``           one yard in meters
+``mile``           one mile in meters
+``mil``            one mil in meters
+``pt``             one point in meters
+``survey_foot``    one survey foot in meters
+``survey_mile``    one survey mile in meters
+``nautical_mile``  one nautical mile in meters
+``fermi``          one Fermi in meters
+``angstrom``       one Ångström in meters
+``micron``         one micron in meters
+``au``             one astronomical unit in meters
+``light_year``     one light year in meters
+``parsec``         one parsec in meters
+=================  ============================================================
+
+Pressure
+--------
+
+=================  ============================================================
+``atm``            standard atmosphere in pascals
+``bar``            one bar in pascals
+``torr``           one torr (mmHg) in pascals
+``psi``            one psi in pascals
+=================  ============================================================
+
+Area
+----
+
+=================  ============================================================
+``hectare``        one hectare in square meters
+``acre``           one acre in square meters
+=================  ============================================================
+
+
+Volume
+------
+
+===================    ========================================================
+``liter``              one liter in cubic meters
+``gallon``             one gallon (US) in cubic meters
+``gallon_imp``         one gallon (UK) in cubic meters
+``fluid_ounce``        one fluid ounce (US) in cubic meters
+``fluid_ounce_imp``    one fluid ounce (UK) in cubic meters
+``bbl``                one barrel in cubic meters
+===================    ========================================================
+
+Speed
+-----
+
+=================    ==========================================================
+``kmh``              kilometers per hour in meters per second
+``mph``              miles per hour in meters per second
+``mach``             one Mach (approx., at 15 °C, 1 atm) in meters per second
+``knot``             one knot in meters per second
+=================    ==========================================================
+
+
+Temperature
+-----------
+
+=====================  =======================================================
+``zero_Celsius``       zero of Celsius scale in Kelvin
+``degree_Fahrenheit``  one Fahrenheit (only differences) in Kelvins
+=====================  =======================================================
+
+.. autosummary::
+   :toctree: generated/
+
+   C2K
+   K2C
+   F2C
+   C2F
+   F2K
+   K2F
+
+Energy
+------
+
+====================  =======================================================
+``eV``                one electron volt in Joules
+``calorie``           one calorie (thermochemical) in Joules
+``calorie_IT``        one calorie (International Steam Table calorie, 1956) in Joules
+``erg``               one erg in Joules
+``Btu``               one British thermal unit (International Steam Table) in Joules
+``Btu_th``            one British thermal unit (thermochemical) in Joules
+``ton_TNT``           one ton of TNT in Joules
+====================  =======================================================
+
+Power
+-----
+
+====================  =======================================================
+``hp``                one horsepower in watts
+====================  =======================================================
+
+Force
+-----
+
+====================  =======================================================
+``dyn``               one dyne in watts
+``lbf``               one pound force in watts
+``kgf``               one kilogram force in watts
+====================  =======================================================
+
+Optics
+------
+
+.. autosummary::
+   :toctree: generated/
+
+   lambda2nu
+   nu2lambda

Added: scipy-docs/trunk/source/fftpack.rst
===================================================================
--- scipy-docs/trunk/source/fftpack.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/fftpack.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,78 @@
+=========================================
+Fourier transforms (:mod:`scipy.fftpack`)
+=========================================
+
+.. module:: scipy.fftpack
+
+Fast Fourier transforms
+=======================
+
+.. autosummary::
+   :toctree: generated/
+
+   fft
+   ifft
+   fftn
+   ifftn
+   fft2
+   ifft2
+   rfft
+   irfft
+
+Differential and pseudo-differential operators
+==============================================
+
+.. autosummary::
+   :toctree: generated/
+
+   diff
+   tilbert
+   itilbert
+   hilbert
+   ihilbert
+   cs_diff
+   sc_diff
+   ss_diff
+   cc_diff
+   shift
+
+Helper functions
+================
+
+.. autosummary::
+   :toctree: generated/
+
+   fftshift
+   ifftshift
+   dftfreq
+   rfftfreq
+
+Convolutions (:mod:`scipy.fftpack.convolve`)
+============================================
+
+.. module:: scipy.fftpack.convolve
+
+.. autosummary::
+   :toctree: generated/
+
+   convolve
+   convolve_z
+   init_convolution_kernel
+   destroy_convolve_cache
+
+
+:mod:`scipy.fftpack._fftpack`
+=============================
+
+.. module:: scipy.fftpack._fftpack
+
+.. autosummary::
+   :toctree: generated/
+
+   drfft
+   zfft
+   zrfft
+   zfftnd
+   destroy_drfft_cache
+   destroy_zfft_cache
+   destroy_zfftnd_cache

Added: scipy-docs/trunk/source/index.rst
===================================================================
--- scipy-docs/trunk/source/index.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/index.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,28 @@
+###############
+SciPy reference
+###############
+
+SciPy (pronounced "Sigh Pie") is open-source software for mathematics,
+science, and engineering.
+
+.. toctree::
+   :maxdepth: 1
+
+   cluster
+   constants
+   fftpack
+   integrate
+   interpolate
+   io
+   linalg
+   maxentropy
+   misc
+   ndimage
+   odr
+   optimize
+   signal
+   sparse
+   sparse.linalg
+   special
+   stats
+   weave

Added: scipy-docs/trunk/source/integrate.rst
===================================================================
--- scipy-docs/trunk/source/integrate.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/integrate.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,44 @@
+=============================================
+Integration and ODEs (:mod:`scipy.integrate`)
+=============================================
+
+.. module:: scipy.integrate
+
+
+Integrating functions, given function object
+============================================
+
+.. autosummary::
+   :toctree: generated/
+    
+   quad         
+   dblquad      
+   tplquad      
+   fixed_quad   
+   quadrature   
+   romberg      
+    
+Integrating functions, given fixed samples
+==========================================
+    
+.. autosummary::
+   :toctree: generated/
+    
+   trapz        
+   cumtrapz     
+   simps        
+   romb         
+
+.. seealso::
+
+   :mod:`scipy.special` for orthogonal polynomials (special) for Gaussian
+   quadrature roots and weights for other weighting factors and regions.
+    
+Integrators of ODE systems
+==========================
+    
+.. autosummary::
+   :toctree: generated/
+    
+   odeint       
+   ode          

Added: scipy-docs/trunk/source/interpolate.rst
===================================================================
--- scipy-docs/trunk/source/interpolate.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/interpolate.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,84 @@
+========================================
+Interpolation (:mod:`scipy.interpolate`)
+========================================
+
+.. module:: scipy.interpolate
+
+Univariate interpolation
+========================
+
+.. autosummary::
+   :toctree: generated/
+
+   interp1d
+   BarycentricInterpolator
+   KroghInterpolator
+   PiecewisePolynomial
+   barycentric_interpolate
+   krogh_interpolate
+   piecewise_polynomial_interpolate
+
+
+Multivariate interpolation
+==========================
+
+.. autosummary::
+   :toctree: generated/
+
+   interp2d
+   Rbf
+
+
+1-D Splines
+===========
+
+.. autosummary::
+   :toctree: generated/
+
+   UnivariateSpline
+   InterpolatedUnivariateSpline
+   LSQUnivariateSpline
+
+Low-level interface to FITPACK functions:
+
+.. autosummary::
+   :toctree: generated/
+
+   splrep
+   splprep
+   splev
+   splint
+   sproot
+   spalde
+   bisplrep
+   bisplev
+
+
+2-D Splines
+===========
+
+.. seealso:: scipy.ndimage.map_coordinates
+
+.. autosummary::
+   :toctree: generated/
+
+   BivariateSpline
+   SmoothBivariateSpline
+   LSQBivariateSpline
+
+Low-level interface to FITPACK functions:
+
+.. autosummary::
+   :toctree: generated/
+
+   bisplrep
+   bisplev
+
+Additional tools
+================
+
+.. autosummary::
+   :toctree: generated/
+
+   lagrange
+   approximate_taylor_polynomial

Added: scipy-docs/trunk/source/io.rst
===================================================================
--- scipy-docs/trunk/source/io.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/io.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,67 @@
+==================================
+Input and output (:mod:`scipy.io`)
+==================================
+
+.. seealso:: :ref:`numpy-reference.routines.io` (in Numpy)
+
+.. module:: scipy.io
+
+MATLAB® files
+=============
+
+.. autosummary::
+   :toctree: generated/
+
+   loadmat
+   savemat
+
+Matrix Market files
+===================
+
+.. autosummary::
+   :toctree: generated/
+
+   mminfo
+   mmread
+   mmwrite
+
+Other
+=====
+
+.. autosummary::
+   :toctree: generated/
+
+   save_as_module
+   npfile
+
+Wav sound files (:mod:`scipy.io.wavfile`)
+=========================================
+
+.. module:: scipy.io.wavfile
+
+.. autosummary::
+   :toctree: generated/
+
+   read
+   write
+
+Arff files (:mod:`scipy.io.arff`)
+=================================
+
+.. automodule:: scipy.io.arff
+
+.. autosummary::
+   :toctree: generated/
+
+   loadarff
+
+Netcdf (:mod:`scipy.io.netcdf`)
+===============================
+
+.. module:: scipy.io.netcdf
+
+.. autosummary::
+   :toctree: generated/
+
+   netcdf_file
+   netcdf_variable

Added: scipy-docs/trunk/source/linalg.rst
===================================================================
--- scipy-docs/trunk/source/linalg.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/linalg.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,81 @@
+====================================
+Linear algebra (:mod:`scipy.linalg`)
+====================================
+
+.. module:: scipy.linalg
+
+Basics
+======
+
+.. autosummary::
+   :toctree: generated/
+
+   inv       
+   solve     
+   solve_banded
+   solveh_banded
+   det       
+   norm      
+   lstsq     
+   pinv      
+   pinv2     
+
+Eigenvalues and Decompositions
+==============================
+
+.. autosummary::
+   :toctree: generated/
+
+   eig       
+   eigvals   
+   eig_banded
+   eigvals_banded
+   lu        
+   lu_factor 
+   lu_solve  
+   svd       
+   svdvals   
+   diagsvd   
+   orth      
+   cholesky  
+   cholesky_banded  
+   cho_factor
+   cho_solve 
+   qr        
+   schur     
+   rsf2csf   
+   hessenberg
+
+Matrix Functions
+================
+
+.. autosummary::
+   :toctree: generated/
+
+   expm      
+   expm2     
+   expm3     
+   logm      
+   cosm      
+   sinm      
+   tanm      
+   coshm     
+   sinhm     
+   tanhm     
+   signm     
+   sqrtm     
+   funm      
+
+Iterative linear systems solutions
+==================================
+
+.. autosummary::
+   :toctree: generated/
+
+   cg        
+   cgs       
+   qmr       
+   gmres     
+   bicg      
+   bicgstab  
+

Added: scipy-docs/trunk/source/maxentropy.rst
===================================================================
--- scipy-docs/trunk/source/maxentropy.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/maxentropy.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,84 @@
+================================================
+Maximum entropy models (:mod:`scipy.maxentropy`)
+================================================
+
+.. automodule:: scipy.maxentropy
+
+
+Models
+======
+
+.. autoclass:: model
+
+.. autosummary::
+   :toctree: generated/
+
+   model.beginlogging
+   model.endlogging
+   model.clearcache
+   model.crossentropy
+   model.dual
+   model.fit
+   model.grad
+   model.log
+   model.logparams
+   model.normconst
+   model.reset
+   model.setcallback
+   model.setparams
+   model.setsmooth
+   model.expectations
+   model.lognormconst
+   model.logpmf
+   model.pmf_function
+   model.setfeaturesandsamplespace
+
+.. autoclass:: bigmodel
+
+.. autosummary::
+   :toctree: generated/
+
+   bigmodel.estimate
+   bigmodel.logpdf
+   bigmodel.pdf
+   bigmodel.pdf_function
+   bigmodel.resample
+   bigmodel.setsampleFgen
+   bigmodel.settestsamples
+   bigmodel.stochapprox
+   bigmodel.test
+   
+.. autoclass:: conditionalmodel
+
+.. autosummary::
+   :toctree: generated/
+
+   conditionalmodel.dual
+   conditionalmodel.expectations
+   conditionalmodel.fit
+   conditionalmodel.lognormconst
+   conditionalmodel.logpmf
+
+Utilities
+=========
+
+.. autosummary::
+   :toctree: generated/
+
+   arrayexp
+   arrayexpcomplex
+   columnmeans
+   columnvariances
+   densefeaturematrix
+   densefeatures
+   dotprod
+   flatten
+   innerprod
+   innerprodtranspose
+   logsumexp
+   logsumexp_naive
+   robustlog
+   rowmeans
+   sample_wr
+   sparsefeaturematrix
+   sparsefeatures

Added: scipy-docs/trunk/source/misc.rst
===================================================================
--- scipy-docs/trunk/source/misc.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/misc.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,6 @@
+==========================================
+Miscellaneous routines (:mod:`scipy.misc`)
+==========================================
+
+.. automodule:: scipy.misc
+   :members:

Added: scipy-docs/trunk/source/ndimage.rst
===================================================================
--- scipy-docs/trunk/source/ndimage.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/ndimage.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,122 @@
+=========================================================
+Multi-dimensional image processing (:mod:`scipy.ndimage`)
+=========================================================
+
+.. module:: scipy.ndimage
+
+Functions for multi-dimensional image processing.
+
+Filters :mod:`scipy.ndimage.filters`
+====================================
+
+.. module:: scipy.ndimage.filters
+
+.. autosummary::
+   :toctree: generated/
+
+   convolve
+   convolve1d
+   correlate
+   correlate1d
+   gaussian_filter
+   gaussian_filter1d
+   gaussian_gradient_magnitude
+   gaussian_laplace
+   generic_filter
+   generic_filter1d
+   generic_gradient_magnitude
+   generic_laplace
+   laplace
+   maximum_filter
+   maximum_filter1d
+   median_filter
+   minimum_filter
+   minimum_filter1d
+   percentile_filter
+   prewitt
+   rank_filter
+   sobel
+   uniform_filter
+   uniform_filter1d
+
+Fourier filters :mod:`scipy.ndimage.fourier`
+============================================
+
+.. module:: scipy.ndimage.fourier
+
+.. autosummary::
+   :toctree: generated/
+
+   fourier_ellipsoid
+   fourier_gaussian
+   fourier_shift
+   fourier_uniform
+
+Interpolation :mod:`scipy.ndimage.interpolation`
+================================================
+
+.. module:: scipy.ndimage.interpolation
+
+.. autosummary::
+   :toctree: generated/
+
+   affine_transform
+   geometric_transform
+   map_coordinates
+   rotate
+   shift
+   spline_filter
+   spline_filter1d
+   zoom
+
+Measurements :mod:`scipy.ndimage.measurements`
+==============================================
+
+.. module:: scipy.ndimage.measurements
+
+.. autosummary::
+   :toctree: generated/
+
+   center_of_mass
+   extrema
+   find_objects
+   histogram
+   label
+   maximum
+   maximum_position
+   mean
+   minimum
+   minimum_position
+   standard_deviation
+   sum
+   variance
+   watershed_ift
+
+Morphology :mod:`scipy.ndimage.morphology`
+==========================================
+
+.. module:: scipy.ndimage.morphology
+
+.. autosummary::
+   :toctree: generated/
+
+   binary_closing
+   binary_dilation
+   binary_erosion
+   binary_fill_holes
+   binary_hit_or_miss
+   binary_opening
+   binary_propagation
+   black_tophat
+   distance_transform_bf
+   distance_transform_cdt
+   distance_transform_edt
+   generate_binary_structure
+   grey_closing
+   grey_dilation
+   grey_erosion
+   grey_opening
+   iterate_structure
+   morphological_gradient
+   morphological_laplace
+   white_tophat

Added: scipy-docs/trunk/source/odr.rst
===================================================================
--- scipy-docs/trunk/source/odr.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/odr.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,34 @@
+=================================================
+Orthogonal distance regression (:mod:`scipy.odr`)
+=================================================
+
+.. automodule:: scipy.odr
+
+.. autoclass:: Data
+
+   .. automethod:: set_meta
+
+.. autoclass:: Model
+
+   .. automethod:: set_meta
+
+.. autoclass:: ODR
+
+   .. automethod:: restart
+
+   .. automethod:: run
+
+   .. automethod:: set_iprint
+
+   .. note:: XXX: Sphinx doesn't like "set_job" docstring; after it's fixed,
+      add "set_job" here.
+
+.. autoclass:: Output
+
+   .. automethod:: pprint
+
+.. autoexception:: odr_error
+
+.. autoexception:: odr_stop
+
+.. autofunction:: odr

Added: scipy-docs/trunk/source/optimize.rst
===================================================================
--- scipy-docs/trunk/source/optimize.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/optimize.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,105 @@
+=====================================================
+Optimization and root finding (:mod:`scipy.optimize`)
+=====================================================
+
+.. module:: scipy.optimize
+
+Optimization
+============
+
+General-purpose
+---------------
+
+.. autosummary::
+   :toctree: generated/
+
+   fmin       
+   fmin_powell
+   fmin_cg    
+   fmin_bfgs  
+   fmin_ncg   
+   leastsq    
+
+
+Constrained (multivariate)
+--------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   fmin_l_bfgs_b
+   fmin_tnc     
+   fmin_cobyla  
+
+Global
+------
+
+.. autosummary::
+   :toctree: generated/
+
+   anneal     
+   brute      
+
+Scalar function minimizers
+--------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   fminbound  
+   golden     
+   bracket    
+
+.. note:: 
+
+   XXX: Sphinx didn't like "brent" docstring; add it to the list after
+   it's fixed.
+
+Root finding
+============
+   
+.. autosummary::
+   :toctree: generated/
+
+   fsolve     
+
+Scalar function solvers
+-----------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   brentq     
+   brenth     
+   ridder     
+   bisect     
+   newton
+
+Fixed point finding:
+   
+.. autosummary::
+   :toctree: generated/
+
+   fixed_point
+
+General-purpose nonlinear (multidimensional)
+--------------------------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   broyden1           
+   broyden2           
+   broyden3           
+   broyden_generalized
+   anderson           
+   anderson2          
+
+Utility Functions
+=================
+
+.. autosummary::
+   :toctree: generated/
+
+   line_search
+   check_grad 

Added: scipy-docs/trunk/source/signal.rst
===================================================================
--- scipy-docs/trunk/source/signal.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/signal.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,157 @@
+=======================================
+Signal processing (:mod:`scipy.signal`)
+=======================================
+
+.. module:: scipy.signal
+
+Convolution
+===========
+
+.. autosummary::
+   :toctree: generated/
+
+   convolve     
+   correlate    
+   fftconvolve  
+   convolve2d   
+   correlate2d  
+   sepfir2d     
+
+B-splines
+=========
+
+.. autosummary::
+   :toctree: generated/
+
+   bspline      
+   gauss_spline 
+   cspline1d    
+   qspline1d    
+   cspline2d    
+   qspline2d    
+   spline_filter
+
+Filtering
+=========
+
+.. autosummary::
+   :toctree: generated/
+
+   order_filter 
+   medfilt      
+   medfilt2     
+   wiener       
+
+   symiirorder1 
+   symiirorder2 
+   lfilter      
+
+   deconvolve   
+
+   hilbert      
+   get_window   
+
+   detrend      
+   resample     
+
+Filter design
+=============
+
+.. autosummary::
+   :toctree: generated/
+
+   remez        
+   firwin       
+   iirdesign    
+   iirfilter    
+   freqs        
+   freqz        
+
+   unique_roots 
+   residue      
+   residuez     
+   invres       
+
+Matlab-style IIR filter design
+==============================
+
+.. autosummary::
+   :toctree: generated/
+
+   butter
+   buttord
+   cheby1
+   cheb1ord
+   cheby2
+   cheb2ord
+   ellip
+   ellipord
+   bessel
+
+Linear Systems
+==============
+
+.. autosummary::
+   :toctree: generated/
+
+   lti    
+   lsim   
+   impulse
+   step   
+
+LTI Reresentations
+==================
+
+.. autosummary::
+   :toctree: generated/
+
+   tf2zpk
+   zpk2tf
+   tf2ss 
+   ss2tf 
+   zpk2ss
+   ss2zpk
+
+Waveforms
+=========
+
+.. autosummary::
+   :toctree: generated/
+
+   sawtooth  
+   square    
+   gausspulse
+   chirp     
+
+Window functions
+================
+
+.. autosummary::
+   :toctree: generated/
+
+   boxcar          
+   triang          
+   parzen          
+   bohman          
+   blackman        
+   blackmanharris  
+   nuttall         
+   flattop         
+   bartlett        
+   hann            
+   barthann        
+   hamming         
+   kaiser          
+   gaussian        
+   general_gaussian
+   slepian         
+
+Wavelets
+========
+
+.. autosummary::
+   :toctree: generated/
+
+   daub   
+   qmf    
+   cascade

Added: scipy-docs/trunk/source/sparse.linalg.rst
===================================================================
--- scipy-docs/trunk/source/sparse.linalg.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/sparse.linalg.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,6 @@
+==================================================
+Sparse linear algebra (:mod:`scipy.sparse.linalg`)
+==================================================
+
+.. automodule:: scipy.sparse.linalg
+   :members:

Added: scipy-docs/trunk/source/sparse.rst
===================================================================
--- scipy-docs/trunk/source/sparse.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/sparse.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,64 @@
+=====================================
+Sparse matrices (:mod:`scipy.sparse`)
+=====================================
+
+.. automodule:: scipy.sparse
+
+
+Sparse matrix classes
+=====================
+
+.. autosummary::
+   :toctree: generated/
+
+   csc_matrix
+   csr_matrix
+   bsr_matrix
+   lil_matrix
+   dok_matrix
+   coo_matrix
+   dia_matrix
+
+
+Functions
+=========
+
+Building sparse matrices:
+
+.. autosummary::
+   :toctree: generated/
+
+   eye
+   identity
+   kron
+   kronsum
+   lil_eye
+   lil_diags
+   spdiags
+   tril
+   triu
+   bmat
+   hstack
+   vstack
+
+Identifying sparse matrices:
+
+.. autosummary::
+   :toctree: generated/
+
+   issparse
+   isspmatrix
+   isspmatrix_csc
+   isspmatrix_csr
+   isspmatrix_bsr
+   isspmatrix_lil
+   isspmatrix_dok
+   isspmatrix_coo
+   isspmatrix_dia
+
+Exceptions
+==========
+
+.. autoexception:: SparseEfficiencyWarning
+
+.. autoexception:: SparseWarning

Added: scipy-docs/trunk/source/special.rst
===================================================================
--- scipy-docs/trunk/source/special.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/special.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,480 @@
+========================================
+Special functions (:mod:`scipy.special`)
+========================================
+
+.. module:: scipy.special
+
+Nearly all of the functions below are universal functions and follow
+broadcasting and automatic array-looping rules. Exceptions are noted.
+
+Error handling
+==============
+    
+Errors are handled by returning nans, or other appropriate values.
+Some of the special function routines will print an error message
+when an error occurs.  By default this printing
+is disabled.  To enable such messages use errprint(1)
+To disable such messages use errprint(0).
+    
+Example:
+    >>> print scipy.special.bdtr(-1,10,0.3)
+    >>> scipy.special.errprint(1)
+    >>> print scipy.special.bdtr(-1,10,0.3)
+
+.. autosummary::
+   :toctree: generated/
+
+   errprint
+   errstate
+    
+Available functions
+===================
+    
+Airy functions
+--------------
+
+.. autosummary::
+   :toctree: generated/
+
+   airy
+   airye
+   ai_zeros
+   bi_zeros
+
+
+Elliptic Functions and Integrals
+--------------------------------
+    
+.. autosummary::
+   :toctree: generated/
+
+   ellipj   
+   ellipk   
+   ellipkinc
+   ellipe   
+   ellipeinc
+    
+Bessel Functions
+----------------
+    
+.. autosummary::
+   :toctree: generated/
+
+   jn      
+   jv      
+   jve     
+   yn      
+   yv      
+   yve     
+   kn      
+   kv      
+   kve     
+   iv      
+   ive     
+   hankel1 
+   hankel1e
+   hankel2 
+   hankel2e
+
+The following is not an universal function:
+   
+.. autosummary::
+   :toctree: generated/
+
+   lmbda      
+
+Zeros of Bessel Functions
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+These are not universal functions:
+   
+.. autosummary::
+   :toctree: generated/
+
+   jnjnp_zeros
+   jnyn_zeros 
+   jn_zeros   
+   jnp_zeros  
+   yn_zeros   
+   ynp_zeros  
+   y0_zeros   
+   y1_zeros   
+   y1p_zeros  
+
+Faster versions of common Bessel Functions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: generated/
+
+   j0      
+   j1      
+   y0      
+   y1      
+   i0      
+   i0e     
+   i1      
+   i1e     
+   k0      
+   k0e     
+   k1      
+   k1e     
+
+Integrals of Bessel Functions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: generated/
+
+   itj0y0    
+   it2j0y0   
+   iti0k0    
+   it2i0k0   
+   besselpoly
+
+Derivatives of Bessel Functions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: generated/
+
+   jvp    
+   yvp    
+   kvp    
+   ivp    
+   h1vp   
+   h2vp   
+
+Spherical Bessel Functions
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+These are not universal functions:
+   
+.. autosummary::
+   :toctree: generated/
+
+   sph_jn  
+   sph_yn  
+   sph_jnyn
+   sph_in  
+   sph_kn  
+   sph_inkn
+
+Ricatti-Bessel Functions
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+These are not universal functions:
+   
+.. autosummary::
+   :toctree: generated/
+
+   riccati_jn
+   riccati_yn
+
+Struve Functions
+----------------
+
+.. autosummary::
+   :toctree: generated/
+
+   struve
+   modstruve
+   itstruve0   
+   it2struve0  
+   itmodstruve0
+
+
+Raw Statistical Functions
+-------------------------
+
+.. seealso:: :mod:`scipy.stats`: Friendly versions of these functions.
+
+.. autosummary::
+   :toctree: generated/
+
+   bdtr      
+   bdtrc     
+   bdtri     
+   btdtr     
+   btdtri    
+   fdtr      
+   fdtrc     
+   fdtri     
+   gdtr      
+   gdtrc     
+   gdtria
+   gdtrib
+   gdtrix
+   nbdtr     
+   nbdtrc    
+   nbdtri    
+   pdtr      
+   pdtrc     
+   pdtri     
+   stdtr     
+   stdtridf
+   stdtrit
+   chdtr     
+   chdtrc    
+   chdtri    
+   ndtr      
+   ndtri     
+   smirnov   
+   smirnovi  
+   kolmogorov
+   kolmogi   
+   tklmbda   
+
+Gamma and Related Functions
+---------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   gamma       
+   gammaln     
+   gammainc    
+   gammaincinv 
+   gammaincc   
+   gammainccinv
+   beta        
+   betaln      
+   betainc     
+   betaincinv  
+   psi
+   rgamma      
+   polygamma   
+
+
+Error Function and Fresnel Integrals
+------------------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   erf          
+   erfc         
+   erfinv       
+   erfcinv      
+   erf_zeros    
+   fresnel      
+   fresnel_zeros
+   modfresnelp  
+   modfresnelm  
+
+These are not universal functions:
+   
+.. autosummary::
+   :toctree: generated/
+
+   fresnelc_zeros
+   fresnels_zeros
+
+Legendre Functions
+------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   lpmv    
+   sph_harm
+
+These are not universal functions:
+   
+.. autosummary::
+   :toctree: generated/
+
+   lpn     
+   lqn     
+   lpmn    
+   lqmn    
+
+Orthogonal polynomials
+----------------------
+
+These functions all return a polynomial class which can then be
+evaluated: ``vals = chebyt(n)(x)``.
+
+The class also has an attribute 'weights' which return the roots,
+weights, and total weights for the appropriate form of Gaussian
+quadrature.  These are returned in an n x 3 array with roots in
+the first column, weights in the second column, and total weights
+in the final column
+
+.. autosummary::
+   :toctree: generated/
+
+   legendre
+   chebyt     
+   chebyu     
+   chebyc     
+   chebys     
+   jacobi     
+   laguerre   
+   genlaguerre
+   hermite    
+   hermitenorm
+   gegenbauer 
+   sh_legendre
+   sh_chebyt  
+   sh_chebyu  
+   sh_jacobi  
+
+Hypergeometric Functions
+------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   hyp2f1  
+   hyp1f1  
+   hyperu  
+   hyp0f1  
+   hyp2f0  
+   hyp1f2  
+   hyp3f0  
+
+
+Parabolic Cylinder Functions
+----------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   pbdv    
+   pbvv    
+   pbwa
+
+These are not universal functions:
+   
+.. autosummary::
+   :toctree: generated/
+
+   pbdv_seq
+   pbvv_seq
+   pbdn_seq
+
+Mathieu and Related Functions
+-----------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   mathieu_a      
+   mathieu_b      
+
+These are not universal functions:
+   
+.. autosummary::
+   :toctree: generated/
+
+   mathieu_even_coef
+   mathieu_odd_coef 
+
+The following return both function and first derivative:
+
+.. autosummary::
+   :toctree: generated/
+
+   mathieu_cem    
+   mathieu_sem    
+   mathieu_modcem1
+   mathieu_modcem2
+   mathieu_modsem1
+   mathieu_modsem2
+
+Spheroidal Wave Functions
+-------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   pro_ang1  
+   pro_rad1  
+   pro_rad2  
+   obl_ang1  
+   obl_rad1  
+   obl_rad2  
+   pro_cv    
+   obl_cv    
+   pro_cv_seq
+   obl_cv_seq
+
+The following functions require pre-computed characteristic value:
+
+.. autosummary::
+   :toctree: generated/
+
+   pro_ang1_cv
+   pro_rad1_cv
+   pro_rad2_cv
+   obl_ang1_cv
+   obl_rad1_cv
+   obl_rad2_cv
+
+Kelvin Functions
+----------------
+
+.. autosummary::
+   :toctree: generated/
+
+   kelvin      
+   kelvin_zeros
+   ber         
+   bei         
+   berp        
+   beip        
+   ker         
+   kei         
+   kerp        
+   keip        
+
+These are not universal functions:
+   
+.. autosummary::
+   :toctree: generated/
+
+   ber_zeros   
+   bei_zeros   
+   berp_zeros  
+   beip_zeros  
+   ker_zeros   
+   kei_zeros   
+   kerp_zeros  
+   keip_zeros  
+
+Other Special Functions
+-----------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   expn        
+   exp1        
+   expi
+   wofz        
+   dawsn       
+   shichi      
+   sici        
+   spence      
+   zeta        
+   zetac       
+
+Convenience Functions
+---------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   cbrt    
+   exp10   
+   exp2    
+   radian  
+   cosdg   
+   sindg   
+   tandg   
+   cotdg   
+   log1p   
+   expm1   
+   cosm1   
+   round

Added: scipy-docs/trunk/source/stats.rst
===================================================================
--- scipy-docs/trunk/source/stats.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/stats.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,254 @@
+.. module:: scipy.stats
+
+==========================================
+Statistical functions (:mod:`scipy.stats`)
+==========================================
+
+This module contains a large number of probability distributions as
+well as a growing library of statistical functions.
+    
+Each included distribution is an instance of the class rv_continous:
+
+.. autosummary::
+   :toctree: generated/
+   
+   rv_continuous
+   rv_continuous.pdf
+   rv_continuous.cdf
+   rv_continuous.sf
+   rv_continuous.ppf
+   rv_continuous.isf
+   rv_continuous.stats
+
+
+Continuous distributions
+========================
+
+.. autosummary::
+   :toctree: generated/
+   
+   norm
+   alpha
+   anglit
+   arcsine
+   beta
+   betaprime
+   bradford
+   burr
+   fisk
+   cauchy
+   chi
+   chi2
+   cosine
+   dgamma
+   dweibull
+   erlang
+   expon
+   exponweib
+   exponpow
+   fatiguelife
+   foldcauchy
+   f
+   foldnorm
+   fretchet_r
+   fretcher_l
+   genlogistic
+   genpareto
+   genexpon
+   genextreme
+   gausshyper
+   gamma
+   gengamma
+   genhalflogistic
+   gompertz       
+   gumbel_r       
+   gumbel_l       
+   halfcauchy     
+   halflogistic   
+   halfnorm       
+   hypsecant      
+   invgamma       
+   invnorm        
+   invweibull     
+   johnsonsb      
+   johnsonsu      
+   laplace        
+   logistic       
+   loggamma       
+   loglaplace     
+   lognorm        
+   gilbrat        
+   lomax          
+   maxwell        
+   mielke         
+   nakagami       
+   ncx2           
+   ncf            
+   t              
+   nct            
+   pareto         
+   powerlaw       
+   powerlognorm   
+   powernorm      
+   rdist          
+   reciprocal     
+   rayleigh       
+   rice           
+   recipinvgauss  
+   semicircular   
+   triang         
+   truncexpon     
+   truncnorm      
+   tukeylambda    
+   uniform        
+   von_mises      
+   wald           
+   weibull_min    
+   weibull_max    
+   wrapcauchy     
+   ksone          
+   kstwobign
+
+Discrete distributions
+======================
+
+.. autosummary::
+   :toctree: generated/
+
+   binom          
+   bernoulli      
+   nbinom         
+   geom           
+   hypergeom      
+   logser         
+   poisson        
+   planck         
+   boltzmann      
+   randint        
+   zipf           
+   dlaplace
+
+Statistical functions
+=====================
+
+.. autosummary::
+   :toctree: generated/
+
+   gmean          
+   hmean          
+   mean           
+   cmedian        
+   median         
+   mode           
+   tmean          
+   tvar           
+   tmin           
+   tmax           
+   tstd           
+   tsem           
+   moment         
+   variation      
+   skew           
+   kurtosis       
+   describe       
+   skewtest       
+   kurtosistest   
+   normaltest     
+
+
+.. autosummary::
+   :toctree: generated/
+
+   itemfreq           
+   scoreatpercentile  
+   percentileofscore  
+   histogram2  
+   histogram  
+   cumfreq  
+   relfreq  
+
+.. autosummary::
+   :toctree: generated/
+
+   obrientransform   
+   samplevar   
+   samplestd   
+   signaltonoise   
+   bayes_mvs  
+   var   
+   std   
+   stderr   
+   sem   
+   z   
+   zs   
+   zmap   
+    
+.. autosummary::
+   :toctree: generated/
+
+   threshold   
+   trimboth   
+   trim1   
+   cov   
+   corrcoef   
+    
+.. autosummary::
+   :toctree: generated/
+
+   f_oneway   
+   paired   
+   pearsonr   
+   spearmanr   
+   pointbiserialr   
+   kendalltau   
+   linregress   
+    
+.. autosummary::
+   :toctree: generated/
+
+   ttest_1samp   
+   ttest_ind   
+   ttest_rel   
+   kstest   
+   chisquare   
+   ks_2samp   
+   meanwhitneyu   
+   tiecorrect   
+   ranksums   
+   wilcoxon   
+   kruskal   
+   friedmanchisquare    
+    
+.. autosummary::
+   :toctree: generated/
+
+   ansari   
+   bartlett   
+   levene   
+   shapiro   
+   anderson   
+   binom_test   
+   fligner   
+   mood   
+   oneway   
+    
+    
+.. autosummary::
+   :toctree: generated/
+
+   glm   
+   anova 
+    
+Plot-tests
+==========
+
+.. autosummary::
+   :toctree: generated/
+
+   probplot   
+   ppcc_max   
+   ppcc_plot   
+    
+    
+For many more stat related functions install the software R and the
+interface package rpy.

Added: scipy-docs/trunk/source/weave.rst
===================================================================
--- scipy-docs/trunk/source/weave.rst	2008-10-26 17:51:47 UTC (rev 4848)
+++ scipy-docs/trunk/source/weave.rst	2008-10-26 17:54:24 UTC (rev 4849)
@@ -0,0 +1,6 @@
+======================================
+C/C++ integration (:mod:`scipy.weave`)
+======================================
+
+.. automodule:: scipy.weave
+   :members:



More information about the Scipy-svn mailing list