-This package wraps Numpy's fft module to produce unitary transforms
+FFT_tools: unitary FFTs and power spectra for real data.
+
+This package wraps NumPy's fft module to produce unitary transforms
and power spectra of real numbers in one dimension. See the code for
the technical details.
-== Installation ==
+Installation
+============
+
+Packages
+--------
+
+Gentoo
+~~~~~~
+
+I've packaged FFT-tools for Gentoo. You need layman_ and my `wtk
+overlay`_. Install with::
+
+ # emerge -av app-portage/layman
+ # layman --add wtk
+ # emerge -av dev-python/FFT-tools
+
+
+Dependencies
+------------
+
+If you're installing by hand or packaging pycomedi for another
+distribution, you'll need the following dependencies:
+
+======= ============ ================
+Package Debian_ Gentoo_
+======= ============ ================
+NumPy_ python-numpy dev-python/numpy
+======= ============ ================
+
+
+Installing by hand
+------------------
+
+FFT-tools is available as a Git_ repository::
+
+ $ git clone http://www.physics.drexel.edu/~wking/code/git/FFT-tools.git
+
+See the homepage_ for details. To install the checkout, run the
+standard::
-Non-Python dependencies (Debian packagename):
- easy_install (python-setuptools)
- Numpy source (python-numpy-dev)
+ $ python setup.py install
-FFT_tools uses `setuptools' for installation. Setuptools is basically
-an extension of the standard Python distutils package which supports
-automatic package dependency tracking. The installation procedure
-should be (on Debian-esque systems)
- # apt-get intall python-setuptools python-numpy-dev
- # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ FFT_tools
-There is one speedbump you might run into:
- * an outdated version of easy_install (see ez_setup.py section)
+Usage
+=====
-** ez_setup.py
+See the tests in `FFT_tools.py` for simple examples.
-This package bundles
- http://peak.telecommunity.com/dist/ez_setup.py
-to bootstrap setuputils installation on your machine (if neccessary).
-If the bootstrapping doesn't work, you may need to install a current version
-of setuptools. On Debian-based systems `apt-get install python-setuptools'.
-Once you have *some* version of setuptools, upgrade with
- easy_install -U setuptools
+Testing
+=======
-For more information see
- http://peak.telecommunity.com/DevCenter/EasyInstall
- http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know
+Run internal unit tests with::
+ $ python -m FFT_tools
-== Usage ==
+If you want to plot the test results (useful for debugging), you'll
+need to install matplotlib_. Then run::
-See the tests in FFT_tools.py for simple examples.
+ $ python -m FFT_tools --plot
-== Licence ==
+Licence
+=======
-This project is distributed under the Python Software Foundation License.
-http://www.python.org/psf/license/
+This project is distributed under the `GNU General Public License
+Version 3`_ or greater.
-== Author ==
+Author
+======
W. Trevor King
wking@drexel.edu
-Copyright 2007, 2008
+Copyright 2007-2011
+
+
+.. _layman: http://layman.sourceforge.net/
+.. _wtk overlay:
+ http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay
+.. _Debian: http://www.debian.org/
+.. _Gentoo: http://www.gentoo.org/
+.. _NumPy: http://numpy.scipy.org/
+.. _Git: http://git-scm.com/
+.. _homepage:
+ http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/FFT-tools/
+.. _matplotlib: http://matplotlib.sourceforge.net/
+.. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt
projects / FFT-tools.git / blobdiff