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.

Note

Notebook Source of Truth: The notebook files located under docs/source/ are symlinks to the original files in the root notebooks/ directory. Edits must be made in notebooks/, not in docs/source/. Do not replace the symlinks with standalone copies.

User Guides:

• VibeSpin
  • Project Policies & Scope Discipline
  • Bibliography
  • Scope and Methods
  • Installation
  • Benchmarking & Performance
  • Typical Usage
  • Development Guidance
  • Documentation
  • Project Context
  • Bibliography
• Physics and Algorithm Guide: VibeSpin
  • 1. Physical Models
  • 2. The Metropolis-Hastings Algorithm
  • 3. Physical Observables
  • 4. The Wolff Cluster Algorithm
  • 5. Statistical Uncertainty Estimation
  • Bibliography
• Developer and Architecture Guide
  • Software Architecture
  • Performance Engineering with Numba
  • Parallelization and Equilibration Strategy
  • Error Handling and Type Safety
  • Testing Strategy and Quality Gates
  • Uncertainty Data Contract and Pipeline
  • Bibliography
• Scripts Catalog: VibeSpin
  • 1. Ising Model (scripts/ising/)
  • 2. XY Model (scripts/xy/)
  • 3. Clock Model (scripts/clock/)
  • 4. Cross-Model Benchmarking (scripts/benchmarks/)
  • Usage Guidelines
  • Data Pipeline
• Agent Instruction Guide: VibeSpin
  • Context
  • Agent Role
  • Explanatory Writing Style
  • Mandatory Development Policies
  • Directory Map for Agents
  • Common Operational Workflows
  • Additional Engineering Guidance (Additive)
• Project Bibliography: VibeSpin
  • Referencing Policy
  • 1. Physical Models
  • 2. Algorithms
  • 3. Thermodynamic and Topological Observables
  • 4. Monte Carlo Analysis and Autocorrelation
  • 5. Numerical and Computational Methods
  • 6. Additional References
• Changelog
  • Unreleased
  • 0.1.0 — 2026-03-25
  • Unreleased

Research & Analysis:

• Performance Benchmarking for VibeSpin
• Wolff vs. Metropolis: Algorithmic Efficiency in the Critical Regime
• Dynamical Critical Exponents in the 2D Ising Model
• Ising Model: Relaxation to Equilibrium
• Ising Model: Temperature Sweep and Critical Behavior
• XY Model: Temperature Sweep and BKT Crossover
• Clock Model: Temperature Sweep and Discrete Symmetry Breaking
• BKT Transition: Vortices, Helicity, and Correlations
• Correlation Functions and Coarsening Dynamics

API Reference:

• vibespin
  • vibespin package

Indices and tables

• Index

• Module Index

• Search Page