Skip to main content

Versatile tensor network library for variational ground state simulations in two spatial dimensions

Project description

variPEPS -- Versatile tensor network library for variational ground state simulations in two spatial dimensions.

DOI Documentation Status PyPI - Version

variPEPS is the Python variant of the tensor network library developed for variational ground state simulations in two spatial dimensions applying gradient optimization using automatic differentation.

For a detailed report on the method, please see our publication currently available as preprint on arXiv: https://arxiv.org/abs/2308.12358.

Installation

Installation using pip

The current version of the variPEPS Python package is available on PyPI. It can be easily installed by using the Python package manager pip:

$ python3 -m pip install variPEPS

Usage

For detailed information how to use the package we want to point out to the documentation of the project.

Citation

We are happy if you want to use the framework for your research. For the citation of our work we ask to use the following references (the publication with the method description, the Zenodo reference for this Git repository and the repository itself):

  • J. Naumann, E. L. Weerda, M. Rizzi, J. Eisert, and P. Schmoll, An introduction to infinite projected entangled-pair state methods for variational ground state simulations using automatic differentiation, SciPost Phys. Lect. Notes 86 (2024), doi:10.21468/SciPostPhysLectNotes.86.
  • J. Naumann, P. Schmoll, F. Wilde, and F. Krein, variPEPS (Python version), Zenodo.

The BibTeX code for these references are:

@article{10.21468/SciPostPhysLectNotes.86,
	title={{An introduction to infinite projected entangled-pair state methods for variational ground state simulations using automatic differentiation}},
	author={Jan Naumann and Erik Lennart Weerda and Matteo Rizzi and Jens Eisert and Philipp Schmoll},
	journal={SciPost Phys. Lect. Notes},
	pages={86},
	year={2024},
	publisher={SciPost},
	doi={10.21468/SciPostPhysLectNotes.86},
	url={https://scipost.org/10.21468/SciPostPhysLectNotes.86},
}

@misc{naumann2025variationallyoptimizinginfiniteprojected,
      title={Variationally optimizing infinite projected entangled-pair states at large bond dimensions: A split-CTMRG approach},
      author={Jan Naumann and Erik Lennart Weerda and Jens Eisert and Matteo Rizzi and Philipp Schmoll},
      year={2025},
      eprint={2502.10298},
      archivePrefix={arXiv},
      primaryClass={cond-mat.str-el},
      url={https://arxiv.org/abs/2502.10298},
}

@software{naumann24_varipeps_python,
    author =        {Jan Naumann and Philipp Schmoll and Frederik Wilde and Finn Krein},
    title =         {{variPEPS (Python version)}},
    howpublished =  {Zenodo},
    url =           {https://doi.org/10.5281/ZENODO.10852390},
    doi =           {10.5281/ZENODO.10852390},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

varipeps-1.0.2.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

varipeps-1.0.2-py3-none-any.whl (151.7 kB view details)

Uploaded Python 3

File details

Details for the file varipeps-1.0.2.tar.gz.

File metadata

  • Download URL: varipeps-1.0.2.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for varipeps-1.0.2.tar.gz
Algorithm Hash digest
SHA256 103a0045ede61ae5b3f3960afc80e5422894e60201d1bf5f5daae27faa816f28
MD5 82c99c87134fed19eefda02c2dd4193e
BLAKE2b-256 849f65cc373d46462860b2542ddbf24e0f7339239ea064de9145587c474ca482

See more details on using hashes here.

Provenance

The following attestation bundles were made for varipeps-1.0.2.tar.gz:

Publisher: release.yml on variPEPS/variPEPS_Python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file varipeps-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: varipeps-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 151.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for varipeps-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 09271f22ab30485f7f5c11e6329e51cc1a6d8142923b02155a5407bad66f81f2
MD5 0a41da434ddb31b6dc439a1f810d7da5
BLAKE2b-256 f0fcd9299e890f288581f463db3a32c9a832b8ddd451a2379dda1161f2036147

See more details on using hashes here.

Provenance

The following attestation bundles were made for varipeps-1.0.2-py3-none-any.whl:

Publisher: release.yml on variPEPS/variPEPS_Python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page