This package provides functions for analyzing and plotting the
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).
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
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
To test the package, edit it, and compile the documentation, you will need
To install the development version, first clone the package
git clone email@example.com:JohnMarohn/FreqDemod.git cd FreqDemod
To confirm that everything is working, in the FreqDemod directory run
or nosetest -s -v
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