Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge branch 'documenation-updates' into develop

  • Loading branch information...
commit 98b3fec30cbdd3bf6261dc9344dda22543f99e72 2 parents c218ad5 + a5867a1
@nigma authored
Showing with 640 additions and 464 deletions.
  1. +65 −18 README.rst
  2. BIN  doc/source/_static/cog.png
  3. BIN  doc/source/_static/delicious.png
  4. BIN  doc/source/_static/github.png
  5. +42 −0 doc/source/_templates/editdocument.html
  6. +0 −38 doc/source/_templates/layout.html
  7. +42 −0 doc/source/_templates/page.html
  8. +12 −0 doc/source/_templates/quicklinks.html
  9. +14 −11 doc/source/conf.py
  10. +18 −0 doc/source/contents.rst
  11. +47 −0 doc/source/dev/building_extension.rst
  12. +0 −106 doc/source/dev/building_on_linux.rst
  13. +0 −105 doc/source/dev/building_on_windows.rst
  14. +14 −9 doc/source/dev/index.rst
  15. +61 −0 doc/source/dev/installing_build_dependencies.rst
  16. +27 −0 doc/source/dev/preparing_linux_build_environment.rst
  17. +90 −0 doc/source/dev/preparing_windows_build_environment.rst
  18. +41 −0 doc/source/dev/testing.rst
  19. +122 −12 doc/source/index.rst
  20. +1 −99 doc/source/overview.rst
  21. +5 −5 doc/source/ref/2d-dwt-and-idwt.rst
  22. +3 −3 doc/source/ref/dwt-discrete-wavelet-transform.rst
  23. +3 −3 doc/source/ref/idwt-inverse-discrete-wavelet-transform.rst
  24. +2 −2 doc/source/ref/other-functions.rst
  25. +2 −3 doc/source/ref/signal-extension-modes.rst
  26. +2 −2 doc/source/ref/swt-stationary-wavelet-transform.rst
  27. +0 −3  doc/source/ref/thresholding-functions.rst
  28. +3 −5 doc/source/ref/wavelet-packets.rst
  29. +1 −12 doc/source/ref/wavelets.rst
  30. +3 −4 doc/source/regression/index.rst
  31. +17 −12 doc/source/resources.rst
  32. +3 −12 doc/source/substitutions.rst
View
83 README.rst
@@ -1,13 +1,17 @@
-PyWavelets Intro
-----------------
+PyWavelets - Discrete Wavelet Transform in Python
+=================================================
-PyWavelets is a Python wavelet transforms module that can do:
+PyWavelets is a free Open Source wavelet transform software for Python_
+programming language. It is written in Python, Cython and C for a mix of easy
+and powerful high-level interface and the best performance.
+
+PyWavelets is very easy to start with and use, and currently is capable of:
* 1D and 2D Forward and Inverse Discrete Wavelet Transform (DWT and IDWT)
* 1D and 2D Stationary Wavelet Transform (Undecimated Wavelet Transform)
* 1D and 2D Wavelet Packet decomposition and reconstruction
- * Computing Approximations of wavelet and scaling functions
- * Over seventy built-in wavelet filters and support for custom wavelets
+ * Approximating wavelet and scaling functions
+ * Over seventy built-in wavelet filters and custom wavelets supported
* Single and double precision calculations
* Results compatibility with Matlab Wavelet Toolbox (tm)
@@ -16,21 +20,29 @@ PyWavelets is a Python wavelet transforms module that can do:
:alt: Build Status
:target: https://secure.travis-ci.org/nigma/pywt
+
+Requirements
+------------
+
+PyWavelets is a package for the Python programming language. It requires:
+
+ - Python_ 2.6 or 2.7
+ - numpy_ numeric array module
+
Download
--------
The most recent *development* version can be found on GitHub at
https://github.com/nigma/pywt.
-Latest release (not always up-to-date), including source and binary package for Windows,
-is available for download from the
-`Python Package Index <http://pypi.python.org/pypi/PyWavelets>`_.
+Latest release, including source and binary package for Windows, is available
+for download from the `Python Package Index`_.
Install
-------
In order to build PyWavelets from source, a working C compiler (GCC or MSVC)
-and a recent version of Cython (http://cython.org/) is required.
+and a recent version of Cython_ is required.
- To install PyWavelets open shell prompt and type ``pip install PyWavelets``
or ``easy_install PyWavelets``.
@@ -38,21 +50,35 @@ and a recent version of Cython (http://cython.org/) is required.
- To build and install from source, navigate to downloaded PyWavelets source
code directory and type ``python setup.py install``.
- - The `in-development version <https://github.com/nigma/pywt/tarball/develop#egg=PyWavelets-dev>`_
- of PyWavelets can be installed with ``pip install PyWavelets==dev``
- or ``easy_install PyWavelets==dev``.
+ - The `in-development version`_ of PyWavelets can be installed with
+ ``pip install PyWavelets==dev`` or ``easy_install PyWavelets==dev``.
Prebuilt Windows binaries and source code packages are also
-available from http://pypi.python.org/pypi/PyWavelets.
+available from `Python Package Index`_.
+
+Binary packages for several Linux distributors are maintained by Open Source
+community contributors. Query your Linux package manager tool
+for `python-wavelets`, `python-pywt` or similar package name.
Documentation
-------------
-Documentation and links to more resources is available online
-at http://www.pybytes.com/pywavelets/.
+Documentation with detailed examples and links to more resources is available
+online at http://www.pybytes.com/pywavelets/.
+
+For more usage examples see the `demo`_ directory in the source package.
+
+Contributing
+------------
+
+PyWavelets started in 2006 as an academic project for a master thesis
+on `Analysis and Classification of Medical Signals using Wavelet Transforms`
+and is maintained by its `original developer`_.
-For more usage examples see `demo <https://github.com/nigma/pywt/tree/master/demo>`_
-directory in the source package.
+All contributions including bug reports, bug fixes, new feature implementations
+and documentation improvements are welcome.
+
+Go and fork on `GitHub`_ today!
Python 3
--------
@@ -62,7 +88,28 @@ Check out the `changelog <https://github.com/nigma/pywt/commits/py-3>`_ for
info. Currently the code and examples are ported to work on Python 2.7 and 3.2
from the same codebase.
+Contact
+-------
+
+Use `GitHub Issues`_ or `PyWavelets discussions group`_ to post your
+comments or questions.
+
+To contact me directly email me at en@ig.ma.
+
License
-------
-PyWavelets is distributed under MIT license terms (see COPYING).
+PyWavelets is a free Open Source software released under the MIT license.
+
+
+.. _Cython: http://cython.org/
+.. _demo: https://github.com/nigma/pywt/tree/master/demo
+.. _GitHub: https://github.com/nigma/pywt
+.. _GitHub Issues: https://github.com/nigma/pywt/issues
+.. _in-development version: https://github.com/nigma/pywt/tarball/develop#egg=PyWavelets-dev
+.. _numpy: http://numpy.scipy.org/
+.. _original developer: http://en.ig.ma
+.. _Python: http://python.org/
+.. _Python Package Index: http://pypi.python.org/pypi/PyWavelets/
+.. _PyWavelets discussions group: http://groups.google.com/group/pywavelets
+
View
BIN  doc/source/_static/cog.png
Deleted file not rendered
View
BIN  doc/source/_static/delicious.png
Deleted file not rendered
View
BIN  doc/source/_static/github.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
42 doc/source/_templates/editdocument.html
@@ -0,0 +1,42 @@
+{% set repo="nigma/pywt" %}
+{% set branch="develop" %}
+
+<div id="edit-instructions">
+ <h3>Edit this document</h3>
+ <p>
+ <a href="#" id="toggle-edit-info">
+ <img src="{{ pathto("_static/page_edit.png", 1) }}" height="16" width="16" alt="" />
+ The source code of this file is hosted on GitHub. Everyone can
+ update and fix errors in this document with few clicks -
+ no downloads needed.
+ </a>
+ </p>
+ <ol id="edit-info" style="display: none;">
+ <li>
+ Go to
+ <i><a href="https://github.com/{{ repo }}/blob/{{ branch }}/doc/source/{{ pagename }}.rst" target="_blank">
+ {{ title }}
+ </a></i> on GitHub.
+ </li>
+ <li>
+ Press <b>Edit this file</b> button.
+ </li>
+ <li>
+ Edit file contents using GitHub's text editor in your web browser
+ </li>
+ <li>
+ Fill in the <b>Commit message</b> text box at the end of the page
+ telling <i>why</i> you did the changes.
+ Press <b>Propose file change</b> button next to it when done.
+ </li>
+ <li>
+ On <i>Send a pull request</i> page you don't need to fill in text
+ anymore. Just press <b>Send pull request</b> button.
+ </li>
+ <li>
+ Your changes are now queued for review under project's
+ <a href="https://github.com/{{ repo }}/pulls" target="_blank">Pull requests</a> tab
+ on Github.
+ </li>
+ </ol>
+</div>
View
38 doc/source/_templates/layout.html
@@ -1,38 +0,0 @@
-{% extends "!layout.html" %}
-
-{% block extrahead %}
- {{ super() }}
- <meta name="description" content="PyWavelets is a scientific Python module for Wavelet Transform calculations." />
- <meta name="keywords" content="PyWavelets, wavelets, Python, wavelet transform, discrete wavelet transform, dwt, idwt, swt, wavelet packets, stationary wavelet transform, pywt, Filip Wasilewski" />
- <meta name="author" content="Filip Wasilewski" />
- <meta name="Distribution" content="Global" />
- <meta name="Robots" content="INDEX,FOLLOW" />
-{% endblock %}
-
-{% block footer %}
- {{ super() }}
- <script type="text/javascript">
- var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
- document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
- </script>
- <script type="text/javascript">
- var pageTracker = _gat._getTracker("UA-3396395-3");
- pageTracker._initData();
- pageTracker._trackPageview();
- </script>
-{% endblock %}
-
-
-{% block sidebarsearch %}{{ super() }}
-<div>
-<h3>Quick links</h3>
-<ul>
-<li><a href="http://groups.google.com/group/pywavelets"><img src="{{ pathto("_static/comments.png", 1) }}" height="16" width="16" alt="" /> Visit Discussion Group</a></li>
-<li><a href="https://github.com/nigma/pywt"><img src="{{ pathto("_static/cog.png", 1) }}" height="16" width="16" alt="" /> Code on Github</a></li>
-<li><a href="https://bitbucket.org/nigma/pywt"><img src="{{ pathto("_static/cog.png", 1) }}" height="16" width="16" alt="" /> Code on Bitbucket</a></li>
-<li><a href="http://wavelets.pybytes.com/"><img src="{{ pathto("_static/wave.png", 1) }}" height="16" width="16" alt="" /> Explore Wavelets</a></li>
-<li><a href="http://delicious.com/save" onclick="window.open('http://delicious.com/save?v=5&amp;noui&amp;jump=close&amp;url='+encodeURIComponent('http://www.pybytes.com/pywavelets/')+'&amp;title='+encodeURIComponent('PyWavelets - Discrete Wavelet Transform in Python'), 'delicious','toolbar=no,width=550,height=550'); return false;"><img src="{{ pathto("_static/delicious.png", 1) }}" height="12" width="12" alt="Delicious" style="margin: 0 2px 0 2px;" /> Bookmark with Delicious</a></li>
-<li><a href="http://twitter.com/filipwasilewski"><img src="{{ pathto("_static/twitter.png", 1) }}" height="16" width="16" alt="" /> Follow on Twitter</a></li>
-</ul>
-</div>
-{% endblock %}
View
42 doc/source/_templates/page.html
@@ -0,0 +1,42 @@
+{# Drop version number from the HTML documentation title #}
+{%- set docstitle = "PyWavelets Documentation" %}
+
+{% extends "!page.html" %}
+
+{% block extrahead %}
+{{ super() }}
+<meta name="description" content="PyWavelets is a scientific Python module for Wavelet Transform calculations."/>
+<meta name="keywords" content="PyWavelets, wavelets, Python, wavelet transform, discrete wavelet transform, dwt, idwt, swt, wavelet packets, stationary wavelet transform, pywt, Filip Wasilewski"/>
+<meta name="author" content="Filip Wasilewski"/>
+<meta name="Distribution" content="Global"/>
+<meta name="Robots" content="INDEX,FOLLOW"/>
+
+<script type="text/javascript">
+ (function ($) {
+ $(document).ready(function () {
+ $("#toggle-edit-info").click(function (e) {
+ e.preventDefault();
+ $("#edit-info").toggle();
+ });
+ });
+ })(jQuery);
+</script>
+<script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-3396395-3']);
+ _gaq.push(['_trackPageview']);
+ (function () {
+ var ga = document.createElement('script');
+ ga.type = 'text/javascript';
+ ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0];
+ s.parentNode.insertBefore(ga, s);
+ })();
+</script>
+{% endblock %}
+
+{# Remove version number from the top and bottom path bars #}
+{%- block rootrellink %}
+ <li><a href="{{ pathto(master_doc) }}">Home{{ reldelim1 }}</a></li>
+{%- endblock %}
View
12 doc/source/_templates/quicklinks.html
@@ -0,0 +1,12 @@
+<div>
+<h3>Python Development</h3>
+<p><a href="http://en.ig.ma/">Django web development for startups and businesses.</a></p>
+<p><a href="http://en.ig.ma/">Quality Python development and scientific applications.</a></p>
+<h3>Quick links</h3>
+<ul>
+<li><a href="https://github.com/nigma/pywt"><img src="{{ pathto("_static/github.png", 1) }}" height="16" width="16" alt="" /> Fork on Github</a></li>
+<li><a href="http://groups.google.com/group/pywavelets"><img src="{{ pathto("_static/comments.png", 1) }}" height="16" width="16" alt="" /> Discussion Group</a></li>
+<li><a href="http://wavelets.pybytes.com/"><img src="{{ pathto("_static/wave.png", 1) }}" height="16" width="16" alt="" /> Explore Wavelets</a></li>
+<li><a href="http://twitter.com/filipwasilewski"><img src="{{ pathto("_static/twitter.png", 1) }}" height="16" width="16" alt="" /> Follow on Twitter</a></li>
+</ul>
+</div>
View
25 doc/source/conf.py
@@ -24,7 +24,7 @@
# 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.doctest', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath']
+extensions = ['sphinx.ext.doctest', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.extlinks']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -39,8 +39,8 @@
master_doc = 'index'
# General information about the project.
-project = u'PyWavelets'
-copyright = jinja2.filters.do_mark_safe(u'2006-%s, <a href="http://filipwasilewski.pl/">Filip Wasilewski</a>' % datetime.date.today().year)
+project = 'PyWavelets'
+copyright = jinja2.filters.do_mark_safe('2006-%s, <a href="http://en.ig.ma/">Filip Wasilewski</a>' % datetime.date.today().year)
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -62,11 +62,11 @@
#today_fmt = '%B %d, %Y'
# List of documents that shouldn't be included in the build.
-unused_docs = ['substitutions']
+unused_docs = ['substitutions', 'overview']
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
-exclude_trees = ['_build', '0.1.6']
+exclude_trees = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
@@ -86,14 +86,14 @@
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+modindex_common_prefix = ['pywt.']
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
+html_theme = 'nature'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -134,6 +134,9 @@
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
+html_sidebars = {
+ '**': ['localtoc.html', "relations.html", 'quicklinks.html', 'searchbox.html', 'editdocument.html'],
+}
# Additional templates that should be rendered to pages, maps page names to
# template names.
@@ -149,12 +152,12 @@
#html_split_index = False
# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
# 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 = ''
+html_use_opensearch = 'http://pybytes.com/pywavelets'
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''
@@ -174,8 +177,8 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('index', 'PyWavelets.tex', u'PyWavelets Documentation',
- u'Filip Wasilewski', 'manual'),
+ ('index', 'PyWavelets.tex', 'PyWavelets Documentation',
+ 'Filip Wasilewski', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
View
18 doc/source/contents.rst
@@ -0,0 +1,18 @@
+.. _contents:
+
+PyWavelets
+==========
+
+.. toctree::
+ :maxdepth: 2
+
+ ref/index
+ regression/index
+ dev/index
+ resources
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
View
47 doc/source/dev/building_extension.rst
@@ -0,0 +1,47 @@
+.. _dev-building-extension:
+
+Building and installing PyWavelets
+==================================
+
+Installing from source code
+---------------------------
+
+Go to https://github.com/nigma/pywt GitHub project page, fork and clone the
+repository or use the upstream repository to get the source code::
+
+ git clone https://github.com/nigma/pywt.git PyWavelets
+
+Activate your Python virtual environment, go to the cloned source directory
+and type the following commands to build and install the package::
+
+ python setup.py build
+ python setup.py install
+
+To verify the installation run the following command::
+
+ python setup.py test
+
+To build docs::
+
+ cd doc
+ make html
+
+Installing a development version
+--------------------------------
+
+You can also install directly from the source repository::
+
+ pip install -e git+https://github.com/nigma/pywt.git#egg=PyWavelets
+
+or::
+
+ pip install PyWavelets==dev
+
+
+Installing a regular release from PyPi
+--------------------------------------
+
+A regular release can be installed with pip or easy_install::
+
+ pip install PyWavelets
+
View
106 doc/source/dev/building_on_linux.rst
@@ -1,106 +0,0 @@
-.. _dev-building-on-linux:
-
-.. module:: pywt
-.. include:: ../substitutions.rst
-
-=================
-Building on Linux
-=================
-
-
-Prepare build environment
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-There is a good chance that you already have a working build environment.
-Just skip steps that you don't need to execute.
-
-
-Install basic build tools
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Note that the example below uses ``aptitude`` package manager, which is
-specific to Debian and Ubuntu Linux distributions. Use your favourite package
-manager to install these packages on your OS.
-
-::
-
- aptitude install build-essential gcc python-dev git-core
-
-
-Setup Python virtualenv
-~~~~~~~~~~~~~~~~~~~~~~~
-
-A good practice is to create a separate Python virtual environment for each
-project. If you don't have `virtualenv <http://pypi.python.org/pypi/virtualenv>`_
-yet, install and activate it using::
-
- curl -O https://raw.github.com/pypa/virtualenv/master/virtualenv.py
- python virtualenv.py <name_of_the_venv>
- . <name_of_the_venv>/bin/activate
-
-
-Setup build dependencies
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Use ``pip`` (http://pypi.python.org/pypi/pip) to install necessary Python
-packages::
-
- pip install Cython numpy
-
-Install Sphinx
-~~~~~~~~~~~~~~
-
-Sphinx is a documentation tool that convert reStructuredText files into
-nice looking html documentation. It is only required to rebuild |pywt|
-documentation, not the package itself.
-
-Get Sphinx from the Python Package Index (http://pypi.python.org/pypi/Sphinx),
-or install it with::
-
- pip install Sphinx
-
-
-Install PyWavelets
-~~~~~~~~~~~~~~~~~~
-
-Installing from PyPi
---------------------
-
-::
-
- pip install PyWavelets
-
-
-Installing a development version
---------------------------------
-
-::
-
- pip install -e git+https://github.com/nigma/pywt.git#egg=PyWavelets
-
-or::
-
- pip install PyWavelets==dev
-
-
-Installing from source code
----------------------------
-
-Go to https://github.com/nigma/pywt GitHub project page, fork and clone the
-repository or use the upstream repository to get the source code::
-
- git clone https://github.com/nigma/pywt.git PyWavelets
-
-Activate your Python virtual env, go to the cloned source directory
-and type the following commands to build and install the package::
-
- python setup.py build
- python setup.py install
-
-To verify the installation go to the ``tests`` directory and run the following
-commands::
-
- python test_regression.py
- python test_doc.py
- python test_perfect_reconstruction.py
-
View
105 doc/source/dev/building_on_windows.rst
@@ -1,105 +0,0 @@
-.. _dev-building-on-windows:
-
-.. module:: pywt
-.. include:: ../substitutions.rst
-
-===================
-Building on Windows
-===================
-
-
-Prepare build environment
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-To start developing |pywt| code on Windows you will have to prepare build
-environment first. This will include installing a couple components like
-Python, MinGW C compiler, Cython, Numpy and Sphinx.
-
-
-Install Python
-~~~~~~~~~~~~~~
-
-Go to the Python download site http://python.org/download/ and get
-the recent 2.x Python for Windows version (Python 2.6 recommended).
-Install it.
-
-
-Install MinGW C compiler
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Take a look at http://www.mingw.org/wiki/Getting_Started
-and http://www.mingw.org/wiki/HOWTO_Install_the_MinGW_GCC_Compiler_Suite.
-Follow the instructions there to set up the compiler.
-
-You can also take a look at Cython's "Installing MinGW on Windows"
-page at http://docs.cython.org/src/tutorial/appendix.html.
-
-
-Configure Distutils
-~~~~~~~~~~~~~~~~~~~
-
-Distutils is a standard Python build system. By default it relies
-on Microsoft Visual C compiler, but it is recommended to use
-MinGW GCC compiler instead (|pywt| is developed and tested using GCC).
-
-In order to change the settings and use MinGW as the default compiler,
-edit or create a Distutils configuration file
-``c:\Python26\Lib\distutils\distutils.cfg`` and place the following
-entry in it::
-
- [build]
- compiler = mingw32
-
-
-Install Cython
-~~~~~~~~~~~~~~
-
-Instructions on installing recent Cython version are
-on http://docs.cython.org/src/quickstart/install.html.
-
-
-Install Numpy
-~~~~~~~~~~~~~
-
-Fetch and install a recent Numpy binary
-from http://new.scipy.org/download.html.
-
-
-Install Sphinx
-~~~~~~~~~~~~~~
-
-Sphinx is a documentation tool that convert reStructuredText files into
-nice looking html documentation. It is only required to rebuild |pywt|
-documentation, not the package itself.
-
-Get Sphinx from the Python Package Index (http://pypi.python.org/pypi/Sphinx),
-or install it with::
-
- easy_install -U Sphinx
-
-
-Ready to go
-~~~~~~~~~~~
-
-At this point you should be ready to go. Open command line and go to
-|pywt| source code directory.
-
-To build the project issue::
-
- python setup.py build
-
-To install::
-
- python setup.py install
-
-To build docs::
-
- cd doc
- doc2html.bat
-
-To run some tests::
-
- cd tests
- python test_regression.py
- python test_doc.py
- python test_perfect_reconstruction.py
View
23 doc/source/dev/index.rst
@@ -1,22 +1,27 @@
.. _dev-index:
-.. module:: pywt
-.. include:: ../substitutions.rst
Development notes
=================
+This section contains information on building and installing PyWavelets
+from source code as well as instructions for preparing the build environment
+on Windows and Linux.
+
.. toctree::
:maxdepth: 2
- building_on_windows
- building_on_linux
-
+ preparing_windows_build_environment
+ preparing_linux_build_environment
+ installing_build_dependencies
+ building_extension
+ testing
Something not working?
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
If these instructions are not clear or you need help setting up your
-development environment, ask at the |pywt| discussion
-group - http://groups.google.com/group/pywavelets
-or pywavelets@googlegroups.com.
+development environment, go ahead and ask on the PyWavelets discussion
+group at http://groups.google.com/group/pywavelets or open a ticket on GitHub_.
+
+.. _GitHub: https://github.com/nigma/pywt
View
61 doc/source/dev/installing_build_dependencies.rst
@@ -0,0 +1,61 @@
+.. _dev-installing-build-dependencies:
+
+Installing build dependencies
+=============================
+
+Setting up Python virtual environment
+-------------------------------------
+
+A good practice is to create a separate Python virtual environment for each
+project. If you don't have `virtualenv`_ yet, install and activate it using::
+
+ curl -O https://raw.github.com/pypa/virtualenv/master/virtualenv.py
+ python virtualenv.py <name_of_the_venv>
+ . <name_of_the_venv>/bin/activate
+
+
+Installing Cython
+-----------------
+
+Use ``pip`` (http://pypi.python.org/pypi/pip) to install Cython_::
+
+
+ pip install Cython>=0.16
+
+
+Installing numpy
+----------------
+
+Use ``pip`` to install numpy_::
+
+ pip install numpy
+
+It takes some time to compile numpy, so it might be more convenient to install
+it from a binary release.
+
+.. note::
+
+ Installing numpy in a virtual environment on Windows is not straightforward.
+
+ It is recommended to download a suitable binary ``.exe`` release from
+ http://www.scipy.org/Download/ and install it using ``easy_install``
+ (i.e. ``easy_install numpy-1.6.2-win32-superpack-python2.7.exe``).
+
+.. note::
+
+ You can find binaries for 64-bit Windows on http://www.lfd.uci.edu/~gohlke/pythonlibs/.
+
+
+Installing Sphinx
+-----------------
+
+Sphinx_ is a documentation tool that converts reStructuredText files into
+nicely looking html documentation. Install it with::
+
+ pip install Sphinx
+
+
+.. _virtualenv: http://pypi.python.org/pypi/virtualenv
+.. _numpy: http://numpy.scipy.org/
+.. _Cython: http://cython.org/
+.. _Sphinx: http://sphinx.pocoo.org
View
27 doc/source/dev/preparing_linux_build_environment.rst
@@ -0,0 +1,27 @@
+.. _dev-preparing-linux-build-environment:
+
+
+Preparing Linux build environment
+=================================
+
+There is a good chance that you already have a working build environment.
+Just skip steps that you don't need to execute.
+
+
+Installing basic build tools
+----------------------------
+
+Note that the example below uses ``aptitude`` package manager, which is
+specific to Debian and Ubuntu Linux distributions. Use your favourite package
+manager to install these packages on your OS.
+
+::
+
+ aptitude install build-essential gcc python-dev git-core
+
+
+Next steps
+----------
+
+After completing these steps continue with
+:ref:`Installing build dependencies <dev-installing-build-dependencies>`.
View
90 doc/source/dev/preparing_windows_build_environment.rst
@@ -0,0 +1,90 @@
+.. _dev-building-on-windows:
+
+
+Preparing Windows build environment
+===================================
+
+To start developing PyWavelets code on Windows you will have to install
+a C compiler and prepare the build environment.
+
+Installing Windows SDK C/C++ compiler
+-------------------------------------
+
+Download Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1
+from http://www.microsoft.com/downloads/en/details.aspx?familyid=71DEB800-C591-4F97-A900-BEA146E4FAE1&displaylang=en.
+Download, extract and install the version that is suitable for your platform:
+
+ - ``GRMSDK_EN_DVD.iso`` for 32-bit x86 platform
+ - ``GRMSDKX_EN_DVD.iso`` for 64-bit AMD64 platform
+
+Before compiling a Python extension you have to configure some environment
+variables.
+
+For 32-bit build execute ``util/setenv_build32.bat`` script in the cmd window:
+
+ .. sourcecode:: bat
+
+ rem Configure the environment for 32-bit builds.
+ rem Use "vcvars32.bat" for a 32-bit build.
+ "C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars32.bat"
+ rem Convince setup.py to use the SDK tools.
+ set MSSdk=1
+ setenv /x86 /release
+ set DISTUTILS_USE_SDK=1
+
+For 64-bit use ``util/setenv_build64.bat``:
+
+ .. sourcecode:: bat
+
+ rem Configure the environment for 64-bit builds.
+ rem Use "vcvars32.bat" for a 32-bit build.
+ "C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat"
+ rem Convince setup.py to use the SDK tools.
+ set MSSdk=1
+ setenv /x64 /release
+ set DISTUTILS_USE_SDK=1
+
+See also http://wiki.cython.org/64BitCythonExtensionsOnWindows.
+
+MinGW C/C++ compiler
+--------------------
+
+MinGW distribution can be downloaded from http://sourceforge.net/projects/mingwbuilds/.
+
+In order to change the settings and use MinGW as the default compiler,
+edit or create a Distutils configuration file
+``c:\Python2*\Lib\distutils\distutils.cfg`` and place the following
+entry in it::
+
+ [build]
+ compiler = mingw32
+
+You can also take a look at Cython's "Installing MinGW on Windows"
+page at http://wiki.cython.org/InstallingOnWindows for more info.
+
+
+.. note::
+
+ Python 2.7/3.2 distutils package is incompatible with current version
+ of MinGW (4.7+) after MinGW dropped the `-mno-cygwin` flag.
+
+ To use MinGW to compile Python extensions you have to patch the
+ ``distutils/cygwinccompiler.py`` library module and remove every occurrence
+ of ``-mno-cygwin``.
+
+ See http://bugs.python.org/issue12641 bug report for more information
+ on the issue.
+
+
+Next steps
+----------
+
+After completing these steps continue with
+:ref:`Installing build dependencies <dev-installing-build-dependencies>`.
+
+
+.. _Python: http://python.org/
+.. _numpy: http://numpy.scipy.org/
+.. _Cython: http://cython.org/
+.. _Sphinx: http://sphinx.pocoo.org/
+.. _MinGW C compiler: http://sourceforge.net/projects/mingwbuilds/
View
41 doc/source/dev/testing.rst
@@ -0,0 +1,41 @@
+.. _dev-testing:
+
+Testing
+=======
+
+Continous integration with Travis-CI
+------------------------------------
+
+The project is using `Travis-CI <http://travis-ci.org/#!/nigma/pywt>`_ service
+for continous integration and testing.
+
+Current build status is:
+
+.. image::
+ https://secure.travis-ci.org/nigma/pywt.png?branch=develop
+ :alt: Build Status
+ :target: https://secure.travis-ci.org/nigma/pywt
+
+
+If you are submitting a patch or pull request please make sure it
+does not break the build.
+
+
+Running tests locally
+---------------------
+
+Simply::
+
+ python setup.py test
+
+
+Running tests with Tox
+----------------------
+
+There's also a config file for running tests with Tox (``pip install tox``)::
+
+ tox
+
+It is not however very convenient at the moment because Tox recreates
+the test environment (which is a good thing) and builds numpy from
+source on every run (which takes a lot of time).
View
134 doc/source/index.rst
@@ -1,26 +1,136 @@
PyWavelets - Discrete Wavelet Transform in Python
=================================================
-.. note::
+PyWavelets is a free Open Source wavelet transform software for Python_
+programming language. It is written in Python, Cython and C for a mix of easy
+and powerful high-level interface and the best performance.
- This documentation covers PyWavelets 0.2 release.
- Documentation for the 0.1.6 release is still available at
- http://www.pybytes.com/pywavelets/0.1.6/.
+PyWavelets is very easy to start with and use. Just install the package, open
+the Python interactive shell and type:
-Contents:
+ .. sourcecode:: python
+
+ >>> import pywt
+ >>> cA, cD = pywt.dwt([1, 2, 3, 4], 'db1')
+
+Voilà! Computing wavelet transforms never before has been so simple :)
+
+Main features
+-------------
+
+The main features of PyWavelets are:
+
+ * 1D and 2D Forward and Inverse Discrete Wavelet Transform (DWT and IDWT)
+ * 1D and 2D Stationary Wavelet Transform (Undecimated Wavelet Transform)
+ * 1D and 2D Wavelet Packet decomposition and reconstruction
+ * Approximating wavelet and scaling functions
+ * Over seventy `built-in wavelet filters`_
+ and custom wavelets supported
+ * Single and double precision calculations
+ * Results compatibility with Matlab Wavelet Toolbox |tm|
+
+Requirements
+------------
+
+PyWavelets is a package for the Python programming language. It requires:
+
+ - Python_ 2.6 or 2.7
+ - numpy_ numeric array module
+
+Download
+--------
+
+The most recent *development* version can be found on GitHub at
+https://github.com/nigma/pywt.
+
+Latest release, including source and binary package for Windows, is available
+for download from the `Python Package Index`_.
+
+Install
+-------
+
+In order to build PyWavelets from source, a working C compiler (GCC or MSVC)
+and a recent version of Cython_ is required.
+
+ - To install PyWavelets open shell prompt and type ``pip install PyWavelets``
+ or ``easy_install PyWavelets``.
+
+ - To build and install from source, navigate to downloaded PyWavelets source
+ code directory and type ``python setup.py install``.
+
+ - The `in-development version`_ of PyWavelets can be installed with
+ ``pip install PyWavelets==dev`` or ``easy_install PyWavelets==dev``.
+
+Prebuilt Windows binaries and source code packages are also
+available from `Python Package Index`_.
+
+Binary packages for several Linux distributors are maintained by Open Source
+community contributors. Query your Linux package manager tool
+for `python-wavelets`, `python-pywt` or similar package name.
+
+.. seealso:: :ref:`Development notes <dev-index>` section contains more
+ information on building and installing from source code.
+
+Documentation
+-------------
+
+Documentation with detailed examples and links to more resources is available
+online at http://www.pybytes.com/pywavelets/.
+
+For more usage examples see the `demo`_ directory in the source package.
+
+Contributing
+------------
+
+PyWavelets started in 2006 as an academic project for a master thesis
+on `Analysis and Classification of Medical Signals using Wavelet Transforms`
+and is maintained by its `original developer`_.
+
+All contributions including bug reports, bug fixes, new feature implementations
+and documentation improvements are welcome.
+
+Go and fork on `GitHub`_ today!
+
+Contact
+-------
+
+Use `GitHub Issues`_ or `PyWavelets discussions group`_ to post your
+comments or questions.
+
+To contact me directly email me at en@ig.ma.
+
+License
+-------
+
+PyWavelets is a free Open Source software released under the MIT license.
+
+
+.. |tm| unicode:: U+2122 .. trademark sign
+ :ltrim:
+
+
+Contents
+--------
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- overview
ref/index
regression/index
dev/index
resources
+ contents
+
-Indices and tables
-==================
+.. _built-in wavelet filters: http://wavelets.pybytes.com/
+.. _Cython: http://cython.org/
+.. _demo: https://github.com/nigma/pywt/tree/master/demo
+.. _GitHub: https://github.com/nigma/pywt
+.. _GitHub Issues: https://github.com/nigma/pywt/issues
+.. _in-development version: https://github.com/nigma/pywt/tarball/develop#egg=PyWavelets-dev
+.. _numpy: http://numpy.scipy.org/
+.. _original developer: http://en.ig.ma
+.. _Python: http://python.org/
+.. _Python Package Index: http://pypi.python.org/pypi/PyWavelets/
+.. _PyWavelets discussions group: http://groups.google.com/group/pywavelets
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
View
100 doc/source/overview.rst
@@ -1,99 +1 @@
-.. _ref-overview:
-
-.. module:: pywt
-.. include:: substitutions.rst
-
-========
-Overview
-========
-
-|pywt| is a free Open Source wavelet transform software for Python_
-programming language. It is written in Python, Pyrex/Cython and C for a mix
-of easy and powerful high-level interface and the best performance.
-
-|pywt| is very easy to start with and use. Just install the package, open
-the Python interactive shell and type:
-
- .. sourcecode:: python
-
- >>> import pywt
- >>> cA, cD = pywt.dwt([1, 2, 3, 4], 'db1')
-
-Voilà! Computing wavelet transforms never before has been so simple :)
-
-Main features
--------------
-
-The main features of |pywt| are:
-
- * 1D and 2D Forward and Inverse Discrete Wavelet Transform (DWT and IDWT)
- * 1D and 2D Stationary Wavelet Transform (Undecimated Wavelet Transform)
- * 1D and 2D Wavelet Packet decomposition and reconstruction
- * Approximating wavelet and scaling functions
- * Over seventy built-in wavelet filters and custom wavelets supported
- * Single and double precision calculations supported
- * Results compatibility with Matlab Wavelet Toolbox |tm|
-
-Requirements
-------------
-
-|pywt| is a Python programming language package and requires `Python <http://python.org/>`_
-2.5-2.7 installed. The only external requirement is a recent version of
-`NumPy <http://numpy.scipy.org/>`_ numeric array module.
-
-Download
---------
-
-The most recent *development* version can be found in Git and Hg repositories at:
-
- * Github - https://github.com/nigma/pywt
- * Bitbucket - https://bitbucket.org/nigma/pywt
-
-Latest release (not always up-to-date), including source and binary package for Windows,
-is available for download from the Python Package Index at http://pypi.python.org/pypi/PyWavelets/.
-
-Install
--------
-
-In order to build |pywt| from source, a working C compiler and a recent version
-of `Cython <http://www.cython.org/>`_ and `Numpy <http://numpy.scipy.org/>`_ is required.
-
-After completing the build environment, open the shell prompt, go to the
-|pywt| source code directory and type::
-
- python setup.py install
-
-.. seealso:: :ref:`Development notes <dev-index>` section contains more
- information on building from source code.
-
-For Windows users there is a standard binary installer available for
-download from the `Python Package Index <http://pypi.python.org/pypi/PyWavelets/>`_.
-Just execute it to install the package on your computer.
-
-Binary packages for several Linux distributors are
-`maintained <http://wavelets.scipy.org/moin/Download>`_ by
-Open Source community contributors. Query your favourite package
-manager tool for `python-wavelets`, `python-pywt` or similar package name.
-
-To verify the installation process try running tests and examples from the
-`tests <http://projects.scipy.org/wavelets/browser/pywt/trunk/tests/>`_
-and `demo <http://projects.scipy.org/wavelets/browser/pywt/trunk/demo/>`_
-directories included in the source distribution.
-Note that most of the examples relies on the
-`matplotlib <http://matplotlib.sourceforge.net>`_ plotting package.
-
-License
--------
-
-|pywt| is a free Open Source software available under the
-:download:`MIT license terms <COPYING.txt>`.
-
-Contact
--------
-
-Post your suggestions and questions to `PyWavelets discussions
-group <http://groups.google.com/group/pywavelets>`_ (pywavelets@googlegroups.com).
-
-Comments, bug reports and fixes are welcome through `Github <https://github.com/nigma/pywt>`_ and `Bitbucket <https://bitbucket.org/nigma/pywt>`_ project sites.
-
-You can try to reach me directly at en@ig.ma but I can't promise I will get back to you in a reasonable time.
+Moved to :ref:`index <dev-index>`.
View
10 doc/source/ref/2d-dwt-and-idwt.rst
@@ -17,7 +17,7 @@ Single level ``dwt2``
:param data: 2D input data.
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param mode: |mode| This is only important when DWT was performed
in :ref:`periodization <MODES.per>` mode.
@@ -49,7 +49,7 @@ details coefficients are stored in one big 2D array is as follows:
| | |
-------------------
-|pywt| does not follow this pattern because of pure practical reasons of simple
+PyWavelets does not follow this pattern because of pure practical reasons of simple
access to particular type of the output coefficients.
**Example:**
@@ -81,7 +81,7 @@ Single level ``idwt2``
(cA, (cH, cV, cD))
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param mode: |mode| This is only important when the :func:`dwt` was performed
in the :ref:`periodization <MODES.per>` mode.
@@ -116,7 +116,7 @@ Single level ``idwt2``
:param data: |data|
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param mode: |mode|
@@ -148,7 +148,7 @@ Single level ``idwt2``
[cAn, (cHn, cVn, cDn), ..., (cH1, cV1, cD1)]
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param mode: |mode|
View
6 doc/source/ref/dwt-discrete-wavelet-transform.rst
@@ -26,7 +26,7 @@ Single level ``dwt``
:param data: |data|
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param mode: |mode|
@@ -78,7 +78,7 @@ Multilevel decomposition using ``wavedec``
:param data: |data|
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param mode: |mode|
@@ -115,7 +115,7 @@ Partial Discrete Wavelet Transform data decomposition ``downcoef``
:param data: |data|
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param mode: |mode|
View
6 doc/source/ref/idwt-inverse-discrete-wavelet-transform.rst
@@ -20,7 +20,7 @@ Single level ``idwt``
:param cD: Detail coefficients.
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param mode: |mode| This is only important when DWT was performed in
:ref:`periodization <MODES.per>` mode.
@@ -74,7 +74,7 @@ Multilevel reconstruction using ``waverec``
[cAn, cDn, cDn-1, ..., cD2, cD1]
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param mode: |mode|
@@ -102,7 +102,7 @@ Direct reconstruction with ``upcoef``
:param coeffs: Coefficients array to reconstruct.
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param level: If *level* value is specified then a multilevel reconstruction is
performed (first reconstruction is of type specified by *part*
View
4 doc/source/ref/other-functions.rst
@@ -16,8 +16,8 @@ Single-level n-dimensional Discrete Wavelet Transform.
Performs single-level n-dimensional Discrete Wavelet Transform.
:param data: n-dimensional array
- :param wavelet: wavelet to use (Wavelet object or name string)
- :param mode: signal extension mode, see MODES
+ :param wavelet: |wavelet|
+ :param mode: |mode|
Results are arranged in a dictionary, where key specifies
the transform type on each dimension and value is a n-dimensional
View
5 doc/source/ref/signal-extension-modes.rst
@@ -1,7 +1,6 @@
.. _ref-modes:
.. currentmodule:: pywt
-.. include:: ../substitutions.rst
======================
@@ -20,7 +19,7 @@ Depending on the extrapolation method, significant artifacts at the signal's
borders can be introduced during that process, which in turn may lead to
inaccurate computations of the :ref:`DWT <ref-dwt>` at the signal's ends.
-|pywt| provides several methods of signal extrapolation that can be used to
+PyWavelets provides several methods of signal extrapolation that can be used to
minimize this negative effect:
.. _`MODES.zpd`:
@@ -84,7 +83,7 @@ parameters:
>>> (a, d) = pywt.dwt([1,2,3,4,5,6], pywt.Wavelet('db2'), pywt.MODES.sp1)
.. note::
- Extending data in context of |pywt| does not mean reallocation of the data
+ Extending data in context of PyWavelets does not mean reallocation of the data
in computer's physical memory and copying values, but rather computing
the extra values only when they are needed.
This feature saves extra memory and CPU resources and helps to avoid page
View
4 doc/source/ref/swt-stationary-wavelet-transform.rst
@@ -21,7 +21,7 @@ Multilevel ``swt``
:param data: |data|
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param level: Required transform level. See the :func:`swt_max_level` function.
@@ -43,7 +43,7 @@ Multilevel ``swt2``
:param data: 2D array with input data.
- :param wavelet: |wavelet_arg|
+ :param wavelet: |wavelet|
:param level: Number of decomposition steps to perform.
View
3  doc/source/ref/thresholding-functions.rst
@@ -1,8 +1,5 @@
.. _ref-thresholding:
-.. module:: pywt.thresholding
-.. include:: ../substitutions.rst
-
Thresholding functions
======================
View
8 doc/source/ref/wavelet-packets.rst
@@ -9,7 +9,7 @@ Wavelet Packets
.. versionadded:: 0.2
-Version `0.2` of |pywt| includes many new features and improvements. One of such
+Version `0.2` of PyWavelets includes many new features and improvements. One of such
new feature is a two-dimensional wavelet packet transform structure that is
almost completely sharing programming interface with the one-dimensional tree
structure.
@@ -246,8 +246,7 @@ WaveletPacket and WaveletPacket tree Node
:param data: data associated with the node. 1D numeric array.
- :param wavelet: :class:`~pywt.Wavelet` to use for decomposition and
- reconstruction.
+ :param wavelet: |wavelet|
:param mode: Signal extension :ref:`mode <ref-modes>` for the :func:`dwt`
and :func:`idwt` decomposition and reconstruction functions.
@@ -302,8 +301,7 @@ WaveletPacket2D and WaveletPacket2D tree Node2D
:param data: data associated with the node. 2D numeric array.
- :param wavelet: :class:`~pywt.Wavelet` to use for decomposition and
- reconstruction.
+ :param wavelet: |wavelet|
:param mode: Signal extension :ref:`mode <ref-modes>` for the :func:`dwt`
and :func:`idwt` decomposition and reconstruction functions.
View
13 doc/source/ref/wavelets.rst
@@ -1,7 +1,6 @@
.. _ref-wavelets:
.. currentmodule:: pywt
-.. include:: ../substitutions.rst
========
Wavelets
@@ -77,12 +76,6 @@ Built-in wavelets - ``wavelist()``
[dec_lo, dec_hi, rec_lo, rec_hi]
- .. note::
-
- The :meth:`~Wavelet.get_filters_coeffs` method is kept for compatibility
- with the previous versions of |pywt|, but may be removed in a future version
- of the package.
-
Wavelet objects can also be used as a base filter banks. See section on
:ref:`using custom wavelets <custom-wavelets>` for more information.
@@ -131,8 +124,6 @@ Built-in wavelets - ``wavelist()``
[dec_lo, dec_hi, rec_lo, rec_hi]
- The :meth:`~Wavelet.get_filters_coeffs` method is deprecated.
-
.. attribute:: inverse_filter_bank
Returns list of reverse wavelet filters coefficients. The mapping from the
@@ -140,8 +131,6 @@ Built-in wavelets - ``wavelist()``
[rec_lo[::-1], rec_hi[::-1], dec_lo[::-1], dec_hi[::-1]]
- The :meth:`~Wavelet.get_reverse_filters_coeffs` method is deprecated.
-
.. attribute:: short_family_name
Wavelet short family name
@@ -250,7 +239,7 @@ Approximating wavelet and scaling functions - ``Wavelet.wavefun()``
Using custom wavelets
---------------------
-|pywt| comes with a :func:`long list <pywt.wavelist>` of the most popular
+PyWavelets comes with a :func:`long list <pywt.wavelist>` of the most popular
wavelets built-in and ready to use. If you need to use a specific wavelet which
is not included in the list it is very easy to do so. Just pass a list of four
filters or an object with a :attr:`~Wavelet.filter_bank` attribute as a
View
7 doc/source/regression/index.rst
@@ -1,14 +1,13 @@
.. _reg-index:
.. currentmodule:: pywt
-.. include:: ../substitutions.rst
Usage examples
==============
-The following examples are used as doc-tests regression tests written using reST markup.
-They are included in the documentation since they contain various useful examples
-illustrating how to use and how to not use |pywt|.
+The following examples are used as doctest regression tests written using reST
+markup. They are included in the documentation since they contain various useful
+examples illustrating how to use and how not to use PyWavelets.
.. toctree::
:maxdepth: 1
View
29 doc/source/resources.rst
@@ -1,7 +1,5 @@
.. _ref-resources:
-.. include:: substitutions.rst
-
=========
Resources
=========
@@ -9,28 +7,35 @@ Resources
Code
----
-The `GitHub repository <https://github.com/nigma/pywt>` is now the main
+The `GitHub repository`_ is now the main
code repository.
-The `Mercurial repository <https://bitbucket.org/nigma/pywt>` is going to be
-phased out. Please follow GitHub for development updates.
+If you are using the Mercurial repository at Bitbucket, please switch
+to Git/GitHub and follow for development updates.
-Discussion group
-----------------
+Questions and bug reports
+-------------------------
-`PyWavelets discussions group <http://groups.google.com/group/pywavelets>`_
-(pywavelets@googlegroups.com)
+Use `GitHub Issues`_ or `PyWavelets discussions group`_ to post questions
+and open tickets.
Wavelet Properties Browser
--------------------------
-`wavelets.pybytes.com <http://wavelets.pybytes.com/>`_
+Browse properties and graphs of wavelets included in PyWavelets on
+`wavelets.pybytes.com`_.
Articles
--------
- - `Denoising: wavelet thresholding <http://blancosilva.wordpress.com/teaching/mathematical-imaging/denoising-wavelet-thresholding/>`
- - `Wavelet Regression in Python <http://jseabold.net/blog/2012/02/wavelet-regression-in-python.html>`
+ - `Denoising: wavelet thresholding <http://blancosilva.wordpress.com/teaching/mathematical-imaging/denoising-wavelet-thresholding/>`_
+ - `Wavelet Regression in Python <http://jseabold.net/blog/2012/02/wavelet-regression-in-python.html>`_
+
+
+.. _GitHub repository: https://github.com/nigma/pywt
+.. _GitHub Issues: https://github.com/nigma/pywt/issues
+.. _PyWavelets discussions group: http://groups.google.com/group/pywavelets
+.. _wavelets.pybytes.com: http://wavelets.pybytes.com/
View
15 doc/source/substitutions.rst
@@ -1,16 +1,7 @@
-.. |mode| replace:: Signal extension mode to deal with the border distortion problem. See `MODES` for details.
+.. |mode| replace:: Signal extension mode to deal with the border distortion problem. See :ref:`MODES <ref-modes>` for details.
.. |data| replace::
Input signal can be NumPy array, Python list or other iterable object. Both *single* and *double* precision floating-point data types are supported and the output type depends on the input type. If the input data is not in one of these types it will be converted to the default *double* precision data format before performing computations.
-.. |wavelet_arg| replace::
- Wavelet to use in the transform. This can be a name of the wavelet from the `pywt.wavelist` list or a `Wavelet` object instance.
-
-.. |pywt| replace:: `PyWavelets`
-
-.. |Wavelet| replace:: ``Wavelet``
-
-.. |tm| unicode:: U+2122 .. trademark sign
- :ltrim:
-
-.. |copy| unicode:: 0xA9 .. copyright sign
+.. |wavelet| replace::
+ Wavelet to use in the transform. This can be a name of the wavelet from the :func:`wavelist` list or a :class:`Wavelet` object instance.
Please sign in to comment.
Something went wrong with that request. Please try again.