Metadata-Version: 2.4
Name: ecg-records-engine
Version: 0.3.0
Summary: Compiled numerical engine of ecg-records: QRS detection, delineation and measurement of 12-lead ECGs (research and engineering software; not a medical device)
Author: humansys-lab
Maintainer: humansys-lab
License-Expression: PolyForm-Noncommercial-1.0.0 OR LicenseRef-Commercial
Project-URL: Homepage, https://humansys-lab.github.io/ecg-records/
Project-URL: Documentation, https://humansys-lab.github.io/ecg-records/
Project-URL: Changelog, https://humansys-lab.github.io/ecg-records/changelog/
Keywords: ecg,electrocardiography,signal-processing,delineation,qt-interval
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Cython
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: <3.15,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE-NONCOMMERCIAL.md
License-File: LICENSE-COMMERCIAL.md
Requires-Dist: ecg-records<0.4,>=0.3.0
Requires-Dist: numpy<3,>=1.26
Requires-Dist: scipy<2,>=1.11
Dynamic: license-file

# ecg-records-engine

The compiled numerical engine of [`ecg-records`](https://pypi.org/project/ecg-records/):
QRS detection, P/QRS/T delineation and interval, amplitude, axis and ST
measurement of 12-lead (and reduced-lead) ECGs. It installs into the
`ecgfeat._engine` namespace of `ecg-records`; you never import it directly.

Research and engineering software; **not a medical device**.

## Install

```bash
pip install "ecg-records[engine]"
```

Binary wheels are provided for CPython 3.10–3.14 on Linux (x86_64, aarch64),
macOS (x86_64, arm64) and Windows (x86_64). `ecg-records` and
`ecg-records-engine` work together within the same minor version (for example
any 0.3.x with any 0.3.x); `pip install "ecg-records[engine]"` takes care of that.

Reading, querying and plotting ECG Records needs only `ecg-records`; measuring
a signal (`ecg_record`, `ecg_measure`, `ecg-record measure`) needs this engine.

## Licence

`ecg-records-engine` is free for **noncommercial use** under the
[PolyForm Noncommercial License 1.0.0](https://polyformproject.org/licenses/noncommercial/1.0.0):
personal use, and use by educational institutions, charities, public research
organizations and other noncommercial organizations.

**Commercial use** (by or for a company, in a product or service) requires a
commercial licence and a licence key. The key is verified offline; nothing is
sent anywhere. Without a key the engine prints one notice per process and
works normally. See the documentation page *Licensing* for how to obtain and
install a key, or call `ecgfeat.license_info()`.

`ecg-records` itself (the ECG Record format, readers, queries and plots)
remains Apache-2.0.
