Metadata-Version: 1.1
Name: olimex-ekg-emg
Version: 0.1.7
Summary: A package for gathering data from the Olimex EKG/EMG Shield.
Home-page: https://github.com/logston/olimex-ekg-emg
Author: Paul Logston
Author-email: code@logston.me
License: Copyright (c) 2014, Paul Logston
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of olimex-ekg-emg nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


THIS SOFTWARE DOES NOT PROVIDE MEDICAL ADVICE

The information provided by this software is not medical advice. By using this software,
You acknowledge that this software does not and should not be construed to provide
health-related or medical advice, or clinical decision support, or to provide,
support or replace any diagnosis, recommendation, advice, treatment or decision by an
appropriately trained and licensed physician, or to create a patient-physician relationship.
You hereby agree that this software will not be relied on or used, in whole or in part,
for any of the preceding purposes by or on Your behalf with respect to any individual(s).
If You believe You suffer from any medical condition, whether or not this software's
results support this belief, You should immediately seek professional medical advice
or consult with a qualified medical professional.
Description: olimex-ekg-emg
        ==============
        
        |docs| |downloads| |latest| |versions| |implementations| |dev_status| |license|
        
        A Python package for gathering and viewing data from the `Olimex EKG/EMG Shield`_.
        
        
        NOTICE
        ------
        
        THIS SOFTWARE DOES NOT PROVIDE MEDICAL ADVICE
        
        The information provided by this software is not medical advice. By using this software,
        You acknowledge that this software does not and should not be construed to provide
        health-related or medical advice, or clinical decision support, or to provide,
        support or replace any diagnosis, recommendation, advice, treatment or decision by an
        appropriately trained and licensed physician, or to create a patient-physician relationship.
        You hereby agree that this software will not be relied on or used, in whole or in part,
        for any of the preceding purposes by or on Your behalf with respect to any individual(s).
        If You believe You suffer from any medical condition, whether or not this software's
        results support this belief, You should immediately seek professional medical advice
        or consult with a qualified medical professional.
        
        
        Installation
        ------------
        
        ::
        
            pip install olimex-ekg-emg
        
        
        Usage
        -----
        
        ::
        
            $ exg -p /path/to/port
        
        Replace ``/path/to/port`` with the path to the port to which your Arduino is connected.
        
        A `matplotlib figure`_ should appear and a real-time wave form should begin go to be drawn.
        Calibration of the waveform within the figure make take up to 10 seconds.
        
        Or, to play around with the included mock data ...
        
        ::
        
            $ exg -f <mock data filename>
        
        Replace ``<mock data filename>`` with one of the mock data file names. To get a
        list of the mock data file names, use the ``--list-mock-data`` command line
        option. For example:
        
        :: 
        
            $ exg --list-mock-data
            afib.bin
            afltr.bin
            asys.bin
            j-brady.bin
            nsr.bin
        
        Example Output
        --------------
        
        .. image:: http://logston.github.io/talks/2015-08-15-Hearduino/build/images/nsr_snippet.gif
        
        
        Further Documentation
        ---------------------
        
        Further documentation can be found on `Read the Docs`_.
        
        .. _Read the Docs: http://olimex-ekg-emg.readthedocs.org/en/latest/
        
        .. |docs| image:: https://readthedocs.org/projects/olimex-ekg-emg/badge/
            :alt: Documentation Status
            :scale: 100%
            :target: http://olimex-ekg-emg.readthedocs.org/en/latest/
        
        .. |downloads| image:: https://pypip.in/download/olimex-ekg-emg/badge.svg?period=month
            :target: https://pypi.python.org/pypi/olimex-ekg-emg
            :alt: Downloads
        
        .. |latest| image:: https://pypip.in/version/olimex-ekg-emg/badge.svg?text=version
            :target: https://pypi.python.org/pypi/olimex-ekg-emg/
            :alt: Latest Version
        
        .. |versions| image:: https://pypip.in/py_versions/olimex-ekg-emg/badge.svg
            :target: https://pypi.python.org/pypi/olimex-ekg-emg/
            :alt: Supported Python versions
        
        .. |implementations| image:: https://pypip.in/implementation/olimex-ekg-emg/badge.svg
            :target: https://pypi.python.org/pypi/olimex-ekg-emg/
            :alt: Supported Python implementations
        
        .. |dev_status| image:: https://pypip.in/status/olimex-ekg-emg/badge.svg
            :target: https://pypi.python.org/pypi/olimex-ekg-emg/
            :alt: Development Status
        
        .. |license| image:: https://pypip.in/license/olimex-ekg-emg/badge.svg
            :target: https://pypi.python.org/pypi/olimex-ekg-emg/
            :alt: License
        
        .. _matplotlib figure: http://matplotlib.org/api/figure_api.html#figure
        
        .. _Olimex EKG/EMG Shield: https://www.olimex.com/Products/Duino/Shields/SHIELD-EKG-EMG/
        
Keywords: Olimex,EKG,EMG,Arduino
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
