File tree Expand file tree Collapse file tree 1 file changed +22
-1
lines changed Expand file tree Collapse file tree 1 file changed +22
-1
lines changed Original file line number Diff line number Diff line change @@ -26,7 +26,28 @@ Python package manager pip:
2626 Usage
2727=====
2828
29- ToDo
29+ The :obj: `varipeps ` module is organized in several submodules corresponding to
30+ the different features. For a variational optimization the most important parts
31+ are (a full overview can be found in the :ref: `_api `):
32+
33+ * :obj: `varipeps.peps `: To define iPEPS unit cell and the tensors on each site,
34+ the library provides in this submodule the abstractions to define such a unit
35+ cell.
36+ * :obj: `varipeps.expectation `: In this submodule the helper functions to define
37+ and calculate common expecation functions on the iPEPS unit
38+ cell. Particularly, the function can be used to define the Hamiltonian terms
39+ of the model of interest.
40+ * :obj: `varipeps.mapping `: If not only interactions on the square lattice are of
41+ interest but also models on other 2d lattices, in this submodule one can find
42+ mappings of other lattices. Also the files there can be a good starting point
43+ to implement even more lattices.
44+ * :obj: `varipeps.optimization `: The submodule providing the optimization
45+ algorithm and interface of the library. In almost all cases, one will interact
46+ with this part by the main function
47+ :obj: `varipeps.optimization.optimize_peps_network `.
48+
49+ All these different modules can be seen in action in the :ref: `_examples `
50+ section of the documentation where exemplary code is discussed in detail.
3051
3152Citation
3253========
You can’t perform that action at this time.
0 commit comments