Public API
This page is the curated, stable public API surface of MPSKit — the symbols that are exported and intended for direct use. Each entry links to its full docstring in the Library index. The category reference pages (States, Operators, Ground-state algorithms) group the same docstrings by topic.
Note
Anything not listed here (or marked internal in the Library index) is not part of the public API and may change without notice.
States
FiniteMPS, InfiniteMPS, WindowMPS, MultilineMPS
Operators and Hamiltonians
AbstractMPO, MPO, FiniteMPO, InfiniteMPO, MultilineMPO, MPOHamiltonian, FiniteMPOHamiltonian, InfiniteMPOHamiltonian, JordanMPOTensor, MultipliedOperator, TimedOperator, UntimedOperator, LazySum
Environments
Ground states and boundaries
find_groundstate, leading_boundary, approximate, VUMPS, VOMPS, DMRG, DMRG2, IDMRG, IDMRG2, GradientGrassmann
Bond dimension
changebonds, OptimalExpand, RandExpand, SvdCut, VUMPSSvdCut
Time evolution
time_evolve, timestep, make_time_mpo, TDVP, TDVP2, WI, WII, TaylorCluster
Excitations
excitations, FiniteExcited, QuasiparticleAnsatz, ChepigaAnsatz, ChepigaAnsatz2
Linear problems and spectral functions
propagator, DynamicalDMRG, NaiveInvert, Jeckelmann, exact_diagonalization, fidelity_susceptibility
Observables and analysis
expectation_value, correlator, variance, correlation_length, marek_gap, transfer_spectrum, entropy, entanglement_spectrum
Boundary conditions
open_boundary_conditions, periodic_boundary_conditions
Utility
PeriodicArray, PeriodicVector, PeriodicMatrix, WindowArray, left_virtualspace, right_virtualspace, physicalspace, braille