variPEPS API reference
This reference documents the public API of the varipeps module. The API
documentation is automatically generated from the source code of the
varipeps library and is therefore licensed under the
GPL-3.0-or-later.
- Config of variPEPS module (
varipeps.config) - Contractions definitions and helper methods (
varipeps.contractions) - CTMRG method (
varipeps.ctmrg) - Calculation of expectation values (
varipeps.expectation) - Mapping of other structures to PEPS unitcells (
varipeps.mapping)- Mapping of Floret-Pentagon structures (
varipeps.mapping.florett_pentagon) - Mapping of Honeycomb structures (
varipeps.mapping.honeycomb) - Mapping of Kagome structures (
varipeps.mapping.kagome) - Mapping of Maple leaf structures (
varipeps.mapping.maple_leaf) - Mapping of Square-Kagome structures (
varipeps.mapping.square_kagome) - Mapping of Triangular structures (
varipeps.mapping.triangular)
- Mapping of Floret-Pentagon structures (
- Variational optimizer for the PEPS network (
varipeps.optimization)- Implementation of the basinhopping optimizer for the PEPS model (
varipeps.optimization.basinhopping) - Methods to calculate the CTRMG env and expectation value along with the gradient (
varipeps.optimization.inner_function) - Implementation of line search methods for the CTMRG variational optimization (
varipeps.optimization.line_search) - Implementation of the variational optimizer for the PEPS model (
varipeps.optimization.optimizer)
- Implementation of the basinhopping optimizer for the PEPS model (
- Implementation of PEPS structure (
varipeps.peps) - Typing helper (
varipeps.typing) - Utility functions (
varipeps.utils)