Metadata-Version: 2.4
Name: pyPCG_toolbox
Version: 0.1b5
Summary: A PCG processing toolbox
Home-page: https://github.com/mulkr/pyPCG-toolbox/
Author: Kristóf Müller, Janka Hatvani, Miklós Koller, Márton Áron Goda
Author-email: muller.kristof@itk.ppke.hu, goda.marton.aron@itk.ppke.hu
Maintainer-email: Kristóf Müller <muller.kristof@itk.ppke.hu>
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://github.com/mulkr/pyPCG-toolbox/
Project-URL: Documentation, https://pypcg-toolbox.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/mulkr/pyPCG-toolbox.git
Project-URL: Issues, https://github.com/mulkr/pyPCG-toolbox/issues
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scikit-learn>=1.1.3
Requires-Dist: scipy>=1.9.3
Requires-Dist: PyWavelets>=1.5.0
Requires-Dist: pandas>=2.0.0
Requires-Dist: matplotlib>=3.6.2
Requires-Dist: numpy>=1.25.2
Requires-Dist: emd>=0.6.2
Requires-Dist: nolds>=0.5.2
Requires-Dist: tqdm>=4.64.1
Requires-Dist: pyQt5>=5.15.7
Dynamic: author-email
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# pyPCG toolbox
Common processing algorithms and segmemtation for PCG signals

## Installation
**IMPORTANT!**

pyPCG is dependent on a package `hsmmlearn` which is currently not available on PyPi.

To solve this issue, install `hsmmlearn` separately from https://github.com/jvkersch/hsmmlearn
```
pip install git+https://github.com/jvkersch/hsmmlearn@master
```
*Note:* Python 3.10 is supported but 3.11 is recommended

### From PyPi
Install `pyPCG` using pip

```
pip install pyPCG_toolbox
```

### From source
Clone the git repository
```
git clone https://github.com/mulkr/pyPCG-toolbox.git
```
Change directory to the cloned repository
```
cd pyPCG-tooblox
```
Install with pip
```
pip install .
```

## Building the documentation
Install required packages
```
pip install -r docs/requirements.txt
```
Call Sphinx build command
```
sphinx-build -M html docs/source docs/build
```
On Windows you can also run the `make.bat` file
```
.\docs\make.bat html
```

The documentation should be available in the `docs/build` directory as html files<br>
This includes the example codes as tutorials

## Correspondence
Kristóf Müller (muller.kristof@itk.ppke.hu)<br>
Márton Áron Goda (goda.marton.aron@itk.ppke.hu)
