Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Bumping the version to 0.8.2 and pushing a new README.

  • Loading branch information...
commit 3ace350a50ffdba515086b8a188571fc2b6e9424 1 parent aba33e4
@hgomersall authored
Showing with 69 additions and 13 deletions.
  1. +68 −12 README.txt
  2. +1 −1  setup.py
View
80 README.txt
@@ -1,16 +1,66 @@
pyFFTW is a pythonic wrapper around FFTW ( http://www.fftw.org/ ), the
-speedy FFT library. The ultimate aim is to present a unified interface for all
-the possible transforms that FFTW can perform.
+speedy FFT library. The ultimate aim is to present a unified interface for all the possible transforms that FFTW can perform.
Both the complex DFT and the real DFT are supported, as well as on arbitrary
axes of abitrary shaped and strided arrays, which makes it almost
feature equivalent to standard and real FFT functions of ``numpy.fft``
(indeed, it supports the ``clongdouble`` dtype which ``numpy.fft`` does not).
+Wisdom import and export now works fairly reliably.
+
Operating FFTW in multithreaded mode is supported.
A comprehensive unittest suite can be found with the source on the github
-repository.
+repository or with the source distribution on PyPI.
+
+The documentation can be found at http://hgomersall.github.com/pyFFTW/ , the source is on github: https://github.com/hgomersall/pyFFTW and the python package index page is here: http://pypi.python.org/pypi/pyFFTW .
+
+Dependencies
+============
+- Numpy
+- FFTW
+- Cython (though the source release on PyPI loses this dependency)
+
+(install these as much as possible with your preferred package manager).
+
+Installation
+============
+
+We recommend _not_ building from github, but using the release on
+the python package index with tools such as easy_install or pip:
+pip install pyfftw
+or
+each_install pyfftw
+
+Success has been reported on building on Linux, 32-bit Windows and Mac OSX.
+It doesn't mean it won't work anywhere else, just we don't have any information
+on it.
+
+64-bit windows is possible but a bit of fiddling is required (see below).
+
+Read on if you do want to build from source...
+
+Building
+========
+
+To build in place:
+python cython_setup.py build_ext --inplace
+
+That cythons the python extension and builds it into a shared library
+which is placed in pyfftw/. The directory can then be treated as a python
+package.
+
+After you've run cython_setup.py, you then have a normal C extension in
+the pyfftw directory. Further building can be done with the setup.py script
+(as is usually the case).
+
+For more ways of building and installing, see the distutils documentation:
+http://docs.python.org/distutils/builtdist.html
+
+Platform specific build info
+============================
+
+Windows:
To build for windows from source, download the fftw dlls for your system
and the header file from here (they're in a zip file):
@@ -18,17 +68,23 @@ http://www.fftw.org/install/windows.html and place them in the pyfftw
directory. The files are libfftw3-3.dll, libfftw3l-3.dll, libfftw3f-3.dll
and libfftw3.h.
-Under linux, to build from source, the FFTW library must be installed already.
-This should probably work for OSX, though I've not tried it.
+The setup scripts are designed for using with MinGW. They don't work as is
+with MSVC. If you want to build for 64-bit windows, you will _have_ to use
+MSVC as building python extensions for 64-bit Windows with MinGW is currently
+badly supported.
-Numpy is a dependency for both.
-
-The documentation can be found at http://hgomersall.github.com/pyFFTW/ , the source is on github: https://github.com/hgomersall/pyFFTW and the python package index page is here: http://pypi.python.org/pypi/pyFFTW .
+Based on unverified feedback from users, the following changes
+should allow it to work:
-If you want to build the code that is here, use the cython_setup script like:
+1. When you have a cythoned .c file, comment out #include "stdint.h" and
+#include "complex.h".
+2. remove 'm' from the libraries line inside the win32 if block in setup.py.
+3. If you're building for 64-bit windows, Change get_platform() == 'win32' to
+get_platform() == 'win-amd64':
-python ./cython_setup.py build_ext --inplace
+Mac OSX
+=======
-That will build the cython code into a .c file (and should compile that too).
+It has been suggested that FFTW should be installed from macports:
+http://www.macports.org/
-setup.py is designed for after the .c file has been created (as in the source distribution).
View
2  setup.py
@@ -44,7 +44,7 @@
libraries=libraries,
library_dirs=library_dirs)]
-version = '0.8.1'
+version = '0.8.2'
long_description = '''
pyFFTW is a pythonic wrapper around `FFTW <http://www.fftw.org/>`_, the
Please sign in to comment.
Something went wrong with that request. Please try again.