# VibeSpin Documentation Hub

Welcome to the VibeSpin documentation. VibeSpin is a high-performance Python framework for simulating and analyzing two-dimensional lattice spin models, including the foundational **Ising, XY, and Clock models**.

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

introduction
physics
scripts
agents
bibliography
```

```{toctree}
:maxdepth: 1
:caption: Research & Analysis:

benchmarks
wolff_efficiency
dynamic_critical_exponents
ising_relaxation_and_autocorrelation_analysis
```

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

api/modules
```

## Indices and tables

* {ref}`genindex`
* {ref}`modindex`
* {ref}`search`