Skip to content

Commit 12eef42

Browse files
leburgelleburgel
authored
Docs update (#23)
* Have a go at a docs update, start with symmetry sectors docs * Update spaces docs * Update kernels and tensors docs * Update tensor docs, set up doc stubs for other modules. * Relax `linsolve` test in case of stagnation * Address review comments
1 parent 379c417 commit 12eef42

File tree

129 files changed

+2927
-1450
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

129 files changed

+2927
-1450
lines changed

‎docs/src/img/Fmove.svg

+143-184
Loading

‎docs/src/img/Rmove.svg

+95-95
Loading

‎docs/src/img/fusiontensor.svg

+30-23
Loading

‎docs/src/img/ipe/Fmove.pdf

1.45 KB
Binary file not shown.

‎docs/src/img/ipe/conv.sh

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/bin/bash
2+
for i in *.pdf
3+
do
4+
pdf2svg ${i%.*}.pdf ../${i%.*}.svg all
5+
done

‎docs/src/index.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Additionally, for tensors which are invariant under general global symmetries, v
1616
:caption: Manual
1717
:maxdepth: 2
1818

19-
man/intro
2019
man/tensor
2120
man/symmetries
21+
man/algorithms
2222

2323

2424
.. toctree::
@@ -33,5 +33,10 @@ Additionally, for tensors which are invariant under general global symmetries, v
3333
:maxdepth: 2
3434

3535
lib/tensors
36+
lib/sparse
37+
lib/mps
38+
lib/environments
39+
lib/algorithms
40+
lib/models
3641
lib/utility
3742
lib/caches

‎docs/src/lib/algorithms.rst

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
Algorithms
2+
==========
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
.. module:: src
8+
9+
This section contains the API documentation for the :mod:`.algorithms` module.
10+
11+
Finite MPS algorithms
12+
---------------------
13+
14+
.. autoclass:: src.algorithms.Dmrg
15+
:no-members:
16+
:members: fixedpoint
17+
18+
19+
Infinite MPS algorithms
20+
-----------------------
21+
22+
.. autoclass:: src.algorithms.Vumps
23+
:no-members:
24+
:members: fixedpoint
25+
26+
.. autoclass:: src.algorithms.IDmrg
27+
:no-members:
28+
:members: fixedpoint
29+
30+
.. autoclass:: src.algorithms.IDmrg2
31+
:no-members:
32+
:members: fixedpoint
33+
34+
.. autoclass:: src.algorithms.QPAnsatz
35+
:no-members:
36+
:members: excitations
37+
38+
.. autoclass:: src.algorithms.Vomps
39+
:no-members:
40+
:members: approximate
41+
42+
.. autoclass:: src.algorithms.Expand
43+
:no-members:
44+
:members: changebonds
45+
46+
47+
Eigsolvers
48+
----------
49+
50+
.. automodule:: src.algorithms.eigsolvers

‎docs/src/lib/caches.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ This section contains the API documentation for the :mod:`.caches` module.
1010

1111
.. automodule:: src.caches
1212

13+
1314
GetMD5
1415
------
1516

1617
.. automodule:: src.caches.GetMD5
17-

‎docs/src/lib/environments.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Environments
2+
============
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
.. module:: src
8+
9+
This section contains the API documentation for the :mod:`.environments` module.
10+
11+
.. autoclass:: src.environments.FiniteEnvironment
12+

‎docs/src/lib/models.rst

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Models
2+
======
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
.. module:: src
8+
9+
This section contains the API documentation for the :mod:`.models` module.
10+
11+
.. Operators
12+
.. ---------
13+
14+
.. Spin operators
15+
.. ``````````````
16+
17+
.. .. autofunction:: src.models.spinoperators.sigma_min
18+
.. .. autofunction:: src.models.spinoperators.sigma_plus
19+
.. .. autofunction:: src.models.spinoperators.sigma_z
20+
.. .. autofunction:: src.models.spinoperators.sigma_exhange
21+
22+
23+
.. Fermion operators
24+
.. `````````````````
25+
26+
.. .. autofunction:: src.models.fermionoperators.c_min
27+
.. .. autofunction:: src.models.fermionoperators.c_plus
28+
.. .. autofunction:: src.models.fermionoperators.c_number
29+
30+
31+
.. Models
32+
.. ------
33+
34+
.. autofunction:: src.models.quantum1dIsing
35+
.. autofunction:: src.models.quantum1dHeisenberg
36+
.. autofunction:: src.models.quantum1dHubbard
37+
38+
.. autofunction:: src.models.statmech2dIsing
39+

‎docs/src/lib/mps.rst

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
MPS
2+
===
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
.. module:: src
8+
9+
This section contains the API documentation for the :mod:`.mps` module.
10+
11+
States
12+
------
13+
14+
.. autoclass:: src.mps.MpsTensor
15+
.. autoclass:: src.mps.FiniteMps
16+
:no-members:
17+
.. autoclass:: src.mps.UniformMps
18+
.. autoclass:: src.mps.InfQP
19+
20+
21+
Operators
22+
---------
23+
24+
.. autoclass:: src.mps.MpoTensor
25+
.. autoclass:: src.mps.FiniteMpo
26+
.. autoclass:: src.mps.InfMpo
27+
.. autoclass:: src.mps.InfJMpo
28+
.. autoclass:: src.mps.PepsTensor
29+
.. autoclass:: src.mps.PepsSandwich
30+
:no-members:

‎docs/src/lib/sparse.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Sparse
2+
======
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
.. module:: src
8+
9+
This section contains the API documentation for the :mod:`.sparse` module.
10+
11+
.. autoclass:: src.sparse.SparseTensor
12+
:no-members:

‎docs/src/lib/tensors.rst

+64-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,35 @@ This section contains the API documentation for the :mod:`.tensors` module.
1212
Symmetry sectors
1313
----------------
1414

15-
.. automodule:: src.tensors.charges
15+
Type hierarchy
16+
``````````````
17+
18+
.. autoclass:: src.tensors.charges.AbstractCharge
19+
.. autoclass:: src.tensors.charges.FusionStyle
20+
.. autoclass:: src.tensors.charges.BraidingStyle
21+
.. autoclass:: src.tensors.charges.ProductCharge
22+
23+
24+
Concrete charge types
25+
`````````````````````
26+
27+
.. autoclass:: src.tensors.charges.Z1
28+
.. autoclass:: src.tensors.charges.Z2
29+
.. autoclass:: src.tensors.charges.ZN
30+
.. autoclass:: src.tensors.charges.fZ2
31+
.. autoclass:: src.tensors.charges.U1
32+
.. autoclass:: src.tensors.charges.fU1
33+
.. autoclass:: src.tensors.charges.SU2
34+
.. autoclass:: src.tensors.charges.fSU2
35+
.. autoclass:: src.tensors.charges.SUN
36+
.. autoclass:: src.tensors.charges.O2
37+
.. autoclass:: src.tensors.charges.A4
38+
39+
40+
Helper routines
41+
```````````````
42+
43+
.. autoclass:: src.tensors.charges.GtPattern
1644

1745

1846
Fusion trees
@@ -24,16 +52,49 @@ Fusion trees
2452
Spaces
2553
------
2654

27-
.. automodule:: src.tensors.spaces
55+
Type hierarchy
56+
``````````````
57+
58+
.. autoclass:: src.tensors.spaces.AbstractSpace
59+
.. autoclass:: src.tensors.spaces.SumSpace
60+
61+
62+
Concrete space types
63+
````````````````````
64+
65+
.. autoclass:: src.tensors.spaces.CartesianSpace
66+
.. autoclass:: src.tensors.spaces.ComplexSpace
67+
.. autoclass:: src.tensors.spaces.GradedSpace
68+
69+
70+
Convenience constructor wrappers
71+
````````````````````````````````
72+
73+
.. autofunction:: src.tensors.spaces.Z2Space
74+
.. autofunction:: src.tensors.spaces.fZ2Space
75+
.. autofunction:: src.tensors.spaces.U1Space
76+
.. autofunction:: src.tensors.spaces.SU2Space
77+
78+
Helper classes
79+
``````````````
80+
81+
.. autoclass:: src.tensors.spaces.Arrow
2882

2983

3084
Kernels
3185
-------
3286

33-
.. automodule:: src.tensors.kernels
87+
.. autoclass:: src.tensors.kernels.AbstractBlock
88+
.. autoclass:: src.tensors.kernels.TrivialBlock
89+
:no-members:
90+
.. autoclass:: src.tensors.kernels.MatrixBlock
91+
:no-members:
92+
.. autoclass:: src.tensors.kernels.AbelianBlock
93+
:no-members:
3494

3595

3696
Tensors
3797
-------
3898

99+
.. autoclass:: src.tensors.AbstractTensor
39100
.. autoclass:: src.tensors.Tensor

0 commit comments

Comments
 (0)