Metadata-Version: 1.1
Name: FFT-tools
Version: 0.5
Summary: Wrap NumpPy's FFT routines to reduce clutter.
Home-page: http://blog.tremily.us/posts/FFT-tools/
Author: W. Trevor King
Author-email: wking@tremily.us
License: GNU General Public License (GPL)
Download-URL: http://git.tremily.us/?p=FFT-tools.git;a=snapshot;h=0.5;sf=tgz
Description: 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
        ============
        
        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 git://tremily.us/FFT-tools.git
        
        See the homepage_ for details.  To install the checkout, run the
        standard::
        
            $ python setup.py install
        
        Building the HTML docs
        ----------------------
        
        The module objects are documented in the `NumPy/SciPy documentation
        style`_.  You should be able to build this documentation with Sphinx_
        and the numpydoc_ extension.  I haven't been able to get numpydoc
        working cleanly, but you can still build a decent version of the docs
        from the ``doc`` subdirectory with::
        
            $ PYTHONPATH=.. make SPHINXBUILD=sphinx-build-2.7 dirhtml
        
        Usage
        =====
        
        See the tests in ``FFT_tools.py`` for simple examples.
        
        Testing
        =======
        
        Run internal unit tests using Nose_::
        
            $ nosetests --with-doctest --doctest-tests -vv FFT_tools.py
        
        If you want to plot the test results (useful for debugging), you'll
        need to install matplotlib_ and set ``TEST_PLOTS`` to ``True`` in
        ``FFT_tools.py`` before invoking Nose.
        
        Licence
        =======
        
        This project is distributed under the `GNU General Public License
        Version 3`_ or greater.
        
        
        .. _layman: http://layman.sourceforge.net/
        .. _wtk overlay: http://blog.tremily.us/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://blog.tremily.us/posts/FFT-tools/
        .. _matplotlib: http://matplotlib.sourceforge.net/
        .. _NumPy/SciPy documentation style:
           https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
        .. _Sphinx: http://sphinx-doc.org/
        .. _numpydoc: https://github.com/numpy/numpy/tree/master/doc/sphinxext
        .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
        .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt
        
Platform: all
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
