# xtbreak Documentation

Structural break detection and estimation for time series and panel data in Python.

```{toctree}
:maxdepth: 2
:caption: User Guide

quickstart
examples
examples/us-time-series
```

```{toctree}
:maxdepth: 2
:caption: Reference

api-reference
```

## Installation

```bash
pip install git+https://github.com/gorgeousfish/xtbreak-py.git
```

## Quick Links

- [GitHub Repository](https://github.com/gorgeousfish/xtbreak-py)
- [Quick Start Guide](quickstart.md)
- [API Reference](api-reference.md)
- [Examples](examples.md)