Skip to main content

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

Metadata

Release files for variPEPS 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for variPEPS 1.0.0
File Size Uploaded Provenance Actions
varipeps-1.0.0.tar.gz 1.5 MB With provenance Details for varipeps-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for variPEPS 1.0.0
File Interpreter ABI Platform Actions
varipeps-1.0.0-py3-none-any.whl Python 3 none any Details for varipeps-1.0.0-py3-none-any.whl

Total release size: 1.7 MB

Release files / varipeps-1.0.0.tar.gz

Download URL varipeps-1.0.0.tar.gz
Size 1.5 MB
Tags Source
SHA-256 checksum
How to use checksums
797240922d16de7ff8bc5ec87b47be5cb5f6ccc8ddede2a54fe9ec4034b3d4a5
BLAKE2b-256 checksum
How to use checksums
cb7745e79782f57f7c2b2fe69f791ca635401f1e7f3acb67b5f6f0041b020518
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 27, 2025.

Transparency log

Release files / varipeps-1.0.0-py3-none-any.whl

Download URL varipeps-1.0.0-py3-none-any.whl
Size 151.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
95ee3142d24c7e8536771ac0a1f41af1a5502098fd5ea9cb06a1fdf65435d943
BLAKE2b-256 checksum
How to use checksums
33400e2eb207a20737740a9bb3da2c5b02460761a36f0f850dd9a4518b97ff73
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 27, 2025.

Transparency log

Security for variPEPS 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for varipeps-1.0.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 27, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page