Skip to content

Commit

Permalink
Add reference to third-party planfftw package (pyFFTW#262)
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefan Peterson authored and grlee77 committed Jul 12, 2019
1 parent ab74688 commit 9557c98
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,12 @@ Understanding :mod:`numpy.fft`, these functions are largely
self-explanatory. We point the reader to the :mod:`API docs <pyfftw.builders>`
for more information.

If you like the :mod:`pyfftw.builders` functions, but do not need or wish to
interact with :class:`pyfftw.FFTW`-instances directly, the third party
:mod:`planfftw` package provides helper functions that return planned functions
similar to those in :mod:`numpy.fft`, as well as FFTW-powered versions of some
functions from :mod:`scipy.signal`.

.. _configuration:

Configuring FFTW planning effort and number of threads
Expand Down

0 comments on commit 9557c98

Please sign in to comment.