# Understand the signals behind wearable health

## What is physioKIT?

Raw sensor samples rarely answer a question on their own. With ECG, for example, you can clean a waveform, locate R-peaks, derive RR intervals, and calculate heart rate variability. physioKIT exposes those steps as separate Python functions, so you can inspect the intermediate signals and use the measurements you need. The guides below cover pulse, respiration, and motion workflows too.

New to the library? The [quickstart](https://ambiqai.github.io/physiokit/tutorial/quickstart/) runs that ECG workflow with synthetic data, so no external dataset is needed. Then replace the generated samples with your own recording and set the correct sampling rate. The signal guides show code examples and saved visualizations; the [Python API](https://ambiqai.github.io/physiokit/api/) documents parameters and return values.

## Explore by signal

ECGSynthesize and clean waveforms, find R-peaks, and derive RR intervals.
PPGWork with pulse peaks, heart and respiratory rate estimates, and SpO₂ examples.
RespirationExplore respiratory waveforms, peaks, and rate calculations.
MotionCalculate ENMO, tilt angles, and activity counts from accelerometer data.
Heart rate variabilityCalculate time- and frequency-domain measures from beat intervals.
Signal utilitiesFilter, resample, smooth, and inspect sampled signals.

## Installation

In a Python 3.12 project, add physioKIT:

```bash
uv init --python 3.12 my-physio-project
cd my-physio-project
uv add physiokit
```

The [quickstart](https://ambiqai.github.io/physiokit/tutorial/quickstart/) runs a synthetic ECG example. For an existing recording, follow [Use your own data](https://ambiqai.github.io/physiokit/tutorial/your-data/). The interactive plots show saved example waveforms, not live measurements.

physioKIT is distributed under the [BSD-3-Clause license](https://github.com/AmbiqAI/physiokit/blob/main/LICENSE). Refer to the [source repository](https://github.com/AmbiqAI/physiokit) for development and issue tracking.

## Explore the documentation

- [Getting started](https://ambiqai.github.io/physiokit/tutorial/quickstart/)Install physioKIT and run a synthetic ECG example.Start here →

- [Signal guides](https://ambiqai.github.io/physiokit/reference/)Explore ECG, PPG, respiration, motion and HRV workflows.Explore guides →

- [Use your own data](https://ambiqai.github.io/physiokit/tutorial/your-data/)Bring a recording into a signal-processing workflow.Use your recording →

- [Python API](https://ambiqai.github.io/physiokit/api/)Look up functions, parameters and return values.Browse the API →
