Migrated from GitHub
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- data/.dir-locals.el +22 -0
- data/.readthedocs.yml +19 -0
- data/.zenodo.json +92 -0
- data/CITATION.cff +58 -0
- data/CMakeLists.txt +60 -0
- data/LICENSE +674 -0
- data/README.md +96 -0
- data/docs/LICENSE +427 -0
- data/docs/Makefile +20 -0
- data/docs/make.bat +35 -0
- data/docs/requirements.txt +6 -0
- data/docs/source/api/config.rst +10 -0
- data/docs/source/api/contractions/apply.rst +8 -0
- data/docs/source/api/contractions/definitions.rst +11 -0
- data/docs/source/api/contractions/index.rst +20 -0
- data/docs/source/api/ctmrg/absorption.rst +13 -0
- data/docs/source/api/ctmrg/index.rst +21 -0
- data/docs/source/api/ctmrg/projectors.rst +14 -0
- data/docs/source/api/ctmrg/routine.rst +10 -0
- data/docs/source/api/expectation/four_sites.rst +12 -0
- data/docs/source/api/expectation/index.rst +24 -0
- data/docs/source/api/expectation/model.rst +12 -0
- data/docs/source/api/expectation/one_site.rst +12 -0
- data/docs/source/api/expectation/spiral_helpers.rst +12 -0
- data/docs/source/api/expectation/three_sites.rst +12 -0
- data/docs/source/api/expectation/two_sites.rst +12 -0
- data/docs/source/api/index.rst +25 -0
- data/docs/source/api/mapping/florett_pentagon.rst +12 -0
- data/docs/source/api/mapping/honeycomb.rst +12 -0
- data/docs/source/api/mapping/index.rst +24 -0
- data/docs/source/api/mapping/kagome.rst +12 -0
- data/docs/source/api/mapping/maple_leaf.rst +12 -0
- data/docs/source/api/mapping/square_kagome.rst +12 -0
- data/docs/source/api/mapping/triangular.rst +12 -0
- data/docs/source/api/optimization/basinhopping.rst +11 -0
- data/docs/source/api/optimization/index.rst +22 -0
- data/docs/source/api/optimization/inner_function.rst +11 -0
- data/docs/source/api/optimization/line_search.rst +11 -0
- data/docs/source/api/optimization/optimizer.rst +11 -0
- data/docs/source/api/peps/index.rst +14 -0
- data/docs/source/api/peps/tensor.rst +12 -0
- data/docs/source/api/peps/unitcell.rst +12 -0
- data/docs/source/api/typing.rst +14 -0
- data/docs/source/api/utils/debug_print.rst +11 -0
- data/docs/source/api/utils/index.rst +23 -0
- data/docs/source/api/utils/periodic_indices.rst +11 -0
- data/docs/source/api/utils/projector_dict.rst +11 -0
- data/docs/source/api/utils/random.rst +14 -0
- data/docs/source/api/utils/svd.rst +11 -0
- data/docs/source/conf.py +159 -0
data/.dir-locals.el
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
((python-mode
|
| 2 |
+
(eval . (setq flycheck-python-flake8-executable
|
| 3 |
+
(expand-file-name ".venv/bin/python" (locate-dominating-file
|
| 4 |
+
default-directory
|
| 5 |
+
".dir-locals.el"))))
|
| 6 |
+
(eval . (setq flycheck-python-pylint-executable
|
| 7 |
+
(expand-file-name ".venv/bin/python" (locate-dominating-file
|
| 8 |
+
default-directory
|
| 9 |
+
".dir-locals.el"))))
|
| 10 |
+
(eval . (setq flycheck-python-mypy-executable
|
| 11 |
+
(expand-file-name ".venv/bin/mypy" (locate-dominating-file
|
| 12 |
+
default-directory
|
| 13 |
+
".dir-locals.el"))))
|
| 14 |
+
(eval . (setq flycheck-python-pycompile-executable
|
| 15 |
+
(expand-file-name ".venv/bin/python" (locate-dominating-file
|
| 16 |
+
default-directory
|
| 17 |
+
".dir-locals.el")))))
|
| 18 |
+
(rst-mode
|
| 19 |
+
(eval . (setq flycheck-rst-sphinx-executable
|
| 20 |
+
(expand-file-name ".venv/bin/sphinx-build" (locate-dominating-file
|
| 21 |
+
default-directory
|
| 22 |
+
".dir-locals.el"))))))
|
data/.readthedocs.yml
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version: 2
|
| 2 |
+
|
| 3 |
+
# Set the version of Python and other tools you might need
|
| 4 |
+
build:
|
| 5 |
+
os: ubuntu-lts-latest
|
| 6 |
+
tools:
|
| 7 |
+
python: latest
|
| 8 |
+
|
| 9 |
+
# Build documentation in the docs/ directory with Sphinx
|
| 10 |
+
sphinx:
|
| 11 |
+
configuration: docs/source/conf.py
|
| 12 |
+
|
| 13 |
+
# If using Sphinx, optionally build your docs in additional formats such as PDF
|
| 14 |
+
formats: all
|
| 15 |
+
|
| 16 |
+
# Optionally declare the Python requirements required to build your docs
|
| 17 |
+
python:
|
| 18 |
+
install:
|
| 19 |
+
- requirements: docs/requirements.txt
|
data/.zenodo.json
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"creators": [
|
| 3 |
+
{
|
| 4 |
+
"orcid": "0000-0003-4513-5139",
|
| 5 |
+
"affiliation": "Freie Universität Berlin",
|
| 6 |
+
"name": "Naumann, Jan"
|
| 7 |
+
},
|
| 8 |
+
{
|
| 9 |
+
"orcid": "0000-0001-5534-6103",
|
| 10 |
+
"affiliation": "Freie Universität Berlin",
|
| 11 |
+
"name": "Schmoll, Philipp"
|
| 12 |
+
},
|
| 13 |
+
{
|
| 14 |
+
"orcid": "0009-0003-7734-1209",
|
| 15 |
+
"affiliation": "Freie Universität Berlin",
|
| 16 |
+
"name": "Losada, Roberto"
|
| 17 |
+
},
|
| 18 |
+
{
|
| 19 |
+
"orcid": "0000-0002-6224-1964",
|
| 20 |
+
"affiliation": "Freie Universität Berlin",
|
| 21 |
+
"name": "Wilde, Frederik"
|
| 22 |
+
},
|
| 23 |
+
{
|
| 24 |
+
"affiliation": "Freie Universität Berlin",
|
| 25 |
+
"name": "Krein, Finn"
|
| 26 |
+
}
|
| 27 |
+
],
|
| 28 |
+
|
| 29 |
+
"contributors": [
|
| 30 |
+
{
|
| 31 |
+
"orcid": "0009-0006-8139-8648",
|
| 32 |
+
"affiliation": "University of Cologne",
|
| 33 |
+
"name": "Weerda, Erik Lennart",
|
| 34 |
+
"type": "Researcher"
|
| 35 |
+
},
|
| 36 |
+
{
|
| 37 |
+
"orcid": "0000-0002-8283-1005",
|
| 38 |
+
"affiliation": "University of Cologne",
|
| 39 |
+
"name": "Rizzi, Matteo",
|
| 40 |
+
"type": "Supervisor"
|
| 41 |
+
},
|
| 42 |
+
{
|
| 43 |
+
"orcid": "0000-0003-3033-1292",
|
| 44 |
+
"affiliation": "Freie Universität Berlin",
|
| 45 |
+
"name": "Eisert, Jens",
|
| 46 |
+
"type": "Supervisor"
|
| 47 |
+
}
|
| 48 |
+
],
|
| 49 |
+
|
| 50 |
+
"description": "A versatile tensor network library for variational ground state simulations in two spatial dimensions.",
|
| 51 |
+
|
| 52 |
+
"license": "GPL-3.0-or-later",
|
| 53 |
+
|
| 54 |
+
"title": "variPEPS (Python version)",
|
| 55 |
+
|
| 56 |
+
"related_identifiers": [
|
| 57 |
+
{
|
| 58 |
+
"identifier": "https://doi.org/10.21468/SciPostPhysLectNotes.86",
|
| 59 |
+
"relation": "isDocumentedBy",
|
| 60 |
+
"resource_type": "publication-article"
|
| 61 |
+
},
|
| 62 |
+
{
|
| 63 |
+
"identifier": "https://doi.org/10.1103/PhysRevB.111.235116",
|
| 64 |
+
"relation": "isDocumentedBy",
|
| 65 |
+
"resource_type": "publication-article"
|
| 66 |
+
},
|
| 67 |
+
{
|
| 68 |
+
"identifier": "https://doi.org/10.1103/g5gm-tzf8",
|
| 69 |
+
"relation": "isDocumentedBy",
|
| 70 |
+
"resource_type": "publication-article"
|
| 71 |
+
},
|
| 72 |
+
{
|
| 73 |
+
"identifier": "https://varipeps.readthedocs.io/en/stable/",
|
| 74 |
+
"relation": "isDocumentedBy",
|
| 75 |
+
"resource_type": "publication-softwaredocumentation"
|
| 76 |
+
}
|
| 77 |
+
],
|
| 78 |
+
|
| 79 |
+
"keywords": [
|
| 80 |
+
"physics",
|
| 81 |
+
"automatic-differentiation",
|
| 82 |
+
"peps",
|
| 83 |
+
"tensor-networks",
|
| 84 |
+
"variational-optimization",
|
| 85 |
+
"quantum-many-body",
|
| 86 |
+
"quantum-many-body-physics"
|
| 87 |
+
],
|
| 88 |
+
|
| 89 |
+
"communities": [
|
| 90 |
+
{"identifier": "crc183"}
|
| 91 |
+
]
|
| 92 |
+
}
|
data/CITATION.cff
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# This CITATION.cff file was generated with cffinit.
|
| 2 |
+
# Visit https://bit.ly/cffinit to generate yours today!
|
| 3 |
+
|
| 4 |
+
cff-version: 1.2.0
|
| 5 |
+
title: variPEPS (Python version)
|
| 6 |
+
message: >-
|
| 7 |
+
If you use this software, please cite it using the
|
| 8 |
+
metadata from this file.
|
| 9 |
+
type: software
|
| 10 |
+
authors:
|
| 11 |
+
- given-names: Jan
|
| 12 |
+
family-names: Naumann
|
| 13 |
+
email: j.naumann@fu-berlin.de
|
| 14 |
+
affiliation: Freie Universität Berlin
|
| 15 |
+
orcid: 'https://orcid.org/0000-0003-4513-5139'
|
| 16 |
+
- given-names: Schmoll
|
| 17 |
+
family-names: Philipp
|
| 18 |
+
affiliation: Freie Universität Berlin
|
| 19 |
+
orcid: 'https://orcid.org/0000-0001-5534-6103'
|
| 20 |
+
email: philipp.schmoll@fu-berlin.de
|
| 21 |
+
- given-names: Losada
|
| 22 |
+
family-names: Roberto
|
| 23 |
+
affiliation: Freie Universität Berlin
|
| 24 |
+
orcid: 'https://orcid.org/0009-0003-7734-1209'
|
| 25 |
+
email: roberto.losada@fu-berlin.de
|
| 26 |
+
- given-names: Wilde
|
| 27 |
+
orcid: 'https://orcid.org/0000-0002-6224-1964'
|
| 28 |
+
family-names: Frederik
|
| 29 |
+
affiliation: Freie Universität Berlin
|
| 30 |
+
- given-names: Krein
|
| 31 |
+
family-names: Finn
|
| 32 |
+
identifiers:
|
| 33 |
+
- type: doi
|
| 34 |
+
value: 10.21468/SciPostPhysLectNotes.86
|
| 35 |
+
description: Journal article with the description of the method
|
| 36 |
+
- type: doi
|
| 37 |
+
value: 10.1103/PhysRevB.111.235116
|
| 38 |
+
description: Journal article with description of the split-CTMRG method
|
| 39 |
+
- type: doi
|
| 40 |
+
value: 10.1103/g5gm-tzf8
|
| 41 |
+
description: Journal article with description of the triangular CTMRG method
|
| 42 |
+
- type: doi
|
| 43 |
+
value: 10.5281/zenodo.10852390
|
| 44 |
+
description: Zenodo DOI for current version of the code
|
| 45 |
+
repository-code: 'https://github.com/variPEPS/variPEPS_Python'
|
| 46 |
+
url: 'https://varipeps.readthedocs.io/en/stable'
|
| 47 |
+
abstract: >-
|
| 48 |
+
A versatile tensor network library for variational ground
|
| 49 |
+
state simulations in two spatial dimensions
|
| 50 |
+
keywords:
|
| 51 |
+
- physics
|
| 52 |
+
- automatic-differentiation
|
| 53 |
+
- peps
|
| 54 |
+
- tensor-networks
|
| 55 |
+
- variational-optimization
|
| 56 |
+
- quantum-many-body
|
| 57 |
+
- quantum-many-body-physics
|
| 58 |
+
license: GPL-3.0-or-later
|
data/CMakeLists.txt
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Set the minimum CMake version and policies for highest tested version
|
| 2 |
+
cmake_minimum_required(VERSION 3.15...3.27)
|
| 3 |
+
|
| 4 |
+
# Set default build type in CMake if skbuild is set
|
| 5 |
+
message(STATUS "CMAKE_BUILD_TYPE set to '${CMAKE_BUILD_TYPE}'")
|
| 6 |
+
|
| 7 |
+
# Set up the project and ensure there is a working C++ compiler
|
| 8 |
+
project(varipeps_extensions LANGUAGES CXX)
|
| 9 |
+
|
| 10 |
+
# Try to import all Python components potentially needed by nanobind
|
| 11 |
+
find_package(Python 3.11
|
| 12 |
+
REQUIRED COMPONENTS Interpreter Development.Module
|
| 13 |
+
OPTIONAL_COMPONENTS Development.SABIModule)
|
| 14 |
+
|
| 15 |
+
# Import nanobind through CMake's find_package mechanism
|
| 16 |
+
execute_process(
|
| 17 |
+
COMMAND /usr/bin/env python3 -m nanobind --cmake_dir
|
| 18 |
+
OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE nanobind_ROOT)
|
| 19 |
+
find_package(nanobind CONFIG REQUIRED)
|
| 20 |
+
|
| 21 |
+
# Find jaxlib include dir
|
| 22 |
+
IF (WIN32)
|
| 23 |
+
execute_process(
|
| 24 |
+
COMMAND python -c "import inspect; import jaxlib; import pathlib; p = pathlib.Path(inspect.getfile(jaxlib)); print(p.parent / 'include')"
|
| 25 |
+
OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE jaxlib_INCLUDE_DIR)
|
| 26 |
+
ELSE()
|
| 27 |
+
execute_process(
|
| 28 |
+
COMMAND /usr/bin/env python3 -c "import inspect; import jaxlib; import pathlib; p = pathlib.Path(inspect.getfile(jaxlib)); print(p.parent / 'include')"
|
| 29 |
+
OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE jaxlib_INCLUDE_DIR)
|
| 30 |
+
ENDIF()
|
| 31 |
+
|
| 32 |
+
|
| 33 |
+
# We are now ready to compile the actual extension module
|
| 34 |
+
nanobind_add_module(
|
| 35 |
+
# Name of the extension
|
| 36 |
+
_svd_only_u_vt
|
| 37 |
+
|
| 38 |
+
# Target the stable ABI for Python 3.12+, which reduces
|
| 39 |
+
# the number of binary wheels that must be built. This
|
| 40 |
+
# does nothing on older Python versions
|
| 41 |
+
STABLE_ABI
|
| 42 |
+
|
| 43 |
+
# Build libnanobind statically and merge it into the
|
| 44 |
+
# extension (which itself remains a shared library)
|
| 45 |
+
#
|
| 46 |
+
# If your project builds multiple extensions, you can
|
| 47 |
+
# replace this flag by NB_SHARED to conserve space by
|
| 48 |
+
# reusing a shared libnanobind across libraries
|
| 49 |
+
NB_STATIC
|
| 50 |
+
|
| 51 |
+
# Source code goes here
|
| 52 |
+
varipeps/utils/extensions/svd_ffi.cpp
|
| 53 |
+
)
|
| 54 |
+
|
| 55 |
+
target_include_directories(_svd_only_u_vt PRIVATE "${jaxlib_INCLUDE_DIR}")
|
| 56 |
+
|
| 57 |
+
# target_link_libraries(_svd_only_vt PRIVATE lapack)
|
| 58 |
+
|
| 59 |
+
# Install directive for scikit-build-core
|
| 60 |
+
install(TARGETS _svd_only_u_vt LIBRARY DESTINATION varipeps/utils/extensions)
|
data/LICENSE
ADDED
|
@@ -0,0 +1,674 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
GNU GENERAL PUBLIC LICENSE
|
| 2 |
+
Version 3, 29 June 2007
|
| 3 |
+
|
| 4 |
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
| 5 |
+
Everyone is permitted to copy and distribute verbatim copies
|
| 6 |
+
of this license document, but changing it is not allowed.
|
| 7 |
+
|
| 8 |
+
Preamble
|
| 9 |
+
|
| 10 |
+
The GNU General Public License is a free, copyleft license for
|
| 11 |
+
software and other kinds of works.
|
| 12 |
+
|
| 13 |
+
The licenses for most software and other practical works are designed
|
| 14 |
+
to take away your freedom to share and change the works. By contrast,
|
| 15 |
+
the GNU General Public License is intended to guarantee your freedom to
|
| 16 |
+
share and change all versions of a program--to make sure it remains free
|
| 17 |
+
software for all its users. We, the Free Software Foundation, use the
|
| 18 |
+
GNU General Public License for most of our software; it applies also to
|
| 19 |
+
any other work released this way by its authors. You can apply it to
|
| 20 |
+
your programs, too.
|
| 21 |
+
|
| 22 |
+
When we speak of free software, we are referring to freedom, not
|
| 23 |
+
price. Our General Public Licenses are designed to make sure that you
|
| 24 |
+
have the freedom to distribute copies of free software (and charge for
|
| 25 |
+
them if you wish), that you receive source code or can get it if you
|
| 26 |
+
want it, that you can change the software or use pieces of it in new
|
| 27 |
+
free programs, and that you know you can do these things.
|
| 28 |
+
|
| 29 |
+
To protect your rights, we need to prevent others from denying you
|
| 30 |
+
these rights or asking you to surrender the rights. Therefore, you have
|
| 31 |
+
certain responsibilities if you distribute copies of the software, or if
|
| 32 |
+
you modify it: responsibilities to respect the freedom of others.
|
| 33 |
+
|
| 34 |
+
For example, if you distribute copies of such a program, whether
|
| 35 |
+
gratis or for a fee, you must pass on to the recipients the same
|
| 36 |
+
freedoms that you received. You must make sure that they, too, receive
|
| 37 |
+
or can get the source code. And you must show them these terms so they
|
| 38 |
+
know their rights.
|
| 39 |
+
|
| 40 |
+
Developers that use the GNU GPL protect your rights with two steps:
|
| 41 |
+
(1) assert copyright on the software, and (2) offer you this License
|
| 42 |
+
giving you legal permission to copy, distribute and/or modify it.
|
| 43 |
+
|
| 44 |
+
For the developers' and authors' protection, the GPL clearly explains
|
| 45 |
+
that there is no warranty for this free software. For both users' and
|
| 46 |
+
authors' sake, the GPL requires that modified versions be marked as
|
| 47 |
+
changed, so that their problems will not be attributed erroneously to
|
| 48 |
+
authors of previous versions.
|
| 49 |
+
|
| 50 |
+
Some devices are designed to deny users access to install or run
|
| 51 |
+
modified versions of the software inside them, although the manufacturer
|
| 52 |
+
can do so. This is fundamentally incompatible with the aim of
|
| 53 |
+
protecting users' freedom to change the software. The systematic
|
| 54 |
+
pattern of such abuse occurs in the area of products for individuals to
|
| 55 |
+
use, which is precisely where it is most unacceptable. Therefore, we
|
| 56 |
+
have designed this version of the GPL to prohibit the practice for those
|
| 57 |
+
products. If such problems arise substantially in other domains, we
|
| 58 |
+
stand ready to extend this provision to those domains in future versions
|
| 59 |
+
of the GPL, as needed to protect the freedom of users.
|
| 60 |
+
|
| 61 |
+
Finally, every program is threatened constantly by software patents.
|
| 62 |
+
States should not allow patents to restrict development and use of
|
| 63 |
+
software on general-purpose computers, but in those that do, we wish to
|
| 64 |
+
avoid the special danger that patents applied to a free program could
|
| 65 |
+
make it effectively proprietary. To prevent this, the GPL assures that
|
| 66 |
+
patents cannot be used to render the program non-free.
|
| 67 |
+
|
| 68 |
+
The precise terms and conditions for copying, distribution and
|
| 69 |
+
modification follow.
|
| 70 |
+
|
| 71 |
+
TERMS AND CONDITIONS
|
| 72 |
+
|
| 73 |
+
0. Definitions.
|
| 74 |
+
|
| 75 |
+
"This License" refers to version 3 of the GNU General Public License.
|
| 76 |
+
|
| 77 |
+
"Copyright" also means copyright-like laws that apply to other kinds of
|
| 78 |
+
works, such as semiconductor masks.
|
| 79 |
+
|
| 80 |
+
"The Program" refers to any copyrightable work licensed under this
|
| 81 |
+
License. Each licensee is addressed as "you". "Licensees" and
|
| 82 |
+
"recipients" may be individuals or organizations.
|
| 83 |
+
|
| 84 |
+
To "modify" a work means to copy from or adapt all or part of the work
|
| 85 |
+
in a fashion requiring copyright permission, other than the making of an
|
| 86 |
+
exact copy. The resulting work is called a "modified version" of the
|
| 87 |
+
earlier work or a work "based on" the earlier work.
|
| 88 |
+
|
| 89 |
+
A "covered work" means either the unmodified Program or a work based
|
| 90 |
+
on the Program.
|
| 91 |
+
|
| 92 |
+
To "propagate" a work means to do anything with it that, without
|
| 93 |
+
permission, would make you directly or secondarily liable for
|
| 94 |
+
infringement under applicable copyright law, except executing it on a
|
| 95 |
+
computer or modifying a private copy. Propagation includes copying,
|
| 96 |
+
distribution (with or without modification), making available to the
|
| 97 |
+
public, and in some countries other activities as well.
|
| 98 |
+
|
| 99 |
+
To "convey" a work means any kind of propagation that enables other
|
| 100 |
+
parties to make or receive copies. Mere interaction with a user through
|
| 101 |
+
a computer network, with no transfer of a copy, is not conveying.
|
| 102 |
+
|
| 103 |
+
An interactive user interface displays "Appropriate Legal Notices"
|
| 104 |
+
to the extent that it includes a convenient and prominently visible
|
| 105 |
+
feature that (1) displays an appropriate copyright notice, and (2)
|
| 106 |
+
tells the user that there is no warranty for the work (except to the
|
| 107 |
+
extent that warranties are provided), that licensees may convey the
|
| 108 |
+
work under this License, and how to view a copy of this License. If
|
| 109 |
+
the interface presents a list of user commands or options, such as a
|
| 110 |
+
menu, a prominent item in the list meets this criterion.
|
| 111 |
+
|
| 112 |
+
1. Source Code.
|
| 113 |
+
|
| 114 |
+
The "source code" for a work means the preferred form of the work
|
| 115 |
+
for making modifications to it. "Object code" means any non-source
|
| 116 |
+
form of a work.
|
| 117 |
+
|
| 118 |
+
A "Standard Interface" means an interface that either is an official
|
| 119 |
+
standard defined by a recognized standards body, or, in the case of
|
| 120 |
+
interfaces specified for a particular programming language, one that
|
| 121 |
+
is widely used among developers working in that language.
|
| 122 |
+
|
| 123 |
+
The "System Libraries" of an executable work include anything, other
|
| 124 |
+
than the work as a whole, that (a) is included in the normal form of
|
| 125 |
+
packaging a Major Component, but which is not part of that Major
|
| 126 |
+
Component, and (b) serves only to enable use of the work with that
|
| 127 |
+
Major Component, or to implement a Standard Interface for which an
|
| 128 |
+
implementation is available to the public in source code form. A
|
| 129 |
+
"Major Component", in this context, means a major essential component
|
| 130 |
+
(kernel, window system, and so on) of the specific operating system
|
| 131 |
+
(if any) on which the executable work runs, or a compiler used to
|
| 132 |
+
produce the work, or an object code interpreter used to run it.
|
| 133 |
+
|
| 134 |
+
The "Corresponding Source" for a work in object code form means all
|
| 135 |
+
the source code needed to generate, install, and (for an executable
|
| 136 |
+
work) run the object code and to modify the work, including scripts to
|
| 137 |
+
control those activities. However, it does not include the work's
|
| 138 |
+
System Libraries, or general-purpose tools or generally available free
|
| 139 |
+
programs which are used unmodified in performing those activities but
|
| 140 |
+
which are not part of the work. For example, Corresponding Source
|
| 141 |
+
includes interface definition files associated with source files for
|
| 142 |
+
the work, and the source code for shared libraries and dynamically
|
| 143 |
+
linked subprograms that the work is specifically designed to require,
|
| 144 |
+
such as by intimate data communication or control flow between those
|
| 145 |
+
subprograms and other parts of the work.
|
| 146 |
+
|
| 147 |
+
The Corresponding Source need not include anything that users
|
| 148 |
+
can regenerate automatically from other parts of the Corresponding
|
| 149 |
+
Source.
|
| 150 |
+
|
| 151 |
+
The Corresponding Source for a work in source code form is that
|
| 152 |
+
same work.
|
| 153 |
+
|
| 154 |
+
2. Basic Permissions.
|
| 155 |
+
|
| 156 |
+
All rights granted under this License are granted for the term of
|
| 157 |
+
copyright on the Program, and are irrevocable provided the stated
|
| 158 |
+
conditions are met. This License explicitly affirms your unlimited
|
| 159 |
+
permission to run the unmodified Program. The output from running a
|
| 160 |
+
covered work is covered by this License only if the output, given its
|
| 161 |
+
content, constitutes a covered work. This License acknowledges your
|
| 162 |
+
rights of fair use or other equivalent, as provided by copyright law.
|
| 163 |
+
|
| 164 |
+
You may make, run and propagate covered works that you do not
|
| 165 |
+
convey, without conditions so long as your license otherwise remains
|
| 166 |
+
in force. You may convey covered works to others for the sole purpose
|
| 167 |
+
of having them make modifications exclusively for you, or provide you
|
| 168 |
+
with facilities for running those works, provided that you comply with
|
| 169 |
+
the terms of this License in conveying all material for which you do
|
| 170 |
+
not control copyright. Those thus making or running the covered works
|
| 171 |
+
for you must do so exclusively on your behalf, under your direction
|
| 172 |
+
and control, on terms that prohibit them from making any copies of
|
| 173 |
+
your copyrighted material outside their relationship with you.
|
| 174 |
+
|
| 175 |
+
Conveying under any other circumstances is permitted solely under
|
| 176 |
+
the conditions stated below. Sublicensing is not allowed; section 10
|
| 177 |
+
makes it unnecessary.
|
| 178 |
+
|
| 179 |
+
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
| 180 |
+
|
| 181 |
+
No covered work shall be deemed part of an effective technological
|
| 182 |
+
measure under any applicable law fulfilling obligations under article
|
| 183 |
+
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
| 184 |
+
similar laws prohibiting or restricting circumvention of such
|
| 185 |
+
measures.
|
| 186 |
+
|
| 187 |
+
When you convey a covered work, you waive any legal power to forbid
|
| 188 |
+
circumvention of technological measures to the extent such circumvention
|
| 189 |
+
is effected by exercising rights under this License with respect to
|
| 190 |
+
the covered work, and you disclaim any intention to limit operation or
|
| 191 |
+
modification of the work as a means of enforcing, against the work's
|
| 192 |
+
users, your or third parties' legal rights to forbid circumvention of
|
| 193 |
+
technological measures.
|
| 194 |
+
|
| 195 |
+
4. Conveying Verbatim Copies.
|
| 196 |
+
|
| 197 |
+
You may convey verbatim copies of the Program's source code as you
|
| 198 |
+
receive it, in any medium, provided that you conspicuously and
|
| 199 |
+
appropriately publish on each copy an appropriate copyright notice;
|
| 200 |
+
keep intact all notices stating that this License and any
|
| 201 |
+
non-permissive terms added in accord with section 7 apply to the code;
|
| 202 |
+
keep intact all notices of the absence of any warranty; and give all
|
| 203 |
+
recipients a copy of this License along with the Program.
|
| 204 |
+
|
| 205 |
+
You may charge any price or no price for each copy that you convey,
|
| 206 |
+
and you may offer support or warranty protection for a fee.
|
| 207 |
+
|
| 208 |
+
5. Conveying Modified Source Versions.
|
| 209 |
+
|
| 210 |
+
You may convey a work based on the Program, or the modifications to
|
| 211 |
+
produce it from the Program, in the form of source code under the
|
| 212 |
+
terms of section 4, provided that you also meet all of these conditions:
|
| 213 |
+
|
| 214 |
+
a) The work must carry prominent notices stating that you modified
|
| 215 |
+
it, and giving a relevant date.
|
| 216 |
+
|
| 217 |
+
b) The work must carry prominent notices stating that it is
|
| 218 |
+
released under this License and any conditions added under section
|
| 219 |
+
7. This requirement modifies the requirement in section 4 to
|
| 220 |
+
"keep intact all notices".
|
| 221 |
+
|
| 222 |
+
c) You must license the entire work, as a whole, under this
|
| 223 |
+
License to anyone who comes into possession of a copy. This
|
| 224 |
+
License will therefore apply, along with any applicable section 7
|
| 225 |
+
additional terms, to the whole of the work, and all its parts,
|
| 226 |
+
regardless of how they are packaged. This License gives no
|
| 227 |
+
permission to license the work in any other way, but it does not
|
| 228 |
+
invalidate such permission if you have separately received it.
|
| 229 |
+
|
| 230 |
+
d) If the work has interactive user interfaces, each must display
|
| 231 |
+
Appropriate Legal Notices; however, if the Program has interactive
|
| 232 |
+
interfaces that do not display Appropriate Legal Notices, your
|
| 233 |
+
work need not make them do so.
|
| 234 |
+
|
| 235 |
+
A compilation of a covered work with other separate and independent
|
| 236 |
+
works, which are not by their nature extensions of the covered work,
|
| 237 |
+
and which are not combined with it such as to form a larger program,
|
| 238 |
+
in or on a volume of a storage or distribution medium, is called an
|
| 239 |
+
"aggregate" if the compilation and its resulting copyright are not
|
| 240 |
+
used to limit the access or legal rights of the compilation's users
|
| 241 |
+
beyond what the individual works permit. Inclusion of a covered work
|
| 242 |
+
in an aggregate does not cause this License to apply to the other
|
| 243 |
+
parts of the aggregate.
|
| 244 |
+
|
| 245 |
+
6. Conveying Non-Source Forms.
|
| 246 |
+
|
| 247 |
+
You may convey a covered work in object code form under the terms
|
| 248 |
+
of sections 4 and 5, provided that you also convey the
|
| 249 |
+
machine-readable Corresponding Source under the terms of this License,
|
| 250 |
+
in one of these ways:
|
| 251 |
+
|
| 252 |
+
a) Convey the object code in, or embodied in, a physical product
|
| 253 |
+
(including a physical distribution medium), accompanied by the
|
| 254 |
+
Corresponding Source fixed on a durable physical medium
|
| 255 |
+
customarily used for software interchange.
|
| 256 |
+
|
| 257 |
+
b) Convey the object code in, or embodied in, a physical product
|
| 258 |
+
(including a physical distribution medium), accompanied by a
|
| 259 |
+
written offer, valid for at least three years and valid for as
|
| 260 |
+
long as you offer spare parts or customer support for that product
|
| 261 |
+
model, to give anyone who possesses the object code either (1) a
|
| 262 |
+
copy of the Corresponding Source for all the software in the
|
| 263 |
+
product that is covered by this License, on a durable physical
|
| 264 |
+
medium customarily used for software interchange, for a price no
|
| 265 |
+
more than your reasonable cost of physically performing this
|
| 266 |
+
conveying of source, or (2) access to copy the
|
| 267 |
+
Corresponding Source from a network server at no charge.
|
| 268 |
+
|
| 269 |
+
c) Convey individual copies of the object code with a copy of the
|
| 270 |
+
written offer to provide the Corresponding Source. This
|
| 271 |
+
alternative is allowed only occasionally and noncommercially, and
|
| 272 |
+
only if you received the object code with such an offer, in accord
|
| 273 |
+
with subsection 6b.
|
| 274 |
+
|
| 275 |
+
d) Convey the object code by offering access from a designated
|
| 276 |
+
place (gratis or for a charge), and offer equivalent access to the
|
| 277 |
+
Corresponding Source in the same way through the same place at no
|
| 278 |
+
further charge. You need not require recipients to copy the
|
| 279 |
+
Corresponding Source along with the object code. If the place to
|
| 280 |
+
copy the object code is a network server, the Corresponding Source
|
| 281 |
+
may be on a different server (operated by you or a third party)
|
| 282 |
+
that supports equivalent copying facilities, provided you maintain
|
| 283 |
+
clear directions next to the object code saying where to find the
|
| 284 |
+
Corresponding Source. Regardless of what server hosts the
|
| 285 |
+
Corresponding Source, you remain obligated to ensure that it is
|
| 286 |
+
available for as long as needed to satisfy these requirements.
|
| 287 |
+
|
| 288 |
+
e) Convey the object code using peer-to-peer transmission, provided
|
| 289 |
+
you inform other peers where the object code and Corresponding
|
| 290 |
+
Source of the work are being offered to the general public at no
|
| 291 |
+
charge under subsection 6d.
|
| 292 |
+
|
| 293 |
+
A separable portion of the object code, whose source code is excluded
|
| 294 |
+
from the Corresponding Source as a System Library, need not be
|
| 295 |
+
included in conveying the object code work.
|
| 296 |
+
|
| 297 |
+
A "User Product" is either (1) a "consumer product", which means any
|
| 298 |
+
tangible personal property which is normally used for personal, family,
|
| 299 |
+
or household purposes, or (2) anything designed or sold for incorporation
|
| 300 |
+
into a dwelling. In determining whether a product is a consumer product,
|
| 301 |
+
doubtful cases shall be resolved in favor of coverage. For a particular
|
| 302 |
+
product received by a particular user, "normally used" refers to a
|
| 303 |
+
typical or common use of that class of product, regardless of the status
|
| 304 |
+
of the particular user or of the way in which the particular user
|
| 305 |
+
actually uses, or expects or is expected to use, the product. A product
|
| 306 |
+
is a consumer product regardless of whether the product has substantial
|
| 307 |
+
commercial, industrial or non-consumer uses, unless such uses represent
|
| 308 |
+
the only significant mode of use of the product.
|
| 309 |
+
|
| 310 |
+
"Installation Information" for a User Product means any methods,
|
| 311 |
+
procedures, authorization keys, or other information required to install
|
| 312 |
+
and execute modified versions of a covered work in that User Product from
|
| 313 |
+
a modified version of its Corresponding Source. The information must
|
| 314 |
+
suffice to ensure that the continued functioning of the modified object
|
| 315 |
+
code is in no case prevented or interfered with solely because
|
| 316 |
+
modification has been made.
|
| 317 |
+
|
| 318 |
+
If you convey an object code work under this section in, or with, or
|
| 319 |
+
specifically for use in, a User Product, and the conveying occurs as
|
| 320 |
+
part of a transaction in which the right of possession and use of the
|
| 321 |
+
User Product is transferred to the recipient in perpetuity or for a
|
| 322 |
+
fixed term (regardless of how the transaction is characterized), the
|
| 323 |
+
Corresponding Source conveyed under this section must be accompanied
|
| 324 |
+
by the Installation Information. But this requirement does not apply
|
| 325 |
+
if neither you nor any third party retains the ability to install
|
| 326 |
+
modified object code on the User Product (for example, the work has
|
| 327 |
+
been installed in ROM).
|
| 328 |
+
|
| 329 |
+
The requirement to provide Installation Information does not include a
|
| 330 |
+
requirement to continue to provide support service, warranty, or updates
|
| 331 |
+
for a work that has been modified or installed by the recipient, or for
|
| 332 |
+
the User Product in which it has been modified or installed. Access to a
|
| 333 |
+
network may be denied when the modification itself materially and
|
| 334 |
+
adversely affects the operation of the network or violates the rules and
|
| 335 |
+
protocols for communication across the network.
|
| 336 |
+
|
| 337 |
+
Corresponding Source conveyed, and Installation Information provided,
|
| 338 |
+
in accord with this section must be in a format that is publicly
|
| 339 |
+
documented (and with an implementation available to the public in
|
| 340 |
+
source code form), and must require no special password or key for
|
| 341 |
+
unpacking, reading or copying.
|
| 342 |
+
|
| 343 |
+
7. Additional Terms.
|
| 344 |
+
|
| 345 |
+
"Additional permissions" are terms that supplement the terms of this
|
| 346 |
+
License by making exceptions from one or more of its conditions.
|
| 347 |
+
Additional permissions that are applicable to the entire Program shall
|
| 348 |
+
be treated as though they were included in this License, to the extent
|
| 349 |
+
that they are valid under applicable law. If additional permissions
|
| 350 |
+
apply only to part of the Program, that part may be used separately
|
| 351 |
+
under those permissions, but the entire Program remains governed by
|
| 352 |
+
this License without regard to the additional permissions.
|
| 353 |
+
|
| 354 |
+
When you convey a copy of a covered work, you may at your option
|
| 355 |
+
remove any additional permissions from that copy, or from any part of
|
| 356 |
+
it. (Additional permissions may be written to require their own
|
| 357 |
+
removal in certain cases when you modify the work.) You may place
|
| 358 |
+
additional permissions on material, added by you to a covered work,
|
| 359 |
+
for which you have or can give appropriate copyright permission.
|
| 360 |
+
|
| 361 |
+
Notwithstanding any other provision of this License, for material you
|
| 362 |
+
add to a covered work, you may (if authorized by the copyright holders of
|
| 363 |
+
that material) supplement the terms of this License with terms:
|
| 364 |
+
|
| 365 |
+
a) Disclaiming warranty or limiting liability differently from the
|
| 366 |
+
terms of sections 15 and 16 of this License; or
|
| 367 |
+
|
| 368 |
+
b) Requiring preservation of specified reasonable legal notices or
|
| 369 |
+
author attributions in that material or in the Appropriate Legal
|
| 370 |
+
Notices displayed by works containing it; or
|
| 371 |
+
|
| 372 |
+
c) Prohibiting misrepresentation of the origin of that material, or
|
| 373 |
+
requiring that modified versions of such material be marked in
|
| 374 |
+
reasonable ways as different from the original version; or
|
| 375 |
+
|
| 376 |
+
d) Limiting the use for publicity purposes of names of licensors or
|
| 377 |
+
authors of the material; or
|
| 378 |
+
|
| 379 |
+
e) Declining to grant rights under trademark law for use of some
|
| 380 |
+
trade names, trademarks, or service marks; or
|
| 381 |
+
|
| 382 |
+
f) Requiring indemnification of licensors and authors of that
|
| 383 |
+
material by anyone who conveys the material (or modified versions of
|
| 384 |
+
it) with contractual assumptions of liability to the recipient, for
|
| 385 |
+
any liability that these contractual assumptions directly impose on
|
| 386 |
+
those licensors and authors.
|
| 387 |
+
|
| 388 |
+
All other non-permissive additional terms are considered "further
|
| 389 |
+
restrictions" within the meaning of section 10. If the Program as you
|
| 390 |
+
received it, or any part of it, contains a notice stating that it is
|
| 391 |
+
governed by this License along with a term that is a further
|
| 392 |
+
restriction, you may remove that term. If a license document contains
|
| 393 |
+
a further restriction but permits relicensing or conveying under this
|
| 394 |
+
License, you may add to a covered work material governed by the terms
|
| 395 |
+
of that license document, provided that the further restriction does
|
| 396 |
+
not survive such relicensing or conveying.
|
| 397 |
+
|
| 398 |
+
If you add terms to a covered work in accord with this section, you
|
| 399 |
+
must place, in the relevant source files, a statement of the
|
| 400 |
+
additional terms that apply to those files, or a notice indicating
|
| 401 |
+
where to find the applicable terms.
|
| 402 |
+
|
| 403 |
+
Additional terms, permissive or non-permissive, may be stated in the
|
| 404 |
+
form of a separately written license, or stated as exceptions;
|
| 405 |
+
the above requirements apply either way.
|
| 406 |
+
|
| 407 |
+
8. Termination.
|
| 408 |
+
|
| 409 |
+
You may not propagate or modify a covered work except as expressly
|
| 410 |
+
provided under this License. Any attempt otherwise to propagate or
|
| 411 |
+
modify it is void, and will automatically terminate your rights under
|
| 412 |
+
this License (including any patent licenses granted under the third
|
| 413 |
+
paragraph of section 11).
|
| 414 |
+
|
| 415 |
+
However, if you cease all violation of this License, then your
|
| 416 |
+
license from a particular copyright holder is reinstated (a)
|
| 417 |
+
provisionally, unless and until the copyright holder explicitly and
|
| 418 |
+
finally terminates your license, and (b) permanently, if the copyright
|
| 419 |
+
holder fails to notify you of the violation by some reasonable means
|
| 420 |
+
prior to 60 days after the cessation.
|
| 421 |
+
|
| 422 |
+
Moreover, your license from a particular copyright holder is
|
| 423 |
+
reinstated permanently if the copyright holder notifies you of the
|
| 424 |
+
violation by some reasonable means, this is the first time you have
|
| 425 |
+
received notice of violation of this License (for any work) from that
|
| 426 |
+
copyright holder, and you cure the violation prior to 30 days after
|
| 427 |
+
your receipt of the notice.
|
| 428 |
+
|
| 429 |
+
Termination of your rights under this section does not terminate the
|
| 430 |
+
licenses of parties who have received copies or rights from you under
|
| 431 |
+
this License. If your rights have been terminated and not permanently
|
| 432 |
+
reinstated, you do not qualify to receive new licenses for the same
|
| 433 |
+
material under section 10.
|
| 434 |
+
|
| 435 |
+
9. Acceptance Not Required for Having Copies.
|
| 436 |
+
|
| 437 |
+
You are not required to accept this License in order to receive or
|
| 438 |
+
run a copy of the Program. Ancillary propagation of a covered work
|
| 439 |
+
occurring solely as a consequence of using peer-to-peer transmission
|
| 440 |
+
to receive a copy likewise does not require acceptance. However,
|
| 441 |
+
nothing other than this License grants you permission to propagate or
|
| 442 |
+
modify any covered work. These actions infringe copyright if you do
|
| 443 |
+
not accept this License. Therefore, by modifying or propagating a
|
| 444 |
+
covered work, you indicate your acceptance of this License to do so.
|
| 445 |
+
|
| 446 |
+
10. Automatic Licensing of Downstream Recipients.
|
| 447 |
+
|
| 448 |
+
Each time you convey a covered work, the recipient automatically
|
| 449 |
+
receives a license from the original licensors, to run, modify and
|
| 450 |
+
propagate that work, subject to this License. You are not responsible
|
| 451 |
+
for enforcing compliance by third parties with this License.
|
| 452 |
+
|
| 453 |
+
An "entity transaction" is a transaction transferring control of an
|
| 454 |
+
organization, or substantially all assets of one, or subdividing an
|
| 455 |
+
organization, or merging organizations. If propagation of a covered
|
| 456 |
+
work results from an entity transaction, each party to that
|
| 457 |
+
transaction who receives a copy of the work also receives whatever
|
| 458 |
+
licenses to the work the party's predecessor in interest had or could
|
| 459 |
+
give under the previous paragraph, plus a right to possession of the
|
| 460 |
+
Corresponding Source of the work from the predecessor in interest, if
|
| 461 |
+
the predecessor has it or can get it with reasonable efforts.
|
| 462 |
+
|
| 463 |
+
You may not impose any further restrictions on the exercise of the
|
| 464 |
+
rights granted or affirmed under this License. For example, you may
|
| 465 |
+
not impose a license fee, royalty, or other charge for exercise of
|
| 466 |
+
rights granted under this License, and you may not initiate litigation
|
| 467 |
+
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
| 468 |
+
any patent claim is infringed by making, using, selling, offering for
|
| 469 |
+
sale, or importing the Program or any portion of it.
|
| 470 |
+
|
| 471 |
+
11. Patents.
|
| 472 |
+
|
| 473 |
+
A "contributor" is a copyright holder who authorizes use under this
|
| 474 |
+
License of the Program or a work on which the Program is based. The
|
| 475 |
+
work thus licensed is called the contributor's "contributor version".
|
| 476 |
+
|
| 477 |
+
A contributor's "essential patent claims" are all patent claims
|
| 478 |
+
owned or controlled by the contributor, whether already acquired or
|
| 479 |
+
hereafter acquired, that would be infringed by some manner, permitted
|
| 480 |
+
by this License, of making, using, or selling its contributor version,
|
| 481 |
+
but do not include claims that would be infringed only as a
|
| 482 |
+
consequence of further modification of the contributor version. For
|
| 483 |
+
purposes of this definition, "control" includes the right to grant
|
| 484 |
+
patent sublicenses in a manner consistent with the requirements of
|
| 485 |
+
this License.
|
| 486 |
+
|
| 487 |
+
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
| 488 |
+
patent license under the contributor's essential patent claims, to
|
| 489 |
+
make, use, sell, offer for sale, import and otherwise run, modify and
|
| 490 |
+
propagate the contents of its contributor version.
|
| 491 |
+
|
| 492 |
+
In the following three paragraphs, a "patent license" is any express
|
| 493 |
+
agreement or commitment, however denominated, not to enforce a patent
|
| 494 |
+
(such as an express permission to practice a patent or covenant not to
|
| 495 |
+
sue for patent infringement). To "grant" such a patent license to a
|
| 496 |
+
party means to make such an agreement or commitment not to enforce a
|
| 497 |
+
patent against the party.
|
| 498 |
+
|
| 499 |
+
If you convey a covered work, knowingly relying on a patent license,
|
| 500 |
+
and the Corresponding Source of the work is not available for anyone
|
| 501 |
+
to copy, free of charge and under the terms of this License, through a
|
| 502 |
+
publicly available network server or other readily accessible means,
|
| 503 |
+
then you must either (1) cause the Corresponding Source to be so
|
| 504 |
+
available, or (2) arrange to deprive yourself of the benefit of the
|
| 505 |
+
patent license for this particular work, or (3) arrange, in a manner
|
| 506 |
+
consistent with the requirements of this License, to extend the patent
|
| 507 |
+
license to downstream recipients. "Knowingly relying" means you have
|
| 508 |
+
actual knowledge that, but for the patent license, your conveying the
|
| 509 |
+
covered work in a country, or your recipient's use of the covered work
|
| 510 |
+
in a country, would infringe one or more identifiable patents in that
|
| 511 |
+
country that you have reason to believe are valid.
|
| 512 |
+
|
| 513 |
+
If, pursuant to or in connection with a single transaction or
|
| 514 |
+
arrangement, you convey, or propagate by procuring conveyance of, a
|
| 515 |
+
covered work, and grant a patent license to some of the parties
|
| 516 |
+
receiving the covered work authorizing them to use, propagate, modify
|
| 517 |
+
or convey a specific copy of the covered work, then the patent license
|
| 518 |
+
you grant is automatically extended to all recipients of the covered
|
| 519 |
+
work and works based on it.
|
| 520 |
+
|
| 521 |
+
A patent license is "discriminatory" if it does not include within
|
| 522 |
+
the scope of its coverage, prohibits the exercise of, or is
|
| 523 |
+
conditioned on the non-exercise of one or more of the rights that are
|
| 524 |
+
specifically granted under this License. You may not convey a covered
|
| 525 |
+
work if you are a party to an arrangement with a third party that is
|
| 526 |
+
in the business of distributing software, under which you make payment
|
| 527 |
+
to the third party based on the extent of your activity of conveying
|
| 528 |
+
the work, and under which the third party grants, to any of the
|
| 529 |
+
parties who would receive the covered work from you, a discriminatory
|
| 530 |
+
patent license (a) in connection with copies of the covered work
|
| 531 |
+
conveyed by you (or copies made from those copies), or (b) primarily
|
| 532 |
+
for and in connection with specific products or compilations that
|
| 533 |
+
contain the covered work, unless you entered into that arrangement,
|
| 534 |
+
or that patent license was granted, prior to 28 March 2007.
|
| 535 |
+
|
| 536 |
+
Nothing in this License shall be construed as excluding or limiting
|
| 537 |
+
any implied license or other defenses to infringement that may
|
| 538 |
+
otherwise be available to you under applicable patent law.
|
| 539 |
+
|
| 540 |
+
12. No Surrender of Others' Freedom.
|
| 541 |
+
|
| 542 |
+
If conditions are imposed on you (whether by court order, agreement or
|
| 543 |
+
otherwise) that contradict the conditions of this License, they do not
|
| 544 |
+
excuse you from the conditions of this License. If you cannot convey a
|
| 545 |
+
covered work so as to satisfy simultaneously your obligations under this
|
| 546 |
+
License and any other pertinent obligations, then as a consequence you may
|
| 547 |
+
not convey it at all. For example, if you agree to terms that obligate you
|
| 548 |
+
to collect a royalty for further conveying from those to whom you convey
|
| 549 |
+
the Program, the only way you could satisfy both those terms and this
|
| 550 |
+
License would be to refrain entirely from conveying the Program.
|
| 551 |
+
|
| 552 |
+
13. Use with the GNU Affero General Public License.
|
| 553 |
+
|
| 554 |
+
Notwithstanding any other provision of this License, you have
|
| 555 |
+
permission to link or combine any covered work with a work licensed
|
| 556 |
+
under version 3 of the GNU Affero General Public License into a single
|
| 557 |
+
combined work, and to convey the resulting work. The terms of this
|
| 558 |
+
License will continue to apply to the part which is the covered work,
|
| 559 |
+
but the special requirements of the GNU Affero General Public License,
|
| 560 |
+
section 13, concerning interaction through a network will apply to the
|
| 561 |
+
combination as such.
|
| 562 |
+
|
| 563 |
+
14. Revised Versions of this License.
|
| 564 |
+
|
| 565 |
+
The Free Software Foundation may publish revised and/or new versions of
|
| 566 |
+
the GNU General Public License from time to time. Such new versions will
|
| 567 |
+
be similar in spirit to the present version, but may differ in detail to
|
| 568 |
+
address new problems or concerns.
|
| 569 |
+
|
| 570 |
+
Each version is given a distinguishing version number. If the
|
| 571 |
+
Program specifies that a certain numbered version of the GNU General
|
| 572 |
+
Public License "or any later version" applies to it, you have the
|
| 573 |
+
option of following the terms and conditions either of that numbered
|
| 574 |
+
version or of any later version published by the Free Software
|
| 575 |
+
Foundation. If the Program does not specify a version number of the
|
| 576 |
+
GNU General Public License, you may choose any version ever published
|
| 577 |
+
by the Free Software Foundation.
|
| 578 |
+
|
| 579 |
+
If the Program specifies that a proxy can decide which future
|
| 580 |
+
versions of the GNU General Public License can be used, that proxy's
|
| 581 |
+
public statement of acceptance of a version permanently authorizes you
|
| 582 |
+
to choose that version for the Program.
|
| 583 |
+
|
| 584 |
+
Later license versions may give you additional or different
|
| 585 |
+
permissions. However, no additional obligations are imposed on any
|
| 586 |
+
author or copyright holder as a result of your choosing to follow a
|
| 587 |
+
later version.
|
| 588 |
+
|
| 589 |
+
15. Disclaimer of Warranty.
|
| 590 |
+
|
| 591 |
+
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
| 592 |
+
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
| 593 |
+
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
| 594 |
+
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
| 595 |
+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
| 596 |
+
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
| 597 |
+
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
| 598 |
+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
| 599 |
+
|
| 600 |
+
16. Limitation of Liability.
|
| 601 |
+
|
| 602 |
+
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
| 603 |
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
| 604 |
+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
| 605 |
+
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
| 606 |
+
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
| 607 |
+
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
| 608 |
+
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
| 609 |
+
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
| 610 |
+
SUCH DAMAGES.
|
| 611 |
+
|
| 612 |
+
17. Interpretation of Sections 15 and 16.
|
| 613 |
+
|
| 614 |
+
If the disclaimer of warranty and limitation of liability provided
|
| 615 |
+
above cannot be given local legal effect according to their terms,
|
| 616 |
+
reviewing courts shall apply local law that most closely approximates
|
| 617 |
+
an absolute waiver of all civil liability in connection with the
|
| 618 |
+
Program, unless a warranty or assumption of liability accompanies a
|
| 619 |
+
copy of the Program in return for a fee.
|
| 620 |
+
|
| 621 |
+
END OF TERMS AND CONDITIONS
|
| 622 |
+
|
| 623 |
+
How to Apply These Terms to Your New Programs
|
| 624 |
+
|
| 625 |
+
If you develop a new program, and you want it to be of the greatest
|
| 626 |
+
possible use to the public, the best way to achieve this is to make it
|
| 627 |
+
free software which everyone can redistribute and change under these terms.
|
| 628 |
+
|
| 629 |
+
To do so, attach the following notices to the program. It is safest
|
| 630 |
+
to attach them to the start of each source file to most effectively
|
| 631 |
+
state the exclusion of warranty; and each file should have at least
|
| 632 |
+
the "copyright" line and a pointer to where the full notice is found.
|
| 633 |
+
|
| 634 |
+
varipeps
|
| 635 |
+
Copyright (C) 2021-2024 Jan Naumann and variPEPS contributors
|
| 636 |
+
|
| 637 |
+
This program is free software: you can redistribute it and/or modify
|
| 638 |
+
it under the terms of the GNU General Public License as published by
|
| 639 |
+
the Free Software Foundation, either version 3 of the License, or
|
| 640 |
+
(at your option) any later version.
|
| 641 |
+
|
| 642 |
+
This program is distributed in the hope that it will be useful,
|
| 643 |
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 644 |
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
| 645 |
+
GNU General Public License for more details.
|
| 646 |
+
|
| 647 |
+
You should have received a copy of the GNU General Public License
|
| 648 |
+
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
| 649 |
+
|
| 650 |
+
Also add information on how to contact you by electronic and paper mail.
|
| 651 |
+
|
| 652 |
+
If the program does terminal interaction, make it output a short
|
| 653 |
+
notice like this when it starts in an interactive mode:
|
| 654 |
+
|
| 655 |
+
<program> Copyright (C) 2021 qmio / peps
|
| 656 |
+
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
| 657 |
+
This is free software, and you are welcome to redistribute it
|
| 658 |
+
under certain conditions; type `show c' for details.
|
| 659 |
+
|
| 660 |
+
The hypothetical commands `show w' and `show c' should show the appropriate
|
| 661 |
+
parts of the General Public License. Of course, your program's commands
|
| 662 |
+
might be different; for a GUI interface, you would use an "about box".
|
| 663 |
+
|
| 664 |
+
You should also get your employer (if you work as a programmer) or school,
|
| 665 |
+
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
| 666 |
+
For more information on this, and how to apply and follow the GNU GPL, see
|
| 667 |
+
<https://www.gnu.org/licenses/>.
|
| 668 |
+
|
| 669 |
+
The GNU General Public License does not permit incorporating your program
|
| 670 |
+
into proprietary programs. If your program is a subroutine library, you
|
| 671 |
+
may consider it more useful to permit linking proprietary applications with
|
| 672 |
+
the library. If this is what you want to do, use the GNU Lesser General
|
| 673 |
+
Public License instead of this License. But first, please read
|
| 674 |
+
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
data/README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# variPEPS -- Versatile tensor network library for variational ground state simulations in two spatial dimensions.
|
| 4 |
+
|
| 5 |
+
[](https://zenodo.org/doi/10.5281/zenodo.10852390)
|
| 6 |
+
[](https://varipeps.readthedocs.io/en/stable/?badge=latest)
|
| 7 |
+
[](https://pypi.org/project/variPEPS/)
|
| 8 |
+
|
| 9 |
+
variPEPS is the Python variant of the tensor network library developed for
|
| 10 |
+
variational ground state simulations in two spatial dimensions applying gradient
|
| 11 |
+
optimization using automatic differentation.
|
| 12 |
+
|
| 13 |
+
For a detailed report on the method, please see our publications listed at the
|
| 14 |
+
end of this readme.
|
| 15 |
+
|
| 16 |
+
## Installation
|
| 17 |
+
### Installation using pip
|
| 18 |
+
The current version of the variPEPS Python package is available on
|
| 19 |
+
[PyPI](https://pypi.org/project/variPEPS/).
|
| 20 |
+
It can be easily installed by using the Python package manager pip:
|
| 21 |
+
```bash
|
| 22 |
+
$ python3 -m pip install variPEPS
|
| 23 |
+
```
|
| 24 |
+
|
| 25 |
+
## Usage
|
| 26 |
+
|
| 27 |
+
For detailed information how to use the package we want to point out to the
|
| 28 |
+
[documentation of the project](https://varipeps.readthedocs.io/en/stable).
|
| 29 |
+
|
| 30 |
+
## Citation
|
| 31 |
+
|
| 32 |
+
We are happy if you want to use the framework for your research. For the
|
| 33 |
+
citation of our work we ask to use the following references (the publications
|
| 34 |
+
with the method description and the Zenodo reference for this Git repository):
|
| 35 |
+
* J. Naumann, E. L. Weerda, M. Rizzi, J. Eisert, and P. Schmoll, An introduction
|
| 36 |
+
to infinite projected entangled-pair state methods for variational ground
|
| 37 |
+
state simulations using automatic differentiation, SciPost Phys. Lect. Notes
|
| 38 |
+
86 (2024),
|
| 39 |
+
doi:[10.21468/SciPostPhysLectNotes.86](https://doi.org/10.21468/SciPostPhysLectNotes.86).
|
| 40 |
+
* J. Naumann, E. L. Weerda, J. Eisert, M. Rizzi and P. Schmoll, Variationally
|
| 41 |
+
optimizing infinite projected entangled-pair states at large bond dimensions:
|
| 42 |
+
A split corner transfer matrix renormalization group approach, Phys. Rev. B
|
| 43 |
+
111, 235116 (2025),
|
| 44 |
+
doi:[10.1103/PhysRevB.111.235116](https://doi.org/10.1103/PhysRevB.111.235116).
|
| 45 |
+
* J. Naumann, J. Eisert, P. Schmoll, Variational optimization of projected
|
| 46 |
+
entangled-pair states on the triangular lattice,
|
| 47 |
+
[arXiv:2510.04907](https://arxiv.org/abs/2510.04907)
|
| 48 |
+
* J. Naumann, P. Schmoll, R. Losada, F. Wilde, and F. Krein, [variPEPS (Python
|
| 49 |
+
version)](https://zenodo.org/doi/10.5281/zenodo.10852390), Zenodo.
|
| 50 |
+
|
| 51 |
+
The BibTeX code for these references are:
|
| 52 |
+
```bibtex
|
| 53 |
+
@article{10.21468/SciPostPhysLectNotes.86,
|
| 54 |
+
title={{An introduction to infinite projected entangled-pair state methods for variational ground state simulations using automatic differentiation}},
|
| 55 |
+
author={Jan Naumann and Erik Lennart Weerda and Matteo Rizzi and Jens Eisert and Philipp Schmoll},
|
| 56 |
+
journal={SciPost Phys. Lect. Notes},
|
| 57 |
+
pages={86},
|
| 58 |
+
year={2024},
|
| 59 |
+
publisher={SciPost},
|
| 60 |
+
doi={10.21468/SciPostPhysLectNotes.86},
|
| 61 |
+
url={https://scipost.org/10.21468/SciPostPhysLectNotes.86},
|
| 62 |
+
}
|
| 63 |
+
|
| 64 |
+
@article{PhysRevB.111.235116,
|
| 65 |
+
title = {Variationally optimizing infinite projected entangled-pair states at large bond dimensions: A split corner transfer matrix renormalization group approach},
|
| 66 |
+
author = {Naumann, Jan and Weerda, Erik L. and Eisert, Jens and Rizzi, Matteo and Schmoll, Philipp},
|
| 67 |
+
journal = {Phys. Rev. B},
|
| 68 |
+
volume = {111},
|
| 69 |
+
issue = {23},
|
| 70 |
+
pages = {235116},
|
| 71 |
+
numpages = {12},
|
| 72 |
+
year = {2025},
|
| 73 |
+
month = {Jun},
|
| 74 |
+
publisher = {American Physical Society},
|
| 75 |
+
doi = {10.1103/PhysRevB.111.235116},
|
| 76 |
+
url = {https://link.aps.org/doi/10.1103/PhysRevB.111.235116}
|
| 77 |
+
}
|
| 78 |
+
|
| 79 |
+
@misc{naumann2025variationaloptimizationprojectedentangledpair,
|
| 80 |
+
title={Variational optimization of projected entangled-pair states on the triangular lattice},
|
| 81 |
+
author={Jan Naumann and Jens Eisert and Philipp Schmoll},
|
| 82 |
+
year={2025},
|
| 83 |
+
eprint={2510.04907},
|
| 84 |
+
archivePrefix={arXiv},
|
| 85 |
+
primaryClass={cond-mat.str-el},
|
| 86 |
+
url={https://arxiv.org/abs/2510.04907},
|
| 87 |
+
}
|
| 88 |
+
|
| 89 |
+
@software{naumann_varipeps_python,
|
| 90 |
+
author = {Jan Naumann and Philipp Schmoll and Roberto Losada and Frederik Wilde and Finn Krein},
|
| 91 |
+
title = {{variPEPS (Python version)}},
|
| 92 |
+
howpublished = {Zenodo},
|
| 93 |
+
url = {https://doi.org/10.5281/ZENODO.10852390},
|
| 94 |
+
doi = {10.5281/ZENODO.10852390},
|
| 95 |
+
}
|
| 96 |
+
```
|
data/docs/LICENSE
ADDED
|
@@ -0,0 +1,427 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Attribution-ShareAlike 4.0 International
|
| 2 |
+
|
| 3 |
+
=======================================================================
|
| 4 |
+
|
| 5 |
+
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
| 6 |
+
does not provide legal services or legal advice. Distribution of
|
| 7 |
+
Creative Commons public licenses does not create a lawyer-client or
|
| 8 |
+
other relationship. Creative Commons makes its licenses and related
|
| 9 |
+
information available on an "as-is" basis. Creative Commons gives no
|
| 10 |
+
warranties regarding its licenses, any material licensed under their
|
| 11 |
+
terms and conditions, or any related information. Creative Commons
|
| 12 |
+
disclaims all liability for damages resulting from their use to the
|
| 13 |
+
fullest extent possible.
|
| 14 |
+
|
| 15 |
+
Using Creative Commons Public Licenses
|
| 16 |
+
|
| 17 |
+
Creative Commons public licenses provide a standard set of terms and
|
| 18 |
+
conditions that creators and other rights holders may use to share
|
| 19 |
+
original works of authorship and other material subject to copyright
|
| 20 |
+
and certain other rights specified in the public license below. The
|
| 21 |
+
following considerations are for informational purposes only, are not
|
| 22 |
+
exhaustive, and do not form part of our licenses.
|
| 23 |
+
|
| 24 |
+
Considerations for licensors: Our public licenses are
|
| 25 |
+
intended for use by those authorized to give the public
|
| 26 |
+
permission to use material in ways otherwise restricted by
|
| 27 |
+
copyright and certain other rights. Our licenses are
|
| 28 |
+
irrevocable. Licensors should read and understand the terms
|
| 29 |
+
and conditions of the license they choose before applying it.
|
| 30 |
+
Licensors should also secure all rights necessary before
|
| 31 |
+
applying our licenses so that the public can reuse the
|
| 32 |
+
material as expected. Licensors should clearly mark any
|
| 33 |
+
material not subject to the license. This includes other CC-
|
| 34 |
+
licensed material, or material used under an exception or
|
| 35 |
+
limitation to copyright. More considerations for licensors:
|
| 36 |
+
wiki.creativecommons.org/Considerations_for_licensors
|
| 37 |
+
|
| 38 |
+
Considerations for the public: By using one of our public
|
| 39 |
+
licenses, a licensor grants the public permission to use the
|
| 40 |
+
licensed material under specified terms and conditions. If
|
| 41 |
+
the licensor's permission is not necessary for any reason--for
|
| 42 |
+
example, because of any applicable exception or limitation to
|
| 43 |
+
copyright--then that use is not regulated by the license. Our
|
| 44 |
+
licenses grant only permissions under copyright and certain
|
| 45 |
+
other rights that a licensor has authority to grant. Use of
|
| 46 |
+
the licensed material may still be restricted for other
|
| 47 |
+
reasons, including because others have copyright or other
|
| 48 |
+
rights in the material. A licensor may make special requests,
|
| 49 |
+
such as asking that all changes be marked or described.
|
| 50 |
+
Although not required by our licenses, you are encouraged to
|
| 51 |
+
respect those requests where reasonable. More considerations
|
| 52 |
+
for the public:
|
| 53 |
+
wiki.creativecommons.org/Considerations_for_licensees
|
| 54 |
+
|
| 55 |
+
=======================================================================
|
| 56 |
+
|
| 57 |
+
Creative Commons Attribution-ShareAlike 4.0 International Public
|
| 58 |
+
License
|
| 59 |
+
|
| 60 |
+
By exercising the Licensed Rights (defined below), You accept and agree
|
| 61 |
+
to be bound by the terms and conditions of this Creative Commons
|
| 62 |
+
Attribution-ShareAlike 4.0 International Public License ("Public
|
| 63 |
+
License"). To the extent this Public License may be interpreted as a
|
| 64 |
+
contract, You are granted the Licensed Rights in consideration of Your
|
| 65 |
+
acceptance of these terms and conditions, and the Licensor grants You
|
| 66 |
+
such rights in consideration of benefits the Licensor receives from
|
| 67 |
+
making the Licensed Material available under these terms and
|
| 68 |
+
conditions.
|
| 69 |
+
|
| 70 |
+
|
| 71 |
+
Section 1 -- Definitions.
|
| 72 |
+
|
| 73 |
+
a. Adapted Material means material subject to Copyright and Similar
|
| 74 |
+
Rights that is derived from or based upon the Licensed Material
|
| 75 |
+
and in which the Licensed Material is translated, altered,
|
| 76 |
+
arranged, transformed, or otherwise modified in a manner requiring
|
| 77 |
+
permission under the Copyright and Similar Rights held by the
|
| 78 |
+
Licensor. For purposes of this Public License, where the Licensed
|
| 79 |
+
Material is a musical work, performance, or sound recording,
|
| 80 |
+
Adapted Material is always produced where the Licensed Material is
|
| 81 |
+
synched in timed relation with a moving image.
|
| 82 |
+
|
| 83 |
+
b. Adapter's License means the license You apply to Your Copyright
|
| 84 |
+
and Similar Rights in Your contributions to Adapted Material in
|
| 85 |
+
accordance with the terms and conditions of this Public License.
|
| 86 |
+
|
| 87 |
+
c. BY-SA Compatible License means a license listed at
|
| 88 |
+
creativecommons.org/compatiblelicenses, approved by Creative
|
| 89 |
+
Commons as essentially the equivalent of this Public License.
|
| 90 |
+
|
| 91 |
+
d. Copyright and Similar Rights means copyright and/or similar rights
|
| 92 |
+
closely related to copyright including, without limitation,
|
| 93 |
+
performance, broadcast, sound recording, and Sui Generis Database
|
| 94 |
+
Rights, without regard to how the rights are labeled or
|
| 95 |
+
categorized. For purposes of this Public License, the rights
|
| 96 |
+
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
| 97 |
+
Rights.
|
| 98 |
+
|
| 99 |
+
e. Effective Technological Measures means those measures that, in the
|
| 100 |
+
absence of proper authority, may not be circumvented under laws
|
| 101 |
+
fulfilling obligations under Article 11 of the WIPO Copyright
|
| 102 |
+
Treaty adopted on December 20, 1996, and/or similar international
|
| 103 |
+
agreements.
|
| 104 |
+
|
| 105 |
+
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
| 106 |
+
any other exception or limitation to Copyright and Similar Rights
|
| 107 |
+
that applies to Your use of the Licensed Material.
|
| 108 |
+
|
| 109 |
+
g. License Elements means the license attributes listed in the name
|
| 110 |
+
of a Creative Commons Public License. The License Elements of this
|
| 111 |
+
Public License are Attribution and ShareAlike.
|
| 112 |
+
|
| 113 |
+
h. Licensed Material means the artistic or literary work, database,
|
| 114 |
+
or other material to which the Licensor applied this Public
|
| 115 |
+
License.
|
| 116 |
+
|
| 117 |
+
i. Licensed Rights means the rights granted to You subject to the
|
| 118 |
+
terms and conditions of this Public License, which are limited to
|
| 119 |
+
all Copyright and Similar Rights that apply to Your use of the
|
| 120 |
+
Licensed Material and that the Licensor has authority to license.
|
| 121 |
+
|
| 122 |
+
j. Licensor means the individual(s) or entity(ies) granting rights
|
| 123 |
+
under this Public License.
|
| 124 |
+
|
| 125 |
+
k. Share means to provide material to the public by any means or
|
| 126 |
+
process that requires permission under the Licensed Rights, such
|
| 127 |
+
as reproduction, public display, public performance, distribution,
|
| 128 |
+
dissemination, communication, or importation, and to make material
|
| 129 |
+
available to the public including in ways that members of the
|
| 130 |
+
public may access the material from a place and at a time
|
| 131 |
+
individually chosen by them.
|
| 132 |
+
|
| 133 |
+
l. Sui Generis Database Rights means rights other than copyright
|
| 134 |
+
resulting from Directive 96/9/EC of the European Parliament and of
|
| 135 |
+
the Council of 11 March 1996 on the legal protection of databases,
|
| 136 |
+
as amended and/or succeeded, as well as other essentially
|
| 137 |
+
equivalent rights anywhere in the world.
|
| 138 |
+
|
| 139 |
+
m. You means the individual or entity exercising the Licensed Rights
|
| 140 |
+
under this Public License. Your has a corresponding meaning.
|
| 141 |
+
|
| 142 |
+
|
| 143 |
+
Section 2 -- Scope.
|
| 144 |
+
|
| 145 |
+
a. License grant.
|
| 146 |
+
|
| 147 |
+
1. Subject to the terms and conditions of this Public License,
|
| 148 |
+
the Licensor hereby grants You a worldwide, royalty-free,
|
| 149 |
+
non-sublicensable, non-exclusive, irrevocable license to
|
| 150 |
+
exercise the Licensed Rights in the Licensed Material to:
|
| 151 |
+
|
| 152 |
+
a. reproduce and Share the Licensed Material, in whole or
|
| 153 |
+
in part; and
|
| 154 |
+
|
| 155 |
+
b. produce, reproduce, and Share Adapted Material.
|
| 156 |
+
|
| 157 |
+
2. Exceptions and Limitations. For the avoidance of doubt, where
|
| 158 |
+
Exceptions and Limitations apply to Your use, this Public
|
| 159 |
+
License does not apply, and You do not need to comply with
|
| 160 |
+
its terms and conditions.
|
| 161 |
+
|
| 162 |
+
3. Term. The term of this Public License is specified in Section
|
| 163 |
+
6(a).
|
| 164 |
+
|
| 165 |
+
4. Media and formats; technical modifications allowed. The
|
| 166 |
+
Licensor authorizes You to exercise the Licensed Rights in
|
| 167 |
+
all media and formats whether now known or hereafter created,
|
| 168 |
+
and to make technical modifications necessary to do so. The
|
| 169 |
+
Licensor waives and/or agrees not to assert any right or
|
| 170 |
+
authority to forbid You from making technical modifications
|
| 171 |
+
necessary to exercise the Licensed Rights, including
|
| 172 |
+
technical modifications necessary to circumvent Effective
|
| 173 |
+
Technological Measures. For purposes of this Public License,
|
| 174 |
+
simply making modifications authorized by this Section 2(a)
|
| 175 |
+
(4) never produces Adapted Material.
|
| 176 |
+
|
| 177 |
+
5. Downstream recipients.
|
| 178 |
+
|
| 179 |
+
a. Offer from the Licensor -- Licensed Material. Every
|
| 180 |
+
recipient of the Licensed Material automatically
|
| 181 |
+
receives an offer from the Licensor to exercise the
|
| 182 |
+
Licensed Rights under the terms and conditions of this
|
| 183 |
+
Public License.
|
| 184 |
+
|
| 185 |
+
b. Additional offer from the Licensor -- Adapted Material.
|
| 186 |
+
Every recipient of Adapted Material from You
|
| 187 |
+
automatically receives an offer from the Licensor to
|
| 188 |
+
exercise the Licensed Rights in the Adapted Material
|
| 189 |
+
under the conditions of the Adapter's License You apply.
|
| 190 |
+
|
| 191 |
+
c. No downstream restrictions. You may not offer or impose
|
| 192 |
+
any additional or different terms or conditions on, or
|
| 193 |
+
apply any Effective Technological Measures to, the
|
| 194 |
+
Licensed Material if doing so restricts exercise of the
|
| 195 |
+
Licensed Rights by any recipient of the Licensed
|
| 196 |
+
Material.
|
| 197 |
+
|
| 198 |
+
6. No endorsement. Nothing in this Public License constitutes or
|
| 199 |
+
may be construed as permission to assert or imply that You
|
| 200 |
+
are, or that Your use of the Licensed Material is, connected
|
| 201 |
+
with, or sponsored, endorsed, or granted official status by,
|
| 202 |
+
the Licensor or others designated to receive attribution as
|
| 203 |
+
provided in Section 3(a)(1)(A)(i).
|
| 204 |
+
|
| 205 |
+
b. Other rights.
|
| 206 |
+
|
| 207 |
+
1. Moral rights, such as the right of integrity, are not
|
| 208 |
+
licensed under this Public License, nor are publicity,
|
| 209 |
+
privacy, and/or other similar personality rights; however, to
|
| 210 |
+
the extent possible, the Licensor waives and/or agrees not to
|
| 211 |
+
assert any such rights held by the Licensor to the limited
|
| 212 |
+
extent necessary to allow You to exercise the Licensed
|
| 213 |
+
Rights, but not otherwise.
|
| 214 |
+
|
| 215 |
+
2. Patent and trademark rights are not licensed under this
|
| 216 |
+
Public License.
|
| 217 |
+
|
| 218 |
+
3. To the extent possible, the Licensor waives any right to
|
| 219 |
+
collect royalties from You for the exercise of the Licensed
|
| 220 |
+
Rights, whether directly or through a collecting society
|
| 221 |
+
under any voluntary or waivable statutory or compulsory
|
| 222 |
+
licensing scheme. In all other cases the Licensor expressly
|
| 223 |
+
reserves any right to collect such royalties.
|
| 224 |
+
|
| 225 |
+
|
| 226 |
+
Section 3 -- License Conditions.
|
| 227 |
+
|
| 228 |
+
Your exercise of the Licensed Rights is expressly made subject to the
|
| 229 |
+
following conditions.
|
| 230 |
+
|
| 231 |
+
a. Attribution.
|
| 232 |
+
|
| 233 |
+
1. If You Share the Licensed Material (including in modified
|
| 234 |
+
form), You must:
|
| 235 |
+
|
| 236 |
+
a. retain the following if it is supplied by the Licensor
|
| 237 |
+
with the Licensed Material:
|
| 238 |
+
|
| 239 |
+
i. identification of the creator(s) of the Licensed
|
| 240 |
+
Material and any others designated to receive
|
| 241 |
+
attribution, in any reasonable manner requested by
|
| 242 |
+
the Licensor (including by pseudonym if
|
| 243 |
+
designated);
|
| 244 |
+
|
| 245 |
+
ii. a copyright notice;
|
| 246 |
+
|
| 247 |
+
iii. a notice that refers to this Public License;
|
| 248 |
+
|
| 249 |
+
iv. a notice that refers to the disclaimer of
|
| 250 |
+
warranties;
|
| 251 |
+
|
| 252 |
+
v. a URI or hyperlink to the Licensed Material to the
|
| 253 |
+
extent reasonably practicable;
|
| 254 |
+
|
| 255 |
+
b. indicate if You modified the Licensed Material and
|
| 256 |
+
retain an indication of any previous modifications; and
|
| 257 |
+
|
| 258 |
+
c. indicate the Licensed Material is licensed under this
|
| 259 |
+
Public License, and include the text of, or the URI or
|
| 260 |
+
hyperlink to, this Public License.
|
| 261 |
+
|
| 262 |
+
2. You may satisfy the conditions in Section 3(a)(1) in any
|
| 263 |
+
reasonable manner based on the medium, means, and context in
|
| 264 |
+
which You Share the Licensed Material. For example, it may be
|
| 265 |
+
reasonable to satisfy the conditions by providing a URI or
|
| 266 |
+
hyperlink to a resource that includes the required
|
| 267 |
+
information.
|
| 268 |
+
|
| 269 |
+
3. If requested by the Licensor, You must remove any of the
|
| 270 |
+
information required by Section 3(a)(1)(A) to the extent
|
| 271 |
+
reasonably practicable.
|
| 272 |
+
|
| 273 |
+
b. ShareAlike.
|
| 274 |
+
|
| 275 |
+
In addition to the conditions in Section 3(a), if You Share
|
| 276 |
+
Adapted Material You produce, the following conditions also apply.
|
| 277 |
+
|
| 278 |
+
1. The Adapter's License You apply must be a Creative Commons
|
| 279 |
+
license with the same License Elements, this version or
|
| 280 |
+
later, or a BY-SA Compatible License.
|
| 281 |
+
|
| 282 |
+
2. You must include the text of, or the URI or hyperlink to, the
|
| 283 |
+
Adapter's License You apply. You may satisfy this condition
|
| 284 |
+
in any reasonable manner based on the medium, means, and
|
| 285 |
+
context in which You Share Adapted Material.
|
| 286 |
+
|
| 287 |
+
3. You may not offer or impose any additional or different terms
|
| 288 |
+
or conditions on, or apply any Effective Technological
|
| 289 |
+
Measures to, Adapted Material that restrict exercise of the
|
| 290 |
+
rights granted under the Adapter's License You apply.
|
| 291 |
+
|
| 292 |
+
|
| 293 |
+
Section 4 -- Sui Generis Database Rights.
|
| 294 |
+
|
| 295 |
+
Where the Licensed Rights include Sui Generis Database Rights that
|
| 296 |
+
apply to Your use of the Licensed Material:
|
| 297 |
+
|
| 298 |
+
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
| 299 |
+
to extract, reuse, reproduce, and Share all or a substantial
|
| 300 |
+
portion of the contents of the database;
|
| 301 |
+
|
| 302 |
+
b. if You include all or a substantial portion of the database
|
| 303 |
+
contents in a database in which You have Sui Generis Database
|
| 304 |
+
Rights, then the database in which You have Sui Generis Database
|
| 305 |
+
Rights (but not its individual contents) is Adapted Material,
|
| 306 |
+
including for purposes of Section 3(b); and
|
| 307 |
+
|
| 308 |
+
c. You must comply with the conditions in Section 3(a) if You Share
|
| 309 |
+
all or a substantial portion of the contents of the database.
|
| 310 |
+
|
| 311 |
+
For the avoidance of doubt, this Section 4 supplements and does not
|
| 312 |
+
replace Your obligations under this Public License where the Licensed
|
| 313 |
+
Rights include other Copyright and Similar Rights.
|
| 314 |
+
|
| 315 |
+
|
| 316 |
+
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
| 317 |
+
|
| 318 |
+
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
| 319 |
+
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
| 320 |
+
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
| 321 |
+
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
| 322 |
+
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
| 323 |
+
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
| 324 |
+
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
| 325 |
+
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
| 326 |
+
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
| 327 |
+
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
| 328 |
+
|
| 329 |
+
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
| 330 |
+
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
| 331 |
+
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
| 332 |
+
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
| 333 |
+
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
| 334 |
+
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
| 335 |
+
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
| 336 |
+
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
| 337 |
+
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
| 338 |
+
|
| 339 |
+
c. The disclaimer of warranties and limitation of liability provided
|
| 340 |
+
above shall be interpreted in a manner that, to the extent
|
| 341 |
+
possible, most closely approximates an absolute disclaimer and
|
| 342 |
+
waiver of all liability.
|
| 343 |
+
|
| 344 |
+
|
| 345 |
+
Section 6 -- Term and Termination.
|
| 346 |
+
|
| 347 |
+
a. This Public License applies for the term of the Copyright and
|
| 348 |
+
Similar Rights licensed here. However, if You fail to comply with
|
| 349 |
+
this Public License, then Your rights under this Public License
|
| 350 |
+
terminate automatically.
|
| 351 |
+
|
| 352 |
+
b. Where Your right to use the Licensed Material has terminated under
|
| 353 |
+
Section 6(a), it reinstates:
|
| 354 |
+
|
| 355 |
+
1. automatically as of the date the violation is cured, provided
|
| 356 |
+
it is cured within 30 days of Your discovery of the
|
| 357 |
+
violation; or
|
| 358 |
+
|
| 359 |
+
2. upon express reinstatement by the Licensor.
|
| 360 |
+
|
| 361 |
+
For the avoidance of doubt, this Section 6(b) does not affect any
|
| 362 |
+
right the Licensor may have to seek remedies for Your violations
|
| 363 |
+
of this Public License.
|
| 364 |
+
|
| 365 |
+
c. For the avoidance of doubt, the Licensor may also offer the
|
| 366 |
+
Licensed Material under separate terms or conditions or stop
|
| 367 |
+
distributing the Licensed Material at any time; however, doing so
|
| 368 |
+
will not terminate this Public License.
|
| 369 |
+
|
| 370 |
+
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
| 371 |
+
License.
|
| 372 |
+
|
| 373 |
+
|
| 374 |
+
Section 7 -- Other Terms and Conditions.
|
| 375 |
+
|
| 376 |
+
a. The Licensor shall not be bound by any additional or different
|
| 377 |
+
terms or conditions communicated by You unless expressly agreed.
|
| 378 |
+
|
| 379 |
+
b. Any arrangements, understandings, or agreements regarding the
|
| 380 |
+
Licensed Material not stated herein are separate from and
|
| 381 |
+
independent of the terms and conditions of this Public License.
|
| 382 |
+
|
| 383 |
+
|
| 384 |
+
Section 8 -- Interpretation.
|
| 385 |
+
|
| 386 |
+
a. For the avoidance of doubt, this Public License does not, and
|
| 387 |
+
shall not be interpreted to, reduce, limit, restrict, or impose
|
| 388 |
+
conditions on any use of the Licensed Material that could lawfully
|
| 389 |
+
be made without permission under this Public License.
|
| 390 |
+
|
| 391 |
+
b. To the extent possible, if any provision of this Public License is
|
| 392 |
+
deemed unenforceable, it shall be automatically reformed to the
|
| 393 |
+
minimum extent necessary to make it enforceable. If the provision
|
| 394 |
+
cannot be reformed, it shall be severed from this Public License
|
| 395 |
+
without affecting the enforceability of the remaining terms and
|
| 396 |
+
conditions.
|
| 397 |
+
|
| 398 |
+
c. No term or condition of this Public License will be waived and no
|
| 399 |
+
failure to comply consented to unless expressly agreed to by the
|
| 400 |
+
Licensor.
|
| 401 |
+
|
| 402 |
+
d. Nothing in this Public License constitutes or may be interpreted
|
| 403 |
+
as a limitation upon, or waiver of, any privileges and immunities
|
| 404 |
+
that apply to the Licensor or You, including from the legal
|
| 405 |
+
processes of any jurisdiction or authority.
|
| 406 |
+
|
| 407 |
+
|
| 408 |
+
=======================================================================
|
| 409 |
+
|
| 410 |
+
Creative Commons is not a party to its public
|
| 411 |
+
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
| 412 |
+
its public licenses to material it publishes and in those instances
|
| 413 |
+
will be considered the “Licensor.” The text of the Creative Commons
|
| 414 |
+
public licenses is dedicated to the public domain under the CC0 Public
|
| 415 |
+
Domain Dedication. Except for the limited purpose of indicating that
|
| 416 |
+
material is shared under a Creative Commons public license or as
|
| 417 |
+
otherwise permitted by the Creative Commons policies published at
|
| 418 |
+
creativecommons.org/policies, Creative Commons does not authorize the
|
| 419 |
+
use of the trademark "Creative Commons" or any other trademark or logo
|
| 420 |
+
of Creative Commons without its prior written consent including,
|
| 421 |
+
without limitation, in connection with any unauthorized modifications
|
| 422 |
+
to any of its public licenses or any other arrangements,
|
| 423 |
+
understandings, or agreements concerning use of licensed material. For
|
| 424 |
+
the avoidance of doubt, this paragraph does not form part of the
|
| 425 |
+
public licenses.
|
| 426 |
+
|
| 427 |
+
Creative Commons may be contacted at creativecommons.org.
|
data/docs/Makefile
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Minimal makefile for Sphinx documentation
|
| 2 |
+
#
|
| 3 |
+
|
| 4 |
+
# You can set these variables from the command line, and also
|
| 5 |
+
# from the environment for the first two.
|
| 6 |
+
SPHINXOPTS ?=
|
| 7 |
+
SPHINXBUILD ?= sphinx-build
|
| 8 |
+
SOURCEDIR = source
|
| 9 |
+
BUILDDIR = build
|
| 10 |
+
|
| 11 |
+
# Put it first so that "make" without argument is like "make help".
|
| 12 |
+
help:
|
| 13 |
+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
| 14 |
+
|
| 15 |
+
.PHONY: help Makefile
|
| 16 |
+
|
| 17 |
+
# Catch-all target: route all unknown targets to Sphinx using the new
|
| 18 |
+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
| 19 |
+
%: Makefile
|
| 20 |
+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
data/docs/make.bat
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
@ECHO OFF
|
| 2 |
+
|
| 3 |
+
pushd %~dp0
|
| 4 |
+
|
| 5 |
+
REM Command file for Sphinx documentation
|
| 6 |
+
|
| 7 |
+
if "%SPHINXBUILD%" == "" (
|
| 8 |
+
set SPHINXBUILD=sphinx-build
|
| 9 |
+
)
|
| 10 |
+
set SOURCEDIR=source
|
| 11 |
+
set BUILDDIR=build
|
| 12 |
+
|
| 13 |
+
if "%1" == "" goto help
|
| 14 |
+
|
| 15 |
+
%SPHINXBUILD% >NUL 2>NUL
|
| 16 |
+
if errorlevel 9009 (
|
| 17 |
+
echo.
|
| 18 |
+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
| 19 |
+
echo.installed, then set the SPHINXBUILD environment variable to point
|
| 20 |
+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
| 21 |
+
echo.may add the Sphinx directory to PATH.
|
| 22 |
+
echo.
|
| 23 |
+
echo.If you don't have Sphinx installed, grab it from
|
| 24 |
+
echo.https://www.sphinx-doc.org/
|
| 25 |
+
exit /b 1
|
| 26 |
+
)
|
| 27 |
+
|
| 28 |
+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
| 29 |
+
goto end
|
| 30 |
+
|
| 31 |
+
:help
|
| 32 |
+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
| 33 |
+
|
| 34 |
+
:end
|
| 35 |
+
popd
|
data/docs/requirements.txt
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
sphinx>=4.4.0
|
| 2 |
+
sphinx_rtd_theme>=1.0.0
|
| 3 |
+
sphinx_autodoc_defaultargs>=0.1.2
|
| 4 |
+
sphinx_subfigure>=0.2.4
|
| 5 |
+
|
| 6 |
+
.
|
data/docs/source/api/config.rst
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_config:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.config
|
| 4 |
+
|
| 5 |
+
Config of variPEPS module (:mod:`varipeps.config`)
|
| 6 |
+
==================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.config
|
| 9 |
+
:members:
|
| 10 |
+
:show-inheritance:
|
data/docs/source/api/contractions/apply.rst
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_contractions_apply:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.contractions
|
| 4 |
+
|
| 5 |
+
Apply a contraction (:func:`varipeps.contractions.apply_contraction`)
|
| 6 |
+
=====================================================================
|
| 7 |
+
|
| 8 |
+
.. autofunction:: apply_contraction
|
data/docs/source/api/contractions/definitions.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_contractions_definitions:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.contractions
|
| 4 |
+
|
| 5 |
+
Definitions for contractions (:class:`varipeps.contractions.Definitions`)
|
| 6 |
+
=========================================================================
|
| 7 |
+
|
| 8 |
+
.. autoclass:: Definitions
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
data/docs/source/api/contractions/index.rst
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_contractions:
|
| 2 |
+
|
| 3 |
+
.. py:module:: varipeps.contractions
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.contractions
|
| 6 |
+
|
| 7 |
+
Contractions definitions and helper methods (:mod:`varipeps.contractions`)
|
| 8 |
+
==========================================================================
|
| 9 |
+
|
| 10 |
+
.. toctree::
|
| 11 |
+
:maxdepth: 2
|
| 12 |
+
|
| 13 |
+
definitions
|
| 14 |
+
apply
|
| 15 |
+
|
| 16 |
+
.. automodule:: varipeps.contractions
|
| 17 |
+
:members:
|
| 18 |
+
:undoc-members:
|
| 19 |
+
:show-inheritance:
|
| 20 |
+
:noindex:
|
data/docs/source/api/ctmrg/absorption.rst
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_ctmrg_absorption:
|
| 2 |
+
|
| 3 |
+
.. module:: varipeps.ctmrg.absorption
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.ctmrg.absorption
|
| 6 |
+
|
| 7 |
+
Calculate the new CTMRG tensors for a single step (:mod:`varipeps.ctmrg.absorption`)
|
| 8 |
+
====================================================================================
|
| 9 |
+
|
| 10 |
+
.. automodule:: varipeps.ctmrg.absorption
|
| 11 |
+
:members:
|
| 12 |
+
:show-inheritance:
|
| 13 |
+
:noindex:
|
data/docs/source/api/ctmrg/index.rst
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_ctmrg:
|
| 2 |
+
|
| 3 |
+
.. py:module:: varipeps.ctmrg
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.ctmrg
|
| 6 |
+
|
| 7 |
+
CTMRG method (:mod:`varipeps.ctmrg`)
|
| 8 |
+
====================================
|
| 9 |
+
|
| 10 |
+
.. toctree::
|
| 11 |
+
:maxdepth: 2
|
| 12 |
+
|
| 13 |
+
absorption
|
| 14 |
+
projectors
|
| 15 |
+
routine
|
| 16 |
+
|
| 17 |
+
.. automodule:: varipeps.ctmrg
|
| 18 |
+
:members:
|
| 19 |
+
:undoc-members:
|
| 20 |
+
:show-inheritance:
|
| 21 |
+
:noindex:
|
data/docs/source/api/ctmrg/projectors.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_ctmrg_projectors:
|
| 2 |
+
|
| 3 |
+
.. module:: varipeps.ctmrg.projectors
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.ctmrg.projectors
|
| 6 |
+
|
| 7 |
+
Calculation of CTMRG projectors (:mod:`varipeps.ctmrg.projectors`)
|
| 8 |
+
==================================================================
|
| 9 |
+
|
| 10 |
+
.. automodule:: varipeps.ctmrg.projectors
|
| 11 |
+
:members:
|
| 12 |
+
:undoc-members:
|
| 13 |
+
:show-inheritance:
|
| 14 |
+
:noindex:
|
data/docs/source/api/ctmrg/routine.rst
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_ctmrg_routine:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.ctmrg
|
| 4 |
+
|
| 5 |
+
Calculate the new converged CTMRG tensors (:func:`varipeps.ctmrg.calc_ctmrg_env` and :func:`varipeps.ctmrg.calc_ctmrg_env_custom_rule`)
|
| 6 |
+
=======================================================================================================================================
|
| 7 |
+
|
| 8 |
+
.. autofunction:: calc_ctmrg_env
|
| 9 |
+
|
| 10 |
+
.. autofunction:: calc_ctmrg_env_custom_rule
|
data/docs/source/api/expectation/four_sites.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_expectation_four_sites:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.expectation.four_sites
|
| 4 |
+
|
| 5 |
+
Calculation of four sites expectation values
|
| 6 |
+
============================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.expectation.four_sites
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/expectation/index.rst
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_expectation:
|
| 2 |
+
|
| 3 |
+
.. py:module:: varipeps.expectation
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.expectation
|
| 6 |
+
|
| 7 |
+
Calculation of expectation values (:mod:`varipeps.expectation`)
|
| 8 |
+
===============================================================
|
| 9 |
+
|
| 10 |
+
.. toctree::
|
| 11 |
+
:maxdepth: 2
|
| 12 |
+
|
| 13 |
+
model
|
| 14 |
+
one_site
|
| 15 |
+
two_sites
|
| 16 |
+
three_sites
|
| 17 |
+
four_sites
|
| 18 |
+
spiral_helpers
|
| 19 |
+
|
| 20 |
+
.. automodule:: varipeps.expectation
|
| 21 |
+
:members:
|
| 22 |
+
:undoc-members:
|
| 23 |
+
:show-inheritance:
|
| 24 |
+
:noindex:
|
data/docs/source/api/expectation/model.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_expectation_model:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.expectation.model
|
| 4 |
+
|
| 5 |
+
Model of general expectation value calculation
|
| 6 |
+
==============================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.expectation.model
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/expectation/one_site.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_expectation_one_site:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.expectation.one_site
|
| 4 |
+
|
| 5 |
+
Calculation of one site expectation values
|
| 6 |
+
==========================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.expectation.one_site
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/expectation/spiral_helpers.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_expectation_spiral_helpers:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.expectation.spiral_helpers
|
| 4 |
+
|
| 5 |
+
Helper functions for spiral iPEPS ansatz
|
| 6 |
+
========================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.expectation.spiral_helpers
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/expectation/three_sites.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_expectation_three_sites:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.expectation.three_sites
|
| 4 |
+
|
| 5 |
+
Calculation of three sites expectation values
|
| 6 |
+
=============================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.expectation.three_sites
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/expectation/two_sites.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_expectation_two_sites:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.expectation.two_sites
|
| 4 |
+
|
| 5 |
+
Calculation of two sites expectation values
|
| 6 |
+
===========================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.expectation.two_sites
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/index.rst
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _api:
|
| 2 |
+
|
| 3 |
+
.. module:: varipeps
|
| 4 |
+
|
| 5 |
+
######################
|
| 6 |
+
variPEPS API reference
|
| 7 |
+
######################
|
| 8 |
+
|
| 9 |
+
This reference documents the public API of the :mod:`varipeps` module. The API
|
| 10 |
+
documentation is automatically generated from the source code of the
|
| 11 |
+
:obj:`varipeps` library and is therefore licensed under the
|
| 12 |
+
:ref:`license_gpl_3`.
|
| 13 |
+
|
| 14 |
+
.. toctree::
|
| 15 |
+
:maxdepth: 2
|
| 16 |
+
|
| 17 |
+
config
|
| 18 |
+
contractions/index
|
| 19 |
+
ctmrg/index
|
| 20 |
+
expectation/index
|
| 21 |
+
mapping/index
|
| 22 |
+
optimization/index
|
| 23 |
+
peps/index
|
| 24 |
+
typing
|
| 25 |
+
utils/index
|
data/docs/source/api/mapping/florett_pentagon.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_mapping_florett_pentagon:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.mapping.florett_pentagon
|
| 4 |
+
|
| 5 |
+
Mapping of Floret-Pentagon structures (:mod:`varipeps.mapping.florett_pentagon`)
|
| 6 |
+
================================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.mapping.florett_pentagon
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/mapping/honeycomb.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_mapping_honeycomb:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.mapping.honeycomb
|
| 4 |
+
|
| 5 |
+
Mapping of Honeycomb structures (:mod:`varipeps.mapping.honeycomb`)
|
| 6 |
+
===================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.mapping.honeycomb
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/mapping/index.rst
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_mapping:
|
| 2 |
+
|
| 3 |
+
.. py:module:: varipeps.mapping
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.mapping
|
| 6 |
+
|
| 7 |
+
Mapping of other structures to PEPS unitcells (:mod:`varipeps.mapping`)
|
| 8 |
+
=======================================================================
|
| 9 |
+
|
| 10 |
+
.. toctree::
|
| 11 |
+
:maxdepth: 2
|
| 12 |
+
|
| 13 |
+
florett_pentagon
|
| 14 |
+
honeycomb
|
| 15 |
+
kagome
|
| 16 |
+
maple_leaf
|
| 17 |
+
square_kagome
|
| 18 |
+
triangular
|
| 19 |
+
|
| 20 |
+
.. automodule:: varipeps.mapping
|
| 21 |
+
:members:
|
| 22 |
+
:undoc-members:
|
| 23 |
+
:show-inheritance:
|
| 24 |
+
:noindex:
|
data/docs/source/api/mapping/kagome.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_mapping_kagome:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.mapping.kagome
|
| 4 |
+
|
| 5 |
+
Mapping of Kagome structures (:mod:`varipeps.mapping.kagome`)
|
| 6 |
+
=============================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.mapping.kagome
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/mapping/maple_leaf.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_mapping_maple_leaf:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.mapping.maple_leaf
|
| 4 |
+
|
| 5 |
+
Mapping of Maple leaf structures (:mod:`varipeps.mapping.maple_leaf`)
|
| 6 |
+
=====================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.mapping.maple_leaf
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/mapping/square_kagome.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_mapping_square_kagome:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.mapping.square_kagome
|
| 4 |
+
|
| 5 |
+
Mapping of Square-Kagome structures (:mod:`varipeps.mapping.square_kagome`)
|
| 6 |
+
===========================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.mapping.square_kagome
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/mapping/triangular.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_mapping_triangular:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.mapping.triangular
|
| 4 |
+
|
| 5 |
+
Mapping of Triangular structures (:mod:`varipeps.mapping.triangular`)
|
| 6 |
+
=====================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.mapping.triangular
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __call__
|
data/docs/source/api/optimization/basinhopping.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_optimization_basinhopping:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.optimization.basinhopping
|
| 4 |
+
|
| 5 |
+
Implementation of the basinhopping optimizer for the PEPS model (:mod:`varipeps.optimization.basinhopping`)
|
| 6 |
+
===========================================================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.optimization.basinhopping
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
data/docs/source/api/optimization/index.rst
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_optimization:
|
| 2 |
+
|
| 3 |
+
.. py:module:: varipeps.optimization
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.optimization
|
| 6 |
+
|
| 7 |
+
Variational optimizer for the PEPS network (:mod:`varipeps.optimization`)
|
| 8 |
+
=========================================================================
|
| 9 |
+
|
| 10 |
+
.. toctree::
|
| 11 |
+
:maxdepth: 2
|
| 12 |
+
|
| 13 |
+
basinhopping
|
| 14 |
+
inner_function
|
| 15 |
+
line_search
|
| 16 |
+
optimizer
|
| 17 |
+
|
| 18 |
+
.. automodule:: varipeps.optimization
|
| 19 |
+
:members:
|
| 20 |
+
:undoc-members:
|
| 21 |
+
:show-inheritance:
|
| 22 |
+
:noindex:
|
data/docs/source/api/optimization/inner_function.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_optimization_inner_function:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.optimization.inner_function
|
| 4 |
+
|
| 5 |
+
Methods to calculate the CTRMG env and expectation value along with the gradient (:mod:`varipeps.optimization.inner_function`)
|
| 6 |
+
==============================================================================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.optimization.inner_function
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
data/docs/source/api/optimization/line_search.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_optimization_line_search:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.optimization.line_search
|
| 4 |
+
|
| 5 |
+
Implementation of line search methods for the CTMRG variational optimization (:mod:`varipeps.optimization.line_search`)
|
| 6 |
+
=======================================================================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.optimization.line_search
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
data/docs/source/api/optimization/optimizer.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_optimization_optimizer:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.optimization.optimizer
|
| 4 |
+
|
| 5 |
+
Implementation of the variational optimizer for the PEPS model (:mod:`varipeps.optimization.optimizer`)
|
| 6 |
+
=======================================================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.optimization.optimizer
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
data/docs/source/api/peps/index.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_peps:
|
| 2 |
+
|
| 3 |
+
.. py:module:: varipeps.peps
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.peps
|
| 6 |
+
|
| 7 |
+
Implementation of PEPS structure (:mod:`varipeps.peps`)
|
| 8 |
+
=======================================================
|
| 9 |
+
|
| 10 |
+
.. toctree::
|
| 11 |
+
:maxdepth: 2
|
| 12 |
+
|
| 13 |
+
tensor
|
| 14 |
+
unitcell
|
data/docs/source/api/peps/tensor.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_peps_tensor:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.peps
|
| 4 |
+
|
| 5 |
+
Single PEPS tensor (:class:`varipeps.peps.PEPS_Tensor`)
|
| 6 |
+
=======================================================
|
| 7 |
+
|
| 8 |
+
.. autoclass:: PEPS_Tensor
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
| 12 |
+
:special-members: __add__
|
data/docs/source/api/peps/unitcell.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_peps_unit_cell:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.peps
|
| 4 |
+
|
| 5 |
+
PEPS Unit cell (:class:`varipeps.peps.PEPS_Unit_Cell`)
|
| 6 |
+
======================================================
|
| 7 |
+
|
| 8 |
+
.. autoclass:: PEPS_Unit_Cell
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:special-members: __getitem__
|
| 12 |
+
:show-inheritance:
|
data/docs/source/api/typing.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_typing:
|
| 2 |
+
|
| 3 |
+
.. py:module:: varipeps.typing
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.typing
|
| 6 |
+
|
| 7 |
+
Typing helper (:mod:`varipeps.typing`)
|
| 8 |
+
======================================
|
| 9 |
+
|
| 10 |
+
.. automodule:: varipeps.typing
|
| 11 |
+
:members:
|
| 12 |
+
:undoc-members:
|
| 13 |
+
:show-inheritance:
|
| 14 |
+
:noindex:
|
data/docs/source/api/utils/debug_print.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_utils_debug_print:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.utils.debug_print
|
| 4 |
+
|
| 5 |
+
Debugging output helpers (:mod:`varipeps.utils.debug_print`)
|
| 6 |
+
============================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.utils.debug_print
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
data/docs/source/api/utils/index.rst
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_utils:
|
| 2 |
+
|
| 3 |
+
.. py:module:: varipeps.utils
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.utils
|
| 6 |
+
|
| 7 |
+
Utility functions (:mod:`varipeps.utils`)
|
| 8 |
+
=========================================
|
| 9 |
+
|
| 10 |
+
.. toctree::
|
| 11 |
+
:maxdepth: 2
|
| 12 |
+
|
| 13 |
+
debug_print
|
| 14 |
+
periodic_indices
|
| 15 |
+
projector_dict
|
| 16 |
+
random
|
| 17 |
+
svd
|
| 18 |
+
|
| 19 |
+
.. automodule:: varipeps.utils
|
| 20 |
+
:members:
|
| 21 |
+
:undoc-members:
|
| 22 |
+
:show-inheritance:
|
| 23 |
+
:noindex:
|
data/docs/source/api/utils/periodic_indices.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_utils_periodic_indices:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.utils.periodic_indices
|
| 4 |
+
|
| 5 |
+
Helper to calculate perodic indices (:mod:`varipeps.utils.periodic_indices`)
|
| 6 |
+
============================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.utils.periodic_indices
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
data/docs/source/api/utils/projector_dict.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_utils_projector_dict:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.utils.projector_dict
|
| 4 |
+
|
| 5 |
+
CTM projector management helpers (:mod:`varipeps.utils.projector_dict`)
|
| 6 |
+
=======================================================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.utils.projector_dict
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
data/docs/source/api/utils/random.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_utils_random:
|
| 2 |
+
|
| 3 |
+
.. py:module:: varipeps.utils.random
|
| 4 |
+
|
| 5 |
+
.. currentmodule:: varipeps.utils.random
|
| 6 |
+
|
| 7 |
+
Random number helpers (:mod:`varipeps.utils.random`)
|
| 8 |
+
====================================================
|
| 9 |
+
|
| 10 |
+
.. automodule:: varipeps.utils.random
|
| 11 |
+
:members:
|
| 12 |
+
:undoc-members:
|
| 13 |
+
:show-inheritance:
|
| 14 |
+
:noindex:
|
data/docs/source/api/utils/svd.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _varipeps_utils_svd:
|
| 2 |
+
|
| 3 |
+
.. currentmodule:: varipeps.utils.svd
|
| 4 |
+
|
| 5 |
+
SVD helpers (:mod:`varipeps.utils.svd`)
|
| 6 |
+
=======================================
|
| 7 |
+
|
| 8 |
+
.. automodule:: varipeps.utils.svd
|
| 9 |
+
:members:
|
| 10 |
+
:undoc-members:
|
| 11 |
+
:show-inheritance:
|
data/docs/source/conf.py
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Configuration file for the Sphinx documentation builder.
|
| 2 |
+
#
|
| 3 |
+
# This file only contains a selection of the most common options. For a full
|
| 4 |
+
# list see the documentation:
|
| 5 |
+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
| 6 |
+
|
| 7 |
+
# -- Path setup --------------------------------------------------------------
|
| 8 |
+
|
| 9 |
+
# If extensions (or modules to document with autodoc) are in another directory,
|
| 10 |
+
# add these directories to sys.path here. If the directory is relative to the
|
| 11 |
+
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
| 12 |
+
#
|
| 13 |
+
import os
|
| 14 |
+
import sys
|
| 15 |
+
import importlib
|
| 16 |
+
import importlib.metadata
|
| 17 |
+
import inspect
|
| 18 |
+
|
| 19 |
+
sys.path.insert(0, os.path.abspath(".."))
|
| 20 |
+
|
| 21 |
+
|
| 22 |
+
# -- Project information -----------------------------------------------------
|
| 23 |
+
|
| 24 |
+
project = "varipeps"
|
| 25 |
+
copyright = "2021-2026, Jan Naumann, Philipp Schmoll, Roberto Losada, Frederik Wilde, Finn Krein"
|
| 26 |
+
author = "Jan Naumann, Philipp Schmoll, Roberto Losada, Frederik Wilde, Finn Krein"
|
| 27 |
+
|
| 28 |
+
# The full version, including alpha/beta/rc tags
|
| 29 |
+
release = importlib.metadata.version("varipeps")
|
| 30 |
+
|
| 31 |
+
|
| 32 |
+
# -- General configuration ---------------------------------------------------
|
| 33 |
+
|
| 34 |
+
# Add any Sphinx extension module names here, as strings. They can be
|
| 35 |
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
| 36 |
+
# ones.
|
| 37 |
+
extensions = [
|
| 38 |
+
"sphinx.ext.autodoc",
|
| 39 |
+
"sphinx.ext.autosummary",
|
| 40 |
+
"sphinx.ext.linkcode",
|
| 41 |
+
"sphinx.ext.mathjax",
|
| 42 |
+
"sphinx.ext.napoleon",
|
| 43 |
+
"sphinx.ext.intersphinx",
|
| 44 |
+
"sphinx_autodoc_defaultargs",
|
| 45 |
+
"sphinx_subfigure",
|
| 46 |
+
]
|
| 47 |
+
|
| 48 |
+
napoleon_include_private_with_doc = True
|
| 49 |
+
napoleon_preprocess_types = False
|
| 50 |
+
|
| 51 |
+
autodoc_type_aliases = {
|
| 52 |
+
"T_PEPS_Unit_Cell": "PEPS_Unit_Cell",
|
| 53 |
+
"T_PEPS_Tensor": "PEPS_Tensor",
|
| 54 |
+
"PEPS_Unit_Cell.Unit_Cell_Data": "varipeps.peps.PEPS_Unit_Cell.Unit_Cell_Data",
|
| 55 |
+
"jax._src.numpy.lax_numpy.ndarray": "jax.numpy.ndarray",
|
| 56 |
+
"h5py._hl.group.Group": "h5py.Group",
|
| 57 |
+
}
|
| 58 |
+
|
| 59 |
+
# autodoc_mock_imports = ["jax"]
|
| 60 |
+
|
| 61 |
+
intersphinx_mapping = {
|
| 62 |
+
"python": ("https://docs.python.org/3", None),
|
| 63 |
+
"jax": ("https://jax.readthedocs.io/en/latest/", None),
|
| 64 |
+
"numpy": ("https://numpy.org/doc/stable/", None),
|
| 65 |
+
"scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
|
| 66 |
+
"h5py": ("https://docs.h5py.org/en/stable/", None),
|
| 67 |
+
}
|
| 68 |
+
|
| 69 |
+
# Add any paths that contain templates here, relative to this directory.
|
| 70 |
+
templates_path = ["_templates"]
|
| 71 |
+
|
| 72 |
+
# List of patterns, relative to source directory, that match files and
|
| 73 |
+
# directories to ignore when looking for source files.
|
| 74 |
+
# This pattern also affects html_static_path and html_extra_path.
|
| 75 |
+
exclude_patterns = []
|
| 76 |
+
|
| 77 |
+
from varipeps import git_commit, git_tag
|
| 78 |
+
|
| 79 |
+
code_url = "https://github.com/variPEPS/variPEPS_Python/blob/{blob}"
|
| 80 |
+
|
| 81 |
+
if git_tag is not None:
|
| 82 |
+
code_url = code_url.format(blob=git_tag)
|
| 83 |
+
elif git_commit is not None:
|
| 84 |
+
code_url = code_url.format(blob=git_commit)
|
| 85 |
+
else:
|
| 86 |
+
code_url = code_url.format(blob=release)
|
| 87 |
+
|
| 88 |
+
|
| 89 |
+
def linkcode_resolve(domain, info):
|
| 90 |
+
# Code adapted from function in websockets module
|
| 91 |
+
# https://github.com/python-websockets/websockets/blob/e217458ef8b692e45ca6f66c5aeb7fad0aee97ee/docs/conf.py
|
| 92 |
+
|
| 93 |
+
if domain != "py":
|
| 94 |
+
return None
|
| 95 |
+
if not info["module"]:
|
| 96 |
+
return None
|
| 97 |
+
|
| 98 |
+
mod = importlib.import_module(info["module"])
|
| 99 |
+
if "." in info["fullname"]:
|
| 100 |
+
objname_parts = info["fullname"].split(".")
|
| 101 |
+
|
| 102 |
+
obj = getattr(mod, objname_parts[0])
|
| 103 |
+
|
| 104 |
+
for name in objname_parts[1:-1]:
|
| 105 |
+
obj = getattr(obj, name)
|
| 106 |
+
|
| 107 |
+
attrname = objname_parts[-1]
|
| 108 |
+
|
| 109 |
+
try:
|
| 110 |
+
# object is a method of a class
|
| 111 |
+
obj = getattr(obj, attrname)
|
| 112 |
+
except AttributeError:
|
| 113 |
+
# object is an attribute of a class
|
| 114 |
+
return None
|
| 115 |
+
else:
|
| 116 |
+
obj = getattr(mod, info["fullname"])
|
| 117 |
+
|
| 118 |
+
try:
|
| 119 |
+
filename = inspect.getsourcefile(obj)
|
| 120 |
+
lines = inspect.getsourcelines(obj)
|
| 121 |
+
except (TypeError, OSError):
|
| 122 |
+
# e.g. object is a typing.Union
|
| 123 |
+
return None
|
| 124 |
+
|
| 125 |
+
filename = os.path.relpath(filename, os.path.abspath("../.."))
|
| 126 |
+
|
| 127 |
+
if not filename.startswith("varipeps"):
|
| 128 |
+
# e.g. object is a typing.NewType
|
| 129 |
+
return None
|
| 130 |
+
start, end = lines[1], lines[1] + len(lines[0]) - 1
|
| 131 |
+
|
| 132 |
+
return f"{code_url}/{filename}#L{start}-L{end}"
|
| 133 |
+
|
| 134 |
+
|
| 135 |
+
# -- Options for HTML output -------------------------------------------------
|
| 136 |
+
|
| 137 |
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
| 138 |
+
# a list of builtin themes.
|
| 139 |
+
#
|
| 140 |
+
html_theme = "sphinx_rtd_theme"
|
| 141 |
+
|
| 142 |
+
# Add any paths that contain custom static files (such as style sheets) here,
|
| 143 |
+
# relative to this directory. They are copied after the builtin static files,
|
| 144 |
+
# so a file named "default.css" will overwrite the builtin "default.css".
|
| 145 |
+
html_static_path = ["_static"]
|
| 146 |
+
|
| 147 |
+
html_logo = "images/logo.svg"
|
| 148 |
+
html_favicon = "images/favicon/favicon.svg"
|
| 149 |
+
|
| 150 |
+
html_theme_options = {
|
| 151 |
+
'logo_only': True,
|
| 152 |
+
}
|
| 153 |
+
|
| 154 |
+
rst_prolog = """
|
| 155 |
+
.. |default| raw:: html
|
| 156 |
+
|
| 157 |
+
<div class="default-value-section"> <span class="default-value-label">Default:</span>"""
|
| 158 |
+
|
| 159 |
+
numfig = True
|