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},
}

@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.1.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.1-py3-none-any.whl (151.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: varipeps-1.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 da97ba2c4a3367b9b263cea5119cd14990a2f478a6d5176aebd6e28823438cf9
MD5 443e2a2e395ac8fcc4991fed8e4a2d6e
BLAKE2b-256 89a8afa4c3fce2542bf49b6549e874246a3ed1457142c170124b9a93a9108208

See more details on using hashes here.

Provenance

The following attestation bundles were made for varipeps-1.0.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: varipeps-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 151.6 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 68f5d29475993b83cd5863974b596f2477c72205223b74503cca4497eb588446
MD5 5a812330b5bd188a018afc46c460b416
BLAKE2b-256 f3c93fa81c8f6d4fb275e4ef9bd8aedc11e14a6f67280eb74c885ac218294482

See more details on using hashes here.

Provenance

The following attestation bundles were made for varipeps-1.0.1-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