π Background
An open source tool built for monitoring heart rate. The goal here is to have a low cost and widely accessible way to measure someones heart rate. It uses a touch-based system for generating heart rate values. In contrast to it's counterpart(touchless-based systems) it is a far more accurate and less sensitive to enviornmental conditions.
Directory Structure
.
βββ docs # Sphinx documentation folder
βββ examples # The example code
βββ src # The source code for the library
βββ tests # Unit tests and system tests
βββ ui # The UI
Branches
- devel -> PR this branch for everything
- master -> DO NOT TOUCH, this is what's running in production
How to run locally
After cloning this repository and changing directories to it.
1. Install the dependencies
$ make install
2. Install library
$ make
See example of usage in examples folder.
Testing
Local Testing
$ sudo sh install.sh && sudo make test
Testing with Docker
$ sudo sh run_docker_test.sh
Documentation
We use sphinx to build our documentation based on rST files and comments in the code, below is a quick guide to getting started.
cd docs
make html
This will output the documentation to docs/_build/html
.
Now to view built documentation run open _build/html/index.html
.
Contributing
Contributions are welcome! Please read our Code of Conduct and how to contribute before contributing to help this project stay welcoming.
To understand how the library works see pulse.py
License
MIT License
Copyright (c) 2020 Akil M Hylton