Merge pull request #79 from PyWavelets/relnotes

DOC: add v0.3.0 release notes

CHANGES.txt

@@ -3,7 +3,7 @@ Changelog
 0.3.0
     A major refactoring, providing support for Python 3.x while maintaining
     full backwards compatiblity.
-    Development has moved to https://github.com/rgommers/pywt
+    Development has moved to https://github.com/PyWavelets/pywt
 
 0.2.2
     maintenance release:

README.rst

@@ -27,7 +27,7 @@ The main features of PyWavelets are:
   * Over seventy `built-in wavelet filters`_
     and custom wavelets supported
   * Single and double precision calculations
-  * Results compatible with Matlab Wavelet Toolbox |tm|
+  * Results compatible with Matlab Wavelet Toolbox (TM)
 
 Requirements
 ------------
@@ -41,11 +41,10 @@ Download
 --------
 
 The most recent *development* version can be found on GitHub at
-https://github.com/rgommers/pywt.
+https://github.com/PyWavelets/pywt.
 
 Latest release, including source and binary package for Windows, is available
-for download from the `Python Package Index`_ or on 
-`https://github.com/rgommers/pywt/releases`__
+for download from the `Python Package Index`_ or on the `Releases Page`_.
 
 Install
 -------
@@ -72,8 +71,7 @@ Documentation
 -------------
 
 Documentation with detailed examples and links to more resources is available
-online at http://www.pybytes.com/pywavelets/ and
-http://pywavelets.readthedocs.org.
+online at http://pywavelets.readthedocs.org.
 
 For more usage examples see the `demo`_ directory in the source package.
 
@@ -83,12 +81,12 @@ State of development & Contributing
 PyWavelets started in 2006 as an academic project for a master thesis
 on `Analysis and Classification of Medical Signals using Wavelet Transforms`
 and was maintained until 2012 by its `original developer`_.  In 2013
-maintenance was taken over in a new repo (`https://github.com/rgommers/pywt`__)
+maintenance was taken over in a `new repo <https://github.com/PyWavelets/pywt>`_)
 by a larger development team - a move supported by the original developer.
 The repo move doesn't mean that this is a fork - the package continues to be
 developed under the name "PyWavelets", and released on PyPi and Github (see
-`https://github.com/nigma/pywt/issues/13`__ for the discussion where that was
-decided).
+`this issue <https://github.com/nigma/pywt/issues/13>`_ for the discussion
+where that was decided).
 
 All contributions including bug reports, bug fixes, new feature implementations
 and documentation improvements are welcome.  Moreover, developers with an
@@ -126,11 +124,12 @@ Contents
 
 .. _built-in wavelet filters: http://wavelets.pybytes.com/
 .. _Cython: http://cython.org/
-.. _demo: https://github.com/rgommers/pywt/tree/master/demo
-.. _GitHub: https://github.com/rgommers/pywt
-.. _GitHub Issues: https://github.com/rgommers/pywt/issues
+.. _demo: https://github.com/PyWavelets/pywt/tree/master/demo
+.. _GitHub: https://github.com/PyWavelets/pywt
+.. _GitHub Issues: https://github.com/PyWavelets/pywt/issues
 .. _Numpy: http://www.numpy.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
+.. _Releases Page: https://github.com/PyWavelets/pywt/releases

doc/release/0.3.0-notes.rst

@@ -0,0 +1,135 @@
+==============================
+PyWavelets 0.3.0 Release Notes
+==============================
+
+.. contents::
+
+PyWavelets 0.3.0 is the first release of the package in 3 years.  It is the
+result of a significant effort of a growing development team to modernize the
+package, to provide Python 3.x support and to make a start with providing new
+features as well as improved performance.  A 0.4.0 release will follow
+shortly, and will contain more significant new features as well as
+changes/deprecations to streamline the API.
+
+This release requires Python 2.6, 2.7 or 3.3-3.5 and NumPy 1.6.2 or greater.
+
+Highlights of this release include:
+
+- Support for Python 3.x (>=3.3)
+- Added a test suite (based on nose, coverage up to 61% so far)
+- Maintenance work: C style complying to the Numpy style guide, improved
+  templating system, more complete docstrings, pep8/pyflakes compliance, and
+  more.
+
+
+New features
+============
+
+Test suite
+----------
+
+The test suite can be run with ``nosetests pywt`` or with::
+
+    >>> import pywt
+    >>> pywt.test()
+
+n-D Inverse Discrete Wavelet Transform
+--------------------------------------
+
+The function ``pywt.idwtn``, which provides n-dimensional inverse DWT, has been
+added.  It complements ``idwt``, ``idwt2`` and ``dwtn``.
+
+Thresholding
+------------
+
+The function `pywt.threshold` has been added.  It unifies the four thresholding
+functions that are still provided in the ``pywt.thresholding`` namespace.
+
+
+Backwards incompatible changes
+==============================
+
+None in this release.
+
+
+Other changes
+=============
+
+Development has moved to `a new repo <https://github.com/PyWavelets/pywt>`_.
+Everyone with an interest in wavelets is welcome to contribute!
+
+Building wheels, building with ``python setup.py develop`` and many other
+standard ways to build and install PyWavelets are supported now.
+
+
+Authors
+=======
+
+* Ankit Agrawal +
+* François Boulogne +
+* Ralf Gommers +
+* David Menéndez Hurtado +
+* Gregory R. Lee +
+* David McInnis +
+* Helder Oliveira +
+* Filip Wasilewski
+* Kai Wohlfahrt +
+
+A total of 9 people contributed to this release.
+People with a "+" by their names contributed a patch for the first time.
+This list of names is automatically generated, and may not be fully complete.
+
+
+Issues closed for v0.3.0
+------------------------
+
+- `#3 <https://github.com/PyWavelets/pywt/issues/3>`__: Remove numerix compat layer
+- `#4 <https://github.com/PyWavelets/pywt/issues/4>`__: Add single code base Python 3 support
+- `#5 <https://github.com/PyWavelets/pywt/issues/5>`__: PEP8 issues
+- `#6 <https://github.com/PyWavelets/pywt/issues/6>`__: Migrate tests to nose
+- `#7 <https://github.com/PyWavelets/pywt/issues/7>`__: Expand test coverage without Matlab to a reasonable level
+- `#8 <https://github.com/PyWavelets/pywt/issues/8>`__: Replace custom C templates by Numpy's templating system
+- `#9 <https://github.com/PyWavelets/pywt/issues/9>`__: Replace Cython templates by fused types
+- `#10 <https://github.com/PyWavelets/pywt/issues/10>`__: Replace use of __array_interface__ with Cython's memoryviews
+- `#11 <https://github.com/PyWavelets/pywt/issues/11>`__: Format existing docstrings in numpydoc format.
+- `#12 <https://github.com/PyWavelets/pywt/issues/12>`__: Complete docstrings, they're quite sparse right now
+- `#13 <https://github.com/PyWavelets/pywt/issues/13>`__: Reorganize source tree
+- `#24 <https://github.com/PyWavelets/pywt/issues/24>`__: doc/source/regression should be moved
+- `#27 <https://github.com/PyWavelets/pywt/issues/27>`__: Broken test: test_swt_decomposition
+- `#28 <https://github.com/PyWavelets/pywt/issues/28>`__: Install issue, no module tools.six
+- `#29 <https://github.com/PyWavelets/pywt/issues/29>`__: wp.update fails after removal of nodes
+- `#32 <https://github.com/PyWavelets/pywt/issues/32>`__: wp.update fails on 2D
+- `#34 <https://github.com/PyWavelets/pywt/issues/34>`__: Wavelet string attributes shouldn't be bytes in Python 3
+- `#35 <https://github.com/PyWavelets/pywt/issues/35>`__: Re-enable float32 support
+- `#36 <https://github.com/PyWavelets/pywt/issues/36>`__: wavelet instance vs string
+- `#40 <https://github.com/PyWavelets/pywt/issues/40>`__: Test with Numpy 1.8rc1
+- `#45 <https://github.com/PyWavelets/pywt/issues/45>`__: demos should be updated and integrated in docs
+- `#60 <https://github.com/PyWavelets/pywt/issues/60>`__: Moving pywt forward faster
+- `#61 <https://github.com/PyWavelets/pywt/issues/61>`__: issues to address in moving towards 0.3.0
+- `#71 <https://github.com/PyWavelets/pywt/issues/71>`__: BUG: _pywt.downcoef always returns level=1 result
+
+
+Pull requests for v0.3.0
+------------------------
+
+- `#1 <https://github.com/PyWavelets/pywt/pull/1>`__: travis: check all branches + fix URL
+- `#17 <https://github.com/PyWavelets/pywt/pull/17>`__: [DOC] doctrings for multilevel functions
+- `#18 <https://github.com/PyWavelets/pywt/pull/18>`__: DOC: format -> functions.py
+- `#20 <https://github.com/PyWavelets/pywt/pull/20>`__: MAINT: remove unnecessary zero() copy()
+- `#21 <https://github.com/PyWavelets/pywt/pull/21>`__: Doc wavelet_packets
+- `#22 <https://github.com/PyWavelets/pywt/pull/22>`__: Minor doc fixes
+- `#25 <https://github.com/PyWavelets/pywt/pull/25>`__: TEST: remove useless functions and use numpy instead
+- `#26 <https://github.com/PyWavelets/pywt/pull/26>`__: Merge most recent work
+- `#30 <https://github.com/PyWavelets/pywt/pull/30>`__: Adding test for wp.rst
+- `#41 <https://github.com/PyWavelets/pywt/pull/41>`__: Change to Numpy templating system
+- `#43 <https://github.com/PyWavelets/pywt/pull/43>`__: MAINT: update six.py to not use lazy loading.
+- `#49 <https://github.com/PyWavelets/pywt/pull/49>`__: Taking on API Issues
+- `#50 <https://github.com/PyWavelets/pywt/pull/50>`__: Add idwtn
+- `#53 <https://github.com/PyWavelets/pywt/pull/53>`__: readme updated with info related to Py3 version
+- `#63 <https://github.com/PyWavelets/pywt/pull/63>`__: Remove six
+- `#65 <https://github.com/PyWavelets/pywt/pull/65>`__: Thresholding
+- `#70 <https://github.com/PyWavelets/pywt/pull/70>`__: MAINT: PEP8 fixes
+- `#72 <https://github.com/PyWavelets/pywt/pull/72>`__: BUG: fix _downcoef for level > 1
+- `#73 <https://github.com/PyWavelets/pywt/pull/73>`__: MAINT: documentation and metadata update for repo fork
+- `#74 <https://github.com/PyWavelets/pywt/pull/74>`__: STY: fix pep8/pyflakes issues
+- `#77 <https://github.com/PyWavelets/pywt/pull/77>`__: MAINT: raise ValueError if data given to dwt or idwt is not 1D...

doc/source/_templates/page.html

@@ -6,7 +6,7 @@
 {% 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="keywords" content="PyWavelets, wavelets, Python, wavelet transform, discrete wavelet transform, dwt, idwt, swt, wavelet packets, stationary wavelet transform, pywt"/>
 <meta name="author" content="Filip Wasilewski"/>
 <meta name="Distribution" content="Global"/>
 <meta name="Robots" content="INDEX,FOLLOW"/>

doc/source/_templates/quicklinks.html

@@ -7,6 +7,5 @@ <h3>Quick links</h3>
 <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>
+</div>

doc/source/conf.py

@@ -11,7 +11,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import re
 import datetime
 import jinja2.filters
 
@@ -40,16 +40,19 @@
 
 # General information about the project.
 project = 'PyWavelets'
-copyright = jinja2.filters.do_mark_safe('2006-%s, <a href="http://en.ig.ma/">Filip Wasilewski</a>' % datetime.date.today().year)
+copyright = jinja2.filters.do_mark_safe('2006-%s, <a href="https://groups.google.com/forum/#!forum/pywavelets">The PyWavelets Developers</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
 # built documents.
-#
-# The short X.Y version.
-version = '0.2.2'
-# The full version, including alpha/beta/rc tags.
-release = '0.2.2'
+
+# The default replacements for |version| and |release|, also used in various
+# other places throughout the built documents.
+import pywt
+version = re.sub(r'\.dev-.*$', r'.dev', pywt.__version__)
+release = pywt.__version__
+
+print "PyWavelets (VERSION %s)" % (version,)
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -157,7 +160,7 @@
 # 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 = 'http://pybytes.com/pywavelets'
+html_use_opensearch = 'http://pywavelets.readthedocs.org'
 
 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 #html_file_suffix = ''
@@ -178,7 +181,7 @@
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
   ('index', 'PyWavelets.tex', 'PyWavelets Documentation',
-   'Filip Wasilewski', 'manual'),
+   'The PyWavelets Developers', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

doc/source/contents.rst

@@ -10,6 +10,7 @@ PyWavelets
    regression/index
    dev/index
    resources
+   releasenotes
 
 Indices and tables
 ==================

doc/source/dev/testing.rst

@@ -6,15 +6,15 @@ Testing
 Continous integration with Travis-CI
 ------------------------------------
 
-The project is using `Travis-CI <https://travis-ci.org/rgommers/pywt>`_ service
+The project is using `Travis-CI <https://travis-ci.org/PyWavelets/pywt>`_ service
 for continous integration and testing.
 
 Current build status is:
 
 .. image::
-    https://secure.travis-ci.org/rgommers/pywt.png?branch=develop
+    https://secure.travis-ci.org/PyWavelets/pywt.png?branch=master
     :alt: Build Status
-    :target: https://secure.travis-ci.org/rgommers/pywt
+    :target: https://secure.travis-ci.org/PyWavelets/pywt
 
 
 If you are submitting a patch or pull request please make sure it

doc/source/index.rst

@@ -27,7 +27,7 @@ The main features of PyWavelets are:
   * Over seventy `built-in wavelet filters`_
     and custom wavelets supported
   * Single and double precision calculations
-  * Results compatible with Matlab Wavelet Toolbox |tm|
+  * Results compatible with Matlab Wavelet Toolbox (TM)
 
 Requirements
 ------------
@@ -41,11 +41,10 @@ Download
 --------
 
 The most recent *development* version can be found on GitHub at
-https://github.com/rgommers/pywt.
+https://github.com/PyWavelets/pywt.
 
 Latest release, including source and binary package for Windows, is available
-for download from the `Python Package Index`_ or on 
-`https://github.com/rgommers/pywt/releases`__
+for download from the `Python Package Index`_ or on the `Releases Page`_.
 
 Install
 -------
@@ -72,8 +71,7 @@ Documentation
 -------------
 
 Documentation with detailed examples and links to more resources is available
-online at http://www.pybytes.com/pywavelets/ and
-http://pywavelets.readthedocs.org.
+online at http://pywavelets.readthedocs.org.
 
 For more usage examples see the `demo`_ directory in the source package.
 
@@ -83,12 +81,12 @@ State of development & Contributing
 PyWavelets started in 2006 as an academic project for a master thesis
 on `Analysis and Classification of Medical Signals using Wavelet Transforms`
 and was maintained until 2012 by its `original developer`_.  In 2013
-maintenance was taken over in a new repo (`https://github.com/rgommers/pywt`__)
+maintenance was taken over in a `new repo <https://github.com/PyWavelets/pywt>`_)
 by a larger development team - a move supported by the original developer.
 The repo move doesn't mean that this is a fork - the package continues to be
 developed under the name "PyWavelets", and released on PyPi and Github (see
-`https://github.com/nigma/pywt/issues/13`__ for the discussion where that was
-decided).
+`this issue <https://github.com/nigma/pywt/issues/13>`_ for the discussion
+where that was decided).
 
 All contributions including bug reports, bug fixes, new feature implementations
 and documentation improvements are welcome.  Moreover, developers with an
@@ -126,11 +124,12 @@ Contents
 
 .. _built-in wavelet filters: http://wavelets.pybytes.com/
 .. _Cython: http://cython.org/
-.. _demo: https://github.com/rgommers/pywt/tree/master/demo
-.. _GitHub: https://github.com/rgommers/pywt
-.. _GitHub Issues: https://github.com/rgommers/pywt/issues
+.. _demo: https://github.com/PyWavelets/pywt/tree/master/demo
+.. _GitHub: https://github.com/PyWavelets/pywt
+.. _GitHub Issues: https://github.com/PyWavelets/pywt/issues
 .. _Numpy: http://www.numpy.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
+.. _Releases Page: https://github.com/PyWavelets/pywt/releases

doc/source/release.0.3.0.rst

@@ -0,0 +1 @@
+.. include:: ../release/0.3.0-notes.rst

doc/source/releasenotes.rst

@@ -0,0 +1,7 @@
+Release Notes
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   release.0.3.0

doc/source/resources.rst

@@ -35,7 +35,7 @@ Articles
  - `Wavelet Regression in Python <http://jseabold.net/blog/2012/02/wavelet-regression-in-python.html>`_
 
 
-.. _GitHub repository: https://github.com/rgommers/pywt
-.. _GitHub Issues: https://github.com/rgommers/pywt/issues
+.. _GitHub repository: https://github.com/PyWavelets/pywt
+.. _GitHub Issues: https://github.com/PyWavelets/pywt/issues
 .. _PyWavelets discussions group: http://groups.google.com/group/pywavelets
 .. _wavelets.pybytes.com: http://wavelets.pybytes.com/