Metadata-Version: 1.0
Name: pharminv
Version: 0.2.1
Summary: Python interface to harminv
Home-page: http://github.com/aaren/harminv
Author: Aaron O'Leary
Author-email: dev@aaren.me
License: GPLv3
Description: pharminv
        ========
        
        This is a python interface to
        `harminv <http://ab-initio.mit.edu/wiki/index.php/Harminv>`__, a library
        for performing harmonic inversion on a signal.
        
        Requirements:
        ~~~~~~~~~~~~~
        
        -  BLAS & LAPACK
        -  libharminv-dev
        -  cython, numpy
        
        Installation:
        ~~~~~~~~~~~~~
        
        Make sure that you have the requirements above, then
        
        ::
        
            pip install pharminv
        
        Usage:
        ~~~~~~
        
        ``harminv.invert`` contains the basic functionality of the harminv tool.
        This function should remain stable but the API elsewhere is subject to
        change.
        
        .. code:: python
        
            import numpy as np
            import harminv
        
            time = np.linspace(0, 1, 1000)
        
            signal = np.cos(2 * np.pi * time * 10) + np.cos(2 * np.pi * time * 20)
        
            inversion = harminv.invert(signal, fmin=1, fmax=100)
        
            inversion.freq        # mode frequencies
            inversion.decay       # decay rates
            inversion.Q           # Q factor
            inversion.amplitudes  # absolute amplitudes
            inversion.phase       # phase shift
        
        License:
        ~~~~~~~~
        
        `harminv <http://ab-initio.mit.edu/wiki/index.php/Harminv>`__ was
        written by Steven G. Johnson and is licensed under the GNU GPLv2+,
        copyright 2005 by the Massachusetts Institute of Technology.
        
        This python interface to harminv is licensed under the standard BSD
        3-clause license.
        
Platform: UNKNOWN
