Skip to content

Commit 2cd40db

Browse files
committed
Update documentation
1 parent efd914f commit 2cd40db

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

docs/source/general.rst

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.. _general:
2+
3+
4+
Introduction
5+
============
6+
7+
variPEPS is a Python tensor network library developed for variational ground
8+
state simulations in two spatial dimensions applying gradient optimization using
9+
automatic differentation.
10+
11+
For a detailed report on the method, please see `our open-access publication on
12+
SciPost (doi:10.21468/SciPostPhysLectNotes.86)
13+
<https://doi.org/10.21468/SciPostPhysLectNotes.86>`_.
14+
15+
Installation using pip
16+
======================
17+
18+
The current version of the variPEPS Python package is available on `PyPI
19+
<https://pypi.org/project/variPEPS/>`_. It can be easily installed using the
20+
Python package manager pip:
21+
22+
.. code-block:: console
23+
24+
$ python3 -m pip install variPEPS
25+
26+
Usage
27+
=====
28+
29+
ToDo
30+
31+
Citation
32+
========
33+
34+
We are happy if you want to use the framework for your research. To cite our
35+
work we provide a list of our preferred references on the `GitHub page of the
36+
project
37+
<https://github.com/variPEPS/variPEPS_Python?tab=readme-ov-file#citation>`_. Please
38+
check there for a current list.

docs/source/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ Variational PEPS
33

44
.. toctree::
55
:maxdepth: 2
6-
:caption: Design
6+
:caption: VariPEPS
77

8+
general
89
design/features
910

1011
.. toctree::

0 commit comments

Comments
 (0)