Merge branch 'dev' into qmortier

docs/requirements.txt

@@ -1,4 +1,4 @@
-sphinx==4.5.0
+sphinx==5.0.2
 sphinx-rtd-theme==0.5.2
 sphinxcontrib-matlabdomain==0.18.0
 sphinx-prompt==1.5.0

docs/src/img/ipe/conv.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+for i in *.pdf
+do
+    pdf2svg ${i%.*}.pdf ../${i%.*}.svg all
+done

docs/src/index.rst

@@ -16,9 +16,9 @@ Additionally, for tensors which are invariant under general global symmetries, v
    :caption: Manual
    :maxdepth: 2
 
-   man/intro
    man/tensor
    man/symmetries
+   man/algorithms
 
 
 .. toctree::
@@ -33,5 +33,10 @@ Additionally, for tensors which are invariant under general global symmetries, v
    :maxdepth: 2
 
    lib/tensors
+   lib/sparse
+   lib/mps
+   lib/environments
+   lib/algorithms
+   lib/models
    lib/utility
    lib/caches

docs/src/lib/algorithms.rst

@@ -0,0 +1,50 @@
+Algorithms
+==========
+
+.. toctree::
+   :maxdepth: 2
+
+.. module:: src
+
+This section contains the API documentation for the :mod:`.algorithms` module.
+
+Finite MPS algorithms
+---------------------
+
+.. autoclass:: src.algorithms.Dmrg
+    :no-members:
+    :members: fixedpoint
+
+
+Infinite MPS algorithms
+-----------------------
+
+.. autoclass:: src.algorithms.Vumps
+    :no-members:
+    :members: fixedpoint
+
+.. autoclass:: src.algorithms.IDmrg
+    :no-members:
+    :members: fixedpoint
+
+.. autoclass:: src.algorithms.IDmrg2
+    :no-members:
+    :members: fixedpoint
+
+.. autoclass:: src.algorithms.QPAnsatz
+    :no-members:
+    :members: excitations
+
+.. autoclass:: src.algorithms.Vomps
+    :no-members:
+    :members: approximate
+
+.. autoclass:: src.algorithms.Expand
+    :no-members:
+    :members: changebonds
+
+
+Eigsolvers
+----------
+
+.. automodule:: src.algorithms.eigsolvers

docs/src/lib/caches.rst

@@ -10,8 +10,8 @@ This section contains the API documentation for the :mod:`.caches` module.
 
 .. automodule:: src.caches
 
+
 GetMD5
 ------
 
 .. automodule:: src.caches.GetMD5
-

docs/src/lib/environments.rst

@@ -0,0 +1,12 @@
+Environments
+============
+
+.. toctree::
+   :maxdepth: 2
+
+.. module:: src
+
+This section contains the API documentation for the :mod:`.environments` module.
+
+.. autoclass:: src.environments.FiniteEnvironment
+

docs/src/lib/models.rst

@@ -0,0 +1,39 @@
+Models
+======
+
+.. toctree::
+   :maxdepth: 2
+
+.. module:: src
+
+This section contains the API documentation for the :mod:`.models` module.
+
+.. Operators
+.. ---------
+
+.. Spin operators
+.. ``````````````
+
+.. .. autofunction:: src.models.spinoperators.sigma_min
+.. .. autofunction:: src.models.spinoperators.sigma_plus
+.. .. autofunction:: src.models.spinoperators.sigma_z
+.. .. autofunction:: src.models.spinoperators.sigma_exhange
+
+
+.. Fermion operators
+.. `````````````````
+
+.. .. autofunction:: src.models.fermionoperators.c_min
+.. .. autofunction:: src.models.fermionoperators.c_plus
+.. .. autofunction:: src.models.fermionoperators.c_number
+
+
+.. Models
+.. ------
+
+.. autofunction:: src.models.quantum1dIsing
+.. autofunction:: src.models.quantum1dHeisenberg
+.. autofunction:: src.models.quantum1dHubbard
+
+.. autofunction:: src.models.statmech2dIsing
+

docs/src/lib/mps.rst

@@ -0,0 +1,30 @@
+MPS
+===
+
+.. toctree::
+   :maxdepth: 2
+
+.. module:: src
+
+This section contains the API documentation for the :mod:`.mps` module.
+
+States
+------
+
+.. autoclass:: src.mps.MpsTensor
+.. autoclass:: src.mps.FiniteMps
+    :no-members:
+.. autoclass:: src.mps.UniformMps
+.. autoclass:: src.mps.InfQP
+
+
+Operators
+---------
+
+.. autoclass:: src.mps.MpoTensor
+.. autoclass:: src.mps.FiniteMpo
+.. autoclass:: src.mps.InfMpo
+.. autoclass:: src.mps.InfJMpo
+.. autoclass:: src.mps.PepsTensor
+.. autoclass:: src.mps.PepsSandwich
+    :no-members:

docs/src/lib/sparse.rst

@@ -0,0 +1,12 @@
+Sparse
+======
+
+.. toctree::
+   :maxdepth: 2
+
+.. module:: src
+
+This section contains the API documentation for the :mod:`.sparse` module.
+
+.. autoclass:: src.sparse.SparseTensor
+    :no-members:

docs/src/lib/tensors.rst

@@ -12,7 +12,35 @@ This section contains the API documentation for the :mod:`.tensors` module.
 Symmetry sectors
 ----------------
 
-.. automodule:: src.tensors.charges
+Type hierarchy
+``````````````
+
+.. autoclass::  src.tensors.charges.AbstractCharge
+.. autoclass::  src.tensors.charges.FusionStyle
+.. autoclass::  src.tensors.charges.BraidingStyle
+.. autoclass::  src.tensors.charges.ProductCharge
+
+
+Concrete charge types
+`````````````````````
+
+.. autoclass:: src.tensors.charges.Z1
+.. autoclass:: src.tensors.charges.Z2
+.. autoclass:: src.tensors.charges.ZN
+.. autoclass:: src.tensors.charges.fZ2
+.. autoclass:: src.tensors.charges.U1
+.. autoclass:: src.tensors.charges.fU1
+.. autoclass:: src.tensors.charges.SU2
+.. autoclass:: src.tensors.charges.fSU2
+.. autoclass:: src.tensors.charges.SUN
+.. autoclass:: src.tensors.charges.O2
+.. autoclass:: src.tensors.charges.A4
+
+
+Helper routines
+```````````````
+
+.. autoclass:: src.tensors.charges.GtPattern
 
 
 Fusion trees
@@ -24,16 +52,49 @@ Fusion trees
 Spaces
 ------
 
-.. automodule:: src.tensors.spaces
+Type hierarchy
+``````````````
+
+.. autoclass::  src.tensors.spaces.AbstractSpace
+.. autoclass::  src.tensors.spaces.SumSpace
+
+
+Concrete space types
+````````````````````
+
+.. autoclass::  src.tensors.spaces.CartesianSpace
+.. autoclass::  src.tensors.spaces.ComplexSpace
+.. autoclass::  src.tensors.spaces.GradedSpace
+
+
+Convenience constructor wrappers
+````````````````````````````````
+
+.. autofunction::  src.tensors.spaces.Z2Space
+.. autofunction::  src.tensors.spaces.fZ2Space
+.. autofunction::  src.tensors.spaces.U1Space
+.. autofunction::  src.tensors.spaces.SU2Space
+
+Helper classes
+``````````````
+
+.. autoclass::  src.tensors.spaces.Arrow
 
 
 Kernels
 -------
 
-.. automodule:: src.tensors.kernels
+.. autoclass:: src.tensors.kernels.AbstractBlock
+.. autoclass:: src.tensors.kernels.TrivialBlock
+   :no-members:
+.. autoclass:: src.tensors.kernels.MatrixBlock
+   :no-members:
+.. autoclass:: src.tensors.kernels.AbelianBlock
+   :no-members:
 
 
 Tensors
 -------
 
+.. autoclass:: src.tensors.AbstractTensor
 .. autoclass:: src.tensors.Tensor