FreqDemod 0.2.1

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

• Documentation: http://FreqDemod.rtfd.org

• Source: https://github.com/JohnMarohn/FreqDemod

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