How varipeps/varipeps_python works
variPEPS is a Python tensor-network library for variational ground-state simulations on two-dimensional lattices. The core workflow initializes a PEPS unit cell, evaluates its environment with corner-transfer-matrix renormalization (CTMRG), computes model expectation values, then optimizes tensor parameters; observables such as overlaps and correlation lengths provide additional analysis. Lattice mappings, triangular and structure-factor CTMRG variants, and configurable tensor contractions support distinct model geometries. Connections below are limited to relationships explicitly documented in the README or visible in indexed source references; unsampled subsystem links are omitted where their callers are not shown.
Main entry points: routine.py CTMRG routines · definitions.py Tensor contractions · optimizer.py Optimizer · one_site.py Site observables
Components 24
PEPS state
- PEPS unit cell
varipeps/peps/unitcell.py - PEPS tensors
varipeps/peps/tensor.py - Random initialization
varipeps/utils/random.py - Lattice mappings
varipeps/mapping
CTMRG environment
- CTMRG routines
varipeps/ctmrg/routine.py - Boundary absorption
varipeps/ctmrg/absorption.py - Projector calculation
varipeps/ctmrg/projectors.py - Triangular CTMRG
varipeps/ctmrg/triangular_absorption.py - Structure-factor CTMRG
varipeps/ctmrg/structure_factor_routine.py
Models and observables
- Expectation models
varipeps/expectation/model.py - Site observables
varipeps/expectation/one_site.py - Multi-site observables
varipeps/expectation/two_sites.py - Triangular observables
varipeps/expectation/triangular_two_sites.py - Spiral gates
varipeps/expectation/spiral_helpers.py - Correlation length
varipeps/corrlength - State overlap
varipeps/overlap/overlap.py
Variational optimization
- Optimizer
varipeps/optimization/optimizer.py - Optimization objective
varipeps/optimization/inner_function.py - Line search
varipeps/optimization/line_search.py - Tensor retraction
varipeps/optimization/retraction.py
Numerical core
- Tensor contractions
varipeps/contractions/definitions.py - Differentiable SVD
varipeps/utils/svd.py - Runtime configuration
varipeps/config.py
Other components
- Simulation user
Connections 32
- Simulation user → PEPS unit cell: sets up
README.md - Simulation user → Optimizer: runs optimization
README.md - PEPS unit cell → PEPS tensors: uses tensors
varipeps/peps/unitcell.py - PEPS unit cell → Random initialization: initializes with
varipeps/peps/unitcell.py - Lattice mappings → Site observables: uses observables
varipeps/mapping/kagome.py - Lattice mappings → Multi-site observables: uses observables
varipeps/mapping/maple_leaf.py - CTMRG routines → Boundary absorption: runs absorption
varipeps/ctmrg/routine.py - CTMRG routines → Triangular CTMRG: runs absorption
varipeps/ctmrg/routine.py - Boundary absorption → Projector calculation: calculates projectors
varipeps/ctmrg/absorption.py - Boundary absorption → Tensor contractions: applies contractions
varipeps/ctmrg/absorption.py - Projector calculation → Tensor contractions: applies contractions
varipeps/ctmrg/projectors.py - Projector calculation → Differentiable SVD: decomposes tensors
varipeps/ctmrg/projectors.py - Structure-factor CTMRG → CTMRG routines: extends CTMRG
- CTMRG routines → Site observables: supports evaluation
- Site observables → Expectation models: implements models
varipeps/expectation/one_site.py - Multi-site observables → Expectation models: implements models
varipeps/expectation/two_sites.py - Triangular observables → Expectation models: implements models
varipeps/expectation/triangular_two_sites.py - Triangular observables → Spiral gates: rotates gates
varipeps/expectation/triangular_two_sites.py - Multi-site observables → Spiral gates: rotates gates
varipeps/expectation/two_sites.py - Site observables → Tensor contractions: applies contractions
varipeps/expectation/one_site.py - Triangular observables → Tensor contractions: applies contractions
varipeps/expectation/triangular_two_sites.py - Optimizer → Optimization objective: evaluates objective
varipeps/optimization/optimizer.py - Optimizer → Line search: selects steps
varipeps/optimization/optimizer.py - Optimizer → Tensor retraction: retracts updates
varipeps/optimization/optimizer.py - Optimization objective → CTMRG routines: runs CTMRG
varipeps/optimization/inner_function.py - Optimization objective → Lattice mappings: maps model
varipeps/optimization/inner_function.py - Optimization objective → Site observables: evaluates expectations
varipeps/optimization/inner_function.py - Correlation length → Tensor contractions: applies contractions
varipeps/corrlength/corrlength.py - State overlap → CTMRG routines: uses environment
varipeps/overlap/overlap.py - Tensor contractions → PEPS tensors: uses PEPS tensors
- Differentiable SVD → Runtime configuration: reads options
varipeps/utils/svd.py - Optimizer → Runtime configuration: reads options
varipeps/optimization/optimizer.py