cannam@127: FFTW is a free collection of fast C routines for computing the
cannam@127: Discrete Fourier Transform in one or more dimensions.  It includes
cannam@127: complex, real, symmetric, and parallel transforms, and can handle
cannam@127: arbitrary array sizes efficiently.  FFTW is typically faster than
cannam@127: other publically-available FFT implementations, and is even
cannam@127: competitive with vendor-tuned libraries.  (See our web page
cannam@127: http://fftw.org/ for extensive benchmarks.)  To achieve this
cannam@127: performance, FFTW uses novel code-generation and runtime
cannam@127: self-optimization techniques (along with many other tricks).
cannam@127: 
cannam@127: The doc/ directory contains the manual in texinfo, PDF, info, and HTML
cannam@127: formats.  Frequently asked questions and answers can be found in the
cannam@127: doc/FAQ/ directory in ASCII and HTML.
cannam@127: 
cannam@127: For a quick introduction to calling FFTW, see the "Tutorial" section
cannam@127: of the manual.
cannam@127: 
cannam@127: INSTALLATION
cannam@127: ------------
cannam@127: 
cannam@127: INSTALLATION FROM AN OFFICIAL RELEASE:
cannam@127: 
cannam@127: Please read chapter 10 "Installation and Customization" of the manual.
cannam@127: In short:
cannam@127: 
cannam@127:      ./configure
cannam@127:      make
cannam@127:      make install
cannam@127: 
cannam@127: INSTALLATION FROM THE GIT REPOSITORY:
cannam@127: 
cannam@127: First, install these programs:
cannam@127: 
cannam@127:   ocaml, ocamlbuild, autoconf, automake, indent, and libtool,
cannam@127: 
cannam@127: Then, execute
cannam@127: 
cannam@127:     sh bootstrap.sh
cannam@127:     make
cannam@127:     
cannam@127: The bootstrap.sh script runs configure directly, but if you need to
cannam@127: re-run configure, you must pass the --enable-maintainer-mode flag:
cannam@127: 
cannam@127:     ./configure --enable-maintainer-mode [OTHER CONFIGURE FLAGS]
cannam@127: 
cannam@127: CONTACTS
cannam@127: --------
cannam@127: 
cannam@127: FFTW was written by Matteo Frigo and Steven G. Johnson.  You can
cannam@127: contact them at fftw@fftw.org.  The latest version of FFTW,
cannam@127: benchmarks, links, and other information can be found at the FFTW home
cannam@127: page (http://www.fftw.org).  You can also sign up to the fftw-announce
cannam@127: Google group to receive (infrequent) updates and information about new
cannam@127: releases.