# Jitterbug

> Jitter-based congestion inference from RTT time series (PAM 2022)

Jitterbug infers Internet path congestion from Round-Trip Time (RTT) time series. The PyPI distribution is jitterbug-inference; the import package and the CLI are jitterbug. It computes minimum-RTT intervals, detects change points, and classifies each period with a latency jump plus either jitter dispersion or a Kolmogorov–Smirnov test. The method is the one in the PAM 2022 paper (https://doi.org/10.1007/978-3-030-98785-5_7).


## Guides

- [Home](https://estcarisimo.github.io/jitterbug/index.md): Project overview, installation, CLI, and Python API
- [Installation](https://estcarisimo.github.io/jitterbug/INSTALLATION/index.md): Install from PyPI or a clone, extras, and troubleshooting
- [Input formats](https://estcarisimo.github.io/jitterbug/INPUT_FORMATS/index.md): CSV, scamper JSON, DataFrame, and InfluxDB input
- [Choosing a detector](https://estcarisimo.github.io/jitterbug/ALGORITHM_SELECTION_GUIDE/index.md): Choosing between the ruptures and bcp detectors
- [Detectors and methods](https://estcarisimo.github.io/jitterbug/ALGORITHM_USAGE/index.md): Detector options, examples, and measured runtimes
- [Visualization](https://estcarisimo.github.io/jitterbug/VISUALIZATION_USAGE/index.md): jitterbug visualize and the JitterbugPlotter API
- [Clustering mode](https://estcarisimo.github.io/jitterbug/CLUSTERING_MODE/index.md): Non-sequential analysis by clustering intervals
- [Runtime across releases](https://estcarisimo.github.io/jitterbug/PERFORMANCE/index.md): Runtime across releases
- [Online mode](https://estcarisimo.github.io/jitterbug/ONLINE_MODE/index.md): Streaming and replay back ends

## API reference

- [Analyzer](https://estcarisimo.github.io/jitterbug/api/analyzer/index.md): JitterbugAnalyzer
- [Configuration](https://estcarisimo.github.io/jitterbug/api/config/index.md): JitterbugConfig and per-stage settings
- [Data models](https://estcarisimo.github.io/jitterbug/api/models/index.md): RTT datasets and analysis result models
- [Change point detection](https://estcarisimo.github.io/jitterbug/api/detection/index.md): Change point detectors
- [Latency and jitter analysis](https://estcarisimo.github.io/jitterbug/api/analysis/index.md): Latency jumps, jitter tests, and congestion inference
- [Input and output](https://estcarisimo.github.io/jitterbug/api/io/index.md): Loading measurements and exporting results
- [Plotting](https://estcarisimo.github.io/jitterbug/api/visualization/index.md): Plotting helpers
- [Online mode](https://estcarisimo.github.io/jitterbug/api/streaming/index.md): Online analyzers, verdicts, and replay

## Project

- [Changelog](https://estcarisimo.github.io/jitterbug/changelog/index.md): Release history
- [Contributing](https://estcarisimo.github.io/jitterbug/contributing/index.md): Development setup and pull request workflow
- [Citing](https://estcarisimo.github.io/jitterbug/citing/index.md): How to cite the PAM 2022 paper