This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

This package provides functions for analyzing and plotting the

Project Description

This package provides functions for analyzing and plotting the time-dependent frequency and amplitude of a sinusoidally oscillating signal. Additional functions are provided for analyzing fluctuations in oscillator amplitude, phase, or frequency. The provided functions should work equally well for any oscillating signal, although the included data-fitting and -plotting functions have been written with an oscillating atomic force microscope cantilever in mind. The main frequency-demodulation algorithm’s only assumption is that the oscillating signal contains a single frequency component (the carrier, in FM-radio terminology).

Install

This package requires the following packages. If you use the Enthought Canopy Distribution, then you should install these packages first using Enthought’s package manager. If you do not install them first, then pip will install them for you

  • numpy 1.8.1
  • scipy 0.14.1
  • matplotlib 1.4.2
  • h5py 2.4.0

To install the package

pip install FreqDemod

To test that the installation worked, run

python -c "from freqdemod.demodulate import Signal"

Documentation and source code is available at

Install the development version

To test the package, edit it, and compile the documentation, you will need

  • fabric 1.10.1
  • Sphinx 1.2.3
  • nose 1.3.4
  • ipython 2.3.1

To install the development version, first clone the package

git clone git@github.com:JohnMarohn/FreqDemod.git
cd FreqDemod

To confirm that everything is working, in the FreqDemod directory run

nosetests

or

or nosetest -s -v

or

python setup.py test

If you make modifications to the code, and want to try test drive your modifications, then run

python setup.py develop

Your modified code should now load when you import FreqDemod in your code. To recreate the documentation, switch to the docs subdirectory, and run

fab html
fab open

If successful, you should see the documentation appear in your webbrowser. The documentation is created in the directory FreqDemod/docs/_build/html.

There is an example ipython notebook in the FreqDemod/freqdemod/docs directory. Running the following command will convert the notebook to html and copy it to the documentation directory

fab html_full
Release History

Release History

This version
History Node

0.2.1

History Node

0.2

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
FreqDemod-0.2.1.tar.gz (4.7 MB) Copy SHA256 Checksum SHA256 Source Jan 24, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting