Setup package for setuptools distribution.
[FFT-tools.git] / README
1 This package wraps Numpy's fft module to produce unitary transforms
2 and power spectra of real numbers in one dimension.  See the code for
3 the technical details.
4
5
6 == Installation ==
7
8 Non-Python dependencies (Debian packagename):
9   easy_install  (python-setuptools)
10   Numpy source  (python-numpy-dev)
11
12 FFT_tools uses `setuptools' for installation.  Setuptools is basically
13 an extension of the standard Python distutils package which supports
14 automatic package dependency tracking.  The installation procedure
15 should be (on Debian-esque systems)
16   # apt-get intall python-setuptools python-numpy-dev
17   # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ FFT_tools
18
19 There is one speedbump you might run into:
20   * an outdated version of easy_install (see ez_setup.py section)
21
22 ** ez_setup.py
23
24 This package bundles
25   http://peak.telecommunity.com/dist/ez_setup.py
26 to bootstrap setuputils installation on your machine (if neccessary).
27
28 If the bootstrapping doesn't work, you may need to install a current version
29 of setuptools.  On Debian-based systems `apt-get install python-setuptools'.
30 Once you have *some* version of setuptools, upgrade with
31   easy_install -U setuptools
32
33 For more information see
34   http://peak.telecommunity.com/DevCenter/EasyInstall
35   http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know
36
37
38 == Usage ==
39
40 See the tests in FFT_tools.py for simple examples.
41
42
43 == Licence ==
44
45 This project is distributed under the Python Software Foundation License.
46 http://www.python.org/psf/license/
47
48
49 == Author ==
50
51 W. Trevor King
52 wking@drexel.edu
53 Copyright 2007, 2008