variPEPS API reference

This reference documents the public API of the varipeps module.

• Config of variPEPS module (varipeps.config)
  • Line_Search_Methods
  • Optimizing_Methods
  • Projector_Method
  • VariPEPS_Config
  • Wavevector_Type
• Contractions definitions and helper methods (varipeps.contractions)
  • Definitions for contractions (varipeps.contractions.Definitions)
  • Apply a contraction (varipeps.contractions.apply_contraction())
• CTMRG method (varipeps.ctmrg)
  • Calculate the new CTMRG tensors for a single step (varipeps.ctmrg.absorption)
  • Calculation of CTMRG projectors (varipeps.ctmrg.projectors)
  • Calculate the new converged CTMRG tensors (varipeps.ctmrg.calc_ctmrg_env() and varipeps.ctmrg.calc_ctmrg_env_custom_rule())
• Calculation of expectation values (varipeps.expectation)
  • Model of general expectation value calculation
  • Calculation of one site expectation values
  • Calculation of two sites expectation values
  • Calculation of three sites expectation values
  • Calculation of four sites expectation values
  • Helper functions for spiral iPEPS ansatz
• 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)
• 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 PEPS structure (varipeps.peps)
  • Single PEPS tensor (varipeps.peps.PEPS_Tensor)
  • PEPS Unit cell (varipeps.peps.PEPS_Unit_Cell)
• Typing helper (varipeps.typing)
• Utility functions (varipeps.utils)
  • Debugging output helpers (varipeps.utils.debug_print)
  • Helper to calculate perodic indices (varipeps.utils.periodic_indices)
  • CTM projector management helpers (varipeps.utils.projector_dict)
  • Random number helpers (varipeps.utils.random)
  • SVD helpers (varipeps.utils.svd)