annotate src/fftw-3.3.8/README @ 82:d0c2a83c1364

Add FFTW 3.3.8 source, and a Linux build
author Chris Cannam
date Tue, 19 Nov 2019 14:52:55 +0000
parents
children
rev   line source
Chris@82 1 FFTW is a free collection of fast C routines for computing the
Chris@82 2 Discrete Fourier Transform in one or more dimensions. It includes
Chris@82 3 complex, real, symmetric, and parallel transforms, and can handle
Chris@82 4 arbitrary array sizes efficiently. FFTW is typically faster than
Chris@82 5 other publically-available FFT implementations, and is even
Chris@82 6 competitive with vendor-tuned libraries. (See our web page
Chris@82 7 http://fftw.org/ for extensive benchmarks.) To achieve this
Chris@82 8 performance, FFTW uses novel code-generation and runtime
Chris@82 9 self-optimization techniques (along with many other tricks).
Chris@82 10
Chris@82 11 The doc/ directory contains the manual in texinfo, PDF, info, and HTML
Chris@82 12 formats. Frequently asked questions and answers can be found in the
Chris@82 13 doc/FAQ/ directory in ASCII and HTML.
Chris@82 14
Chris@82 15 For a quick introduction to calling FFTW, see the "Tutorial" section
Chris@82 16 of the manual.
Chris@82 17
Chris@82 18 INSTALLATION
Chris@82 19 ------------
Chris@82 20
Chris@82 21 INSTALLATION FROM AN OFFICIAL RELEASE:
Chris@82 22
Chris@82 23 Please read chapter 10 "Installation and Customization" of the manual.
Chris@82 24 In short:
Chris@82 25
Chris@82 26 ./configure
Chris@82 27 make
Chris@82 28 make install
Chris@82 29
Chris@82 30 INSTALLATION FROM THE GIT REPOSITORY:
Chris@82 31
Chris@82 32 First, install these programs:
Chris@82 33
Chris@82 34 ocaml, ocamlbuild, autoconf, automake, indent, and libtool,
Chris@82 35
Chris@82 36 Then, execute
Chris@82 37
Chris@82 38 sh bootstrap.sh
Chris@82 39 make
Chris@82 40
Chris@82 41 The bootstrap.sh script runs configure directly, but if you need to
Chris@82 42 re-run configure, you must pass the --enable-maintainer-mode flag:
Chris@82 43
Chris@82 44 ./configure --enable-maintainer-mode [OTHER CONFIGURE FLAGS]
Chris@82 45
Chris@82 46 Alternatively, you can run
Chris@82 47
Chris@82 48 sh mkdist.sh
Chris@82 49
Chris@82 50 which will run the entire bootstrapping process and generate
Chris@82 51 .tar.gz files similar to those for official releases.
Chris@82 52
Chris@82 53 CONTACTS
Chris@82 54 --------
Chris@82 55
Chris@82 56 FFTW was written by Matteo Frigo and Steven G. Johnson. You can
Chris@82 57 contact them at fftw@fftw.org. The latest version of FFTW,
Chris@82 58 benchmarks, links, and other information can be found at the FFTW home
Chris@82 59 page (http://www.fftw.org). You can also sign up to the fftw-announce
Chris@82 60 Google group to receive (infrequent) updates and information about new
Chris@82 61 releases.