Metadata-Version: 1.1
Name: siganalysis
Version: 0.2.4
Summary: Perform signal analysis
Home-page: http://github.com/questrail/siganalysis
Author: Matthew Rankin
Author-email: matthew@questrail.com
License: MIT
Description: siganalysis
        ===========
        
        |PyPi Version| |Build Status| |Coverage Status| |License Badge|
        
        Python (2.7+/3.4+) routines for analyzing signals. Some of the functions
        include:
        
        -  Calculating Short-Term Fourier Transform
        -  Smoothing a signal
        -  Plotting an STFT's spectrogram
        -  Calculating the peak hold of an STFT in the freq domain
        -  Plotting the peak hold of an STFT
        
        The above functions are handy when analyzing signals recorded in the
        time domain, such as using a TEAC LX-10 data recorder, and seeing the
        frequency spectrum. This is useful for Electromagnetic Compatibility
        (EMC) analyses.
        
        Installation
        ------------
        
        You can install
        `siganalysis <https://github.com/questrail/siganalysis>`__ either via
        the Python Package Index (PyPI) or from source.
        
        To install using pip:
        
        .. code:: bash
        
            $ pip install siganalysis
        
        **Source:** https://github.com/questrail/siganalysis
        
        Requirements
        ------------
        
        `siganalysis <https://github.com/questrail/siganalysis>`__ requires the
        following Python packages:
        
        -  `numpy <http://www.numpy.org>`__
        -  `scipy <http://www.scipy.org>`__
        -  `matplotlib <http://matplotlib.org>`__
        
        Contributing
        ------------
        
        `siganalysis <https://github.com/questrail/siganalysis>`__ is developed
        using `Scott Chacon <http://scottchacon.com/about.html>`__'s `GitHub
        Flow <http://scottchacon.com/2011/08/31/github-flow.html>`__. To
        contribute, fork
        `siganalysis <https://github.com/questrail/siganalysis>`__, create a
        feature branch, and then submit a pull request. `GitHub
        Flow <http://scottchacon.com/2011/08/31/github-flow.html>`__ is
        summarized as:
        
        -  Anything in the ``master`` branch is deployable
        -  To work on something new, create a descriptively named branch off of
           ``master`` (e.g., ``new-oauth2-scopes``)
        -  Commit to that branch locally and regularly push your work to the
           same named branch on the server
        -  When you need feedback or help, or you think the branch is ready for
           merging, open a `pull
           request <https://help.github.com/articles/using-pull-requests>`__.
        -  After someone else has reviewed and signed off on the feature, you
           can merge it into master.
        -  Once it is merged and pushed to ``master``, you can and *should*
           deploy immediately.
        
        Running the Tests
        ~~~~~~~~~~~~~~~~~
        
        `siganalysis <https://github.com/questrail/siganalysis>`__ has been
        tested against Python 2.7 and Python 3.4. While
        `siganalysis <https://github.com/questrail/siganalysis>`__ may work with
        other versions of Python, it hasn't been tested with anything else at
        this time. Assuming you have
        `virtualenv <https://virtualenv.pypa.io/en/latest/>`__ and
        `virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/en/latest/>`__
        installed, you can run the following commands to clone the GitHub
        repository, create a virtualenv, and run the unit tests:
        
        .. code:: bash
        
            $ git clone https://github.com/questrail/siganalysis.git
            $ cd siganalysis
            $ mkvirtualenv siganalysis
            $ pip install -r requirements.txt
            $ nosetests
        
        License
        -------
        
        `siganalysis <https://github.com/questrail/siganalysis>`__ is released
        under the MIT license. Please see the
        `LICENSE.txt <https://github.com/questrail/siganalysis/blob/develop/LICENSE.txt>`__
        file for more information.
        
        .. |PyPi Version| image:: http://img.shields.io/pypi/v/siganalysis.svg
           :target: https://pypi.python.org/pypi/siganalysis/
        .. |Build Status| image:: http://img.shields.io/travis/questrail/siganalysis/master.svg
           :target: https://travis-ci.org/questrail/siganalysis
        .. |Coverage Status| image:: http://img.shields.io/coveralls/questrail/siganalysis/master.svg
           :target: https://coveralls.io/r/questrail/siganalysis
        .. |License Badge| image:: http://img.shields.io/pypi/l/siganalysis.svg
           :target: https://github.com/questrail/siganalysis/blob/develop/LICENSE.txt
        
Platform: UNKNOWN
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.4
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires: numpy (>=1.6.0)
Requires: scipy (>=0.11.0)
