|
| 1 | +wfdb-python |
| 2 | +=========== |
| 3 | + |
| 4 | +.. figure:: https://raw.githubusercontent.com/MIT-LCP/wfdb-python/master/demo-img.png |
| 5 | + :alt: wfdb signals |
| 6 | + |
| 7 | + |
| 8 | +Introduction |
| 9 | +------------ |
| 10 | + |
| 11 | +The native Python waveform-database (WFDB) package. A library of tools for reading, writing, and processing WFDB signals and annotations. |
| 12 | + |
| 13 | +Core components of this package are based on the original WFDB specifications. This package does not contain the exact same functionality as the original WFDB package. It aims to implement as many of its core features as possible, with user-friendly APIs. Additional useful physiological signal-processing tools are added over time. |
| 14 | + |
| 15 | + |
| 16 | +Documentation and Usage |
| 17 | +----------------------- |
| 18 | + |
| 19 | +See the `documentation site`_ for the public APIs. |
| 20 | + |
| 21 | +See the `demo.ipynb`_ notebook file for more example use cases. |
| 22 | + |
| 23 | + |
| 24 | +Installation |
| 25 | +------------ |
| 26 | + |
| 27 | +The distribution is hosted on pypi at: https://pypi.python.org/pypi/wfdb/. To directly install the package from pypi without needing to explicitly download content, run from your terminal:: |
| 28 | + |
| 29 | + $ pip install wfdb |
| 30 | + |
| 31 | +The development version is hosted at: https://github.com/MIT-LCP/wfdb-python. This repository also contains demo scripts and example data. To install the development version, clone or download the repository, navigate to the base directory, and run:: |
| 32 | + |
| 33 | + $ pip install . |
| 34 | + |
| 35 | + |
| 36 | +Development |
| 37 | +----------- |
| 38 | + |
| 39 | +The development repository is hosted at: https://github.com/MIT-LCP/wfdb-python |
| 40 | + |
| 41 | +The package is to be expanded with physiological signal-processing tools, and general improvements. Development is made for Python 3.6+ only. |
| 42 | + |
| 43 | + |
| 44 | +Contributing |
| 45 | +------------ |
| 46 | + |
| 47 | +We welcome community contributions in the form of pull requests. When contributing code, please ensure: |
| 48 | + |
| 49 | +* PEP8_ style guidelines are followed. |
| 50 | +* Documentation is provided. New functions and classes should have numpy/scipy style docstrings_. |
| 51 | +* Unit tests are written for new features that are not covered by `existing tests`_. |
| 52 | + |
| 53 | + |
| 54 | +.. |Build Status| image:: https://travis-ci.org/MIT-LCP/wfdb-python.svg?branch=master |
| 55 | + :target: https://travis-ci.org/MIT-LCP/wfdb-python |
| 56 | + |
| 57 | +.. _documentation site: http://wfdb.readthedocs.io |
| 58 | + |
| 59 | +.. _PEP8: https://www.python.org/dev/peps/pep-0008/ |
| 60 | +.. _docstrings: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt |
| 61 | +.. _existing tests: https://github.com/MIT-LCP/wfdb-python/tree/master/tests |
| 62 | + |
| 63 | +.. _demo.ipynb: https://github.com/MIT-LCP/wfdb-python/blob/master/demo.ipynb |
0 commit comments