{ "info": { "author": null, "author_email": null, "bugtrack_url": null, "classifiers": [], "description": "Introduction to the FreqDemod Package\n=====================================\n\nThis 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).\n\nInstall\n-------\n\nThis 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\n\n* numpy 1.8.1\n\n* scipy 0.14.1\n\n* matplotlib 1.4.2\n\n* h5py 2.4.0 \n\nTo install the package ::\n\n pip install FreqDemod\n\nTo test that the installation worked, run ::\n\n python -c \"from freqdemod.demodulate import Signal\"\n\nDocumentation and source code is available at\n \n* Documentation: http://FreqDemod.rtfd.org\n\n* Source: https://github.com/JohnMarohn/FreqDemod\n\nInstall the development version\n-------------------------------\n\nTo test the package, edit it, and compile the documentation, you will need \n\n* fabric 1.10.1\n\n* Sphinx 1.2.3\n\n* nose 1.3.4\n\n* ipython 2.3.1\n\nTo install the development version, first clone the package :: \n\n git clone git@github.com:JohnMarohn/FreqDemod.git\n cd FreqDemod\n \nTo confirm that everything is working, in the FreqDemod directory run ::\n\n nosetests\n \nor ::\n\n or nosetest -s -v\n \nor ::\n\n python setup.py test\n \nIf you make modifications to the code, and want to try test drive your modifications, then run ::\n\n python setup.py develop\n \nYour modified code should now load when you ``import FreqDemod`` in your code. To recreate the documentation, switch to the docs subdirectory, and run ::\n\n fab html\n fab open\n \n\nIf successful, you should see the documentation appear in your webbrowser. The documentation is created in the directory ``FreqDemod/docs/_build/html``.\n\nThere 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 ::\n\n fab html_full", "description_content_type": null, "docs_url": null, "download_url": null, "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": null, "keywords": null, "license": null, "maintainer": null, "maintainer_email": null, "name": "FreqDemod", "package_url": "https://pypi.org/project/FreqDemod/", "platform": null, "project_url": "https://pypi.org/project/FreqDemod/", "project_urls": null, "release_url": "https://pypi.org/project/FreqDemod/0.2.1/", "requires_dist": null, "requires_python": null, "summary": "This package provides functions for analyzing and plotting the", "version": "0.2.1" }, "last_serial": 1394161, "releases": { "0.2": [ { "comment_text": "", "digests": { "md5": "92e0d82eb019dbbaf58b6bf5e13551e6", "sha256": "959e83a023197e90f105826174093079631abb4518f64448cfcbb94c96b8d774" }, "downloads": -1, "filename": "FreqDemod-0.2.tar.gz", "has_sig": false, "md5_digest": "92e0d82eb019dbbaf58b6bf5e13551e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21293, "upload_time": "2015-01-24T00:23:31", "url": "https://files.pythonhosted.org/packages/e4/50/27bd4d48f3d2a21a8f385e3e2329a5a277bca741517ccf07cd8ff074545b/FreqDemod-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "fd15deb520a2b9a77076a1760bd17c95", "sha256": "e34ba017ce1eeb26f10e5ec7cbe081ae7f13726face402f62586db227e24681d" }, "downloads": -1, "filename": "FreqDemod-0.2.1.tar.gz", "has_sig": false, "md5_digest": "fd15deb520a2b9a77076a1760bd17c95", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4702167, "upload_time": "2015-01-24T00:33:36", "url": "https://files.pythonhosted.org/packages/fd/8a/d87fc89f28998d71fb731e447eb0ad69c0780cf4f73cfddd99eb2b7be26e/FreqDemod-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fd15deb520a2b9a77076a1760bd17c95", "sha256": "e34ba017ce1eeb26f10e5ec7cbe081ae7f13726face402f62586db227e24681d" }, "downloads": -1, "filename": "FreqDemod-0.2.1.tar.gz", "has_sig": false, "md5_digest": "fd15deb520a2b9a77076a1760bd17c95", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4702167, "upload_time": "2015-01-24T00:33:36", "url": "https://files.pythonhosted.org/packages/fd/8a/d87fc89f28998d71fb731e447eb0ad69c0780cf4f73cfddd99eb2b7be26e/FreqDemod-0.2.1.tar.gz" } ] }