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