README

   1 FFT_tools: unitary FFTs and power spectra for real data.
   2
   3 This package wraps NumPy's fft module to produce unitary transforms
   4 and power spectra of real numbers in one dimension.  See the code for
   5 the technical details.
   6
   7
   8 Installation
   9 ============
  10
  11 Packages
  12 --------
  13
  14 Gentoo
  15 ~~~~~~
  16
  17 I've packaged FFT-tools for Gentoo.  You need layman_ and my `wtk
  18 overlay`_.  Install with::
  19
  20     # emerge -av app-portage/layman
  21     # layman --add wtk
  22     # emerge -av dev-python/FFT-tools
  23
  24
  25 Dependencies
  26 ------------
  27
  28 If you're installing by hand or packaging pycomedi for another
  29 distribution, you'll need the following dependencies:
  30
  31 =======  ============  ================
  32 Package  Debian_       Gentoo_
  33 =======  ============  ================
  34 NumPy_   python-numpy  dev-python/numpy
  35 =======  ============  ================
  36
  37
  38 Installing by hand
  39 ------------------
  40
  41 FFT-tools is available as a Git_ repository::
  42
  43     $ git clone http://www.physics.drexel.edu/~wking/code/git/FFT-tools.git
  44
  45 See the homepage_ for details.  To install the checkout, run the
  46 standard::
  47
  48     $ python setup.py install
  49
  50
  51 Usage
  52 =====
  53
  54 See the tests in `FFT_tools.py` for simple examples.
  55
  56
  57 Testing
  58 =======
  59
  60 Run internal unit tests with::
  61
  62     $ python -m FFT_tools
  63
  64 If you want to plot the test results (useful for debugging), you'll
  65 need to install matplotlib_.  Then run::
  66
  67     $ python -m FFT_tools --plot
  68
  69
  70 Licence
  71 =======
  72
  73 This project is distributed under the `GNU General Public License
  74 Version 3`_ or greater.
  75
  76
  77 Author
  78 ======
  79
  80 W. Trevor King
  81 wking@drexel.edu
  82 Copyright 2007-2011
  83
  84
  85 .. _layman: http://layman.sourceforge.net/
  86 .. _wtk overlay:
  87      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay
  88 .. _Debian: http://www.debian.org/
  89 .. _Gentoo: http://www.gentoo.org/
  90 .. _NumPy: http://numpy.scipy.org/
  91 .. _Git: http://git-scm.com/
  92 .. _homepage:
  93      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/FFT-tools/
  94 .. _matplotlib: http://matplotlib.sourceforge.net/
  95 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt