Data

Tools

Indexes

Applications

Experiments

Open Source Science

PEPSKit

Julia package for PEPS algorithms

https://github.com/quantumkithub/pepskit.jl

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Julia package for PEPS algorithms

Basic Info
  • Host: GitHub
  • Owner: QuantumKitHub
  • License: mit
  • Language: Julia
  • Default Branch: master
  • Homepage:
  • Size: 2.23 MB
Statistics
  • Stars: 122
  • Watchers: 6
  • Forks: 21
  • Open Issues: 29
  • Releases: 11
Created almost 6 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

PEPSKit.jl

docs CI codecov DOI

Tools for working with projected entangled-pair states

It contracts, it optimizes, it evolves.

Installation

The package can be installed through the Julia general registry, via the package manager:

julia-repl pkg> add PEPSKit

Key features

  • Construction and manipulation of infinite projected entangled-pair states (PEPS)
  • Contraction of infinite PEPS using the corner transfer matrix renormalization group (CTMRG) and boundary MPS methods
  • Native support for symmetric tensors through TensorKit, including fermionic tensors
  • PEPS optimization using automatic differentiation (AD) provided through Zygote
  • Imaginary time evolution algorithms
  • Support for PEPS with generic unit cells
  • Support for classical 2D partition functions and projected entangled-pair operators (PEPOs)
  • Extensible system for custom states, operators and algorithms

Quickstart

After following the installation process, it should now be possible to load the packages and start simulating. For example, in order to obtain the ground state of the 2D Heisenberg model, we can use the following code:

```julia using TensorKit, PEPSKit

construct the Hamiltonian

H = heisenberg_XYZ(InfiniteSquare())

configure the parameters

D = 2 χ = 20 ctmrgtol = 1e-10 gradtol = 1e-4

initialize a PEPS and CTMRG environment

peps₀ = InfinitePEPS(2, D) env₀, = leadingboundary(CTMRGEnv(peps₀, ComplexSpace(χ)), peps₀; tol=ctmrgtol)

ground state search

peps, env, E, = fixedpoint(H, peps₀, env₀; tol=gradtol, boundaryalg=(; tol=ctmrg_tol))

@show E # -0.6625... ```

Owner

  • Name: QuantumKitHub
  • Login: QuantumKitHub
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Brehmer
    given-names: Paul
    orcid: https://orcid.org/0009-0007-9953-2929
  - family-names: "Burgelman"
    given-names: "Lander"
    orcid: "https://orcid.org/0000-0003-1724-5330"
  - family-names: "Yue"
    given-names: "Zhengyuan"
    orcid: "https://orcid.org/0000-0001-7065-7989"
  - family-names: "Devos"
    given-names: "Lukas"
    orcid: "https://orcid.org/0000-0002-0256-4200"
title: "PEPSKit"
version: 0.6.1
identifiers:
  - type: doi
    value: 10.5281/zenodo.13938737
date-released: 2025-08-06

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 46
  • Total pull requests: 129
  • Average time to close issues: 15 days
  • Average time to close pull requests: 11 days
  • Total issue authors: 14
  • Total pull request authors: 12
  • Average comments per issue: 1.72
  • Average comments per pull request: 3.22
  • Merged pull requests: 81
  • Bot issues: 1
  • Bot pull requests: 20
Past Year
  • Issues: 42
  • Pull requests: 106
  • Average time to close issues: 10 days
  • Average time to close pull requests: 11 days
  • Issue authors: 12
  • Pull request authors: 9
  • Average comments per issue: 1.52
  • Average comments per pull request: 3.08
  • Merged pull requests: 67
  • Bot issues: 1
  • Bot pull requests: 15
View more stats
Top Authors
Issue Authors
  • Confusio (12)
  • Yue-Zhengyuan (8)
  • ogauthe (6)
  • lkdvos (5)
  • leburgel (3)
  • Gertian (3)
  • pbrehmer (2)
  • DaanVrancken (1)
  • phyjswang (1)
  • drichg (1)
  • huangrzh (1)
  • Frippio (1)
  • GlebFedorovich (1)
Pull Request Authors
  • pbrehmer (39)
  • Yue-Zhengyuan (21)
  • lkdvos (21)
  • leburgel (20)
  • github-actions[bot] (19)
  • Confusio (3)
  • ogauthe (3)
  • sanderdemeyer (3)
  • XingyuZhang2018 (1)
  • Gertian (1)
  • qmortier (1)
  • dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
documentation (1) dependencies (1)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 62 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 11
juliahub.com: PEPSKit

Julia package for PEPS algorithms

  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 62 Total
Rankings
Dependent repos count: 9.5%
Average: 25.0%
Dependent packages count: 40.6%
Last synced: 6 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • julia-actions/julia-buildpkg latest composite
  • julia-actions/julia-runtest latest composite
  • julia-actions/julia-uploadcodecov latest composite
  • julia-actions/setup-julia latest composite