Skip to content

ThalesGroup/raie

Repository files navigation

Project generated with PyScaffold

raie

Real-time Analysis of Interbeat-intervals with Electrocardiography

Description

Code for Miriam Boutros' internship on "Real-time R-R interval extraction algorithm for monitoring stress with heart rate variability".

Installation

You can install the project via the following command:

git clone https://github.com/ThalesGroup/raie.git
pip install -r "requirements.txt"
pip install -e .

Note that the oldest version of Python that this project has been tested on is 3.10, while the newest version is 3.12.

Getting Started

A tutorial code in a notebook called Example.ipynb demonstrates formatting the data and running the ECG peak detection workflow.

Running Tests

This project uses pytest for testing. After installing the project and its dependencies, you can run the tests by simply executing pytest in the project root directory.

However, the recommended way to run tests is using tox, which will take care of setting up a virtual environment with the correct dependencies for testing. If you haven't installed tox, you can do so with pip install tox.

Once tox is installed, you can run the tests with the following command:

tox

This will run all tests and report the results.

Contributing

Contributions of all kinds are welcomed. For detailed information on how to contribute, please refer to our Contributor's Guide, including instructions on how to report issues, build and improve the documentation, submit changes, etc.

Note

This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.

About

Real-time Analysis of Interbeat-intervals with Electrocardiography

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors