quantumghent · qmortier · Oct 1, 2022 · Mar 29, 2023 · Mar 4, 2024
diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml
@@ -0,0 +1,3 @@
+ignore:
+  - "src/utility/wigner"
+  - "src/caches/GetMD5"
diff --git a/README.md b/README.md
@@ -2,10 +2,10 @@
 
 <!-- PROJECT SHIELDS -->  
 <div align="center">
-  
-  [![Documentation Status](https://readthedocs.org/projects/tensortrack/badge/?version=stable)](https://tensortrack.readthedocs.io/en/stable/?badge=stable)
+
+  [![Documentation Status](https://readthedocs.org/projects/tensortrack/badge/?version=latest)](https://tensortrack.readthedocs.io/en/latest/?badge=latest)
   [![CI](https://github.com/quantumghent/TensorTrack/actions/workflows/CI.yml/badge.svg)](https://github.com/quantumghent/TensorTrack/actions/workflows/CI.yml)
-  [![Codecov](https://codecov.io/gh/quantumghent/TensorTrack/branch/main/graph/badge.svg?token=1I0XEB69TQ)](https://codecov.io/gh/quantumghent/TensorTrack)
+  [![codecov](https://codecov.io/gh/quantumghent/TensorTrack/graph/badge.svg?token=NdumVqzQuM)](https://codecov.io/gh/quantumghent/TensorTrack)
   [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
   [![DOI](https://zenodo.org/badge/481924253.svg)](https://zenodo.org/badge/latestdoi/481924253)
 
@@ -88,6 +88,7 @@ The design of the algorithms is chosen such that the inclusion of symmetries sho
 This project depends on the following:
 - MATLAB version R2020b or newer
 - [Parallel Computing Toolbox](https://de.mathworks.com/products/parallel-computing.html)
+- [Deep Learning Toolbox](https://de.mathworks.com/products/deep-learning.html)
 - A C++ compiler compatible with your MATLAB version for MEX-file compilation.
 
 ### Installation

diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,3 @@
+ignore:
+  - "src/utility/wigner"
+  - "src/caches/GetMD5"
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,9 +1,8 @@
-sphinx==4.5.0
-sphinx-rtd-theme==0.5.1
-sphinxcontrib-matlabdomain==0.12.0
-sphinx-prompt
+sphinx==5.0.2
+sphinx-rtd-theme==0.5.2
+sphinxcontrib-matlabdomain==0.18.0
+sphinx-prompt==1.5.0
 nbsphinx==0.8.9
 sphinx-gallery==0.10.1
-myst-parser==0.17.2
 linkify-it-py==2.0.0
-
+jinja2==3.0.3
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -11,7 +11,7 @@
 docs_src = os.path.abspath(os.path.dirname(__file__))  # docs source folder
 docs_root = os.path.abspath(os.path.join(docs_src, '..'))  # docs root folder
 repo_root = os.path.abspath(os.path.join(docs_src, '..', '..'))  # repo root folder
-GITHUBBASE = 'https://github.com/lkdvos/TensorTrack'  # repo link
+GITHUBBASE = 'https://github.com/QuantumGhent/TensorTrack'  # repo link
 
 # -- Project information
 
@@ -49,15 +49,14 @@
     'sphinx-prompt',
     'sphinxcontrib.matlab',
     'nbsphinx',
-    'myst_parser',
     'sphinx_gallery.load_style'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
-source_suffix = ['.rst', '.md']
+source_suffix = ['.rst']
 
 # The master toctree document.
 master_doc = 'index'
@@ -67,7 +66,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'default'
@@ -233,24 +232,6 @@ def  linkcode_resolve(domain, info):
     ]
 
 
-# -- myst_parser -----------------------------------------------
-# extensions for markdown parser
-# myst_enable_extensions = [
-#     "colon_fence",
-#     "deflist",
-#     "dollarmath",
-#     "fieldlist",
-#     "html_admonition",
-#     "html_image",
-#     "linkify",
-#     "replacements",
-#     "smartquotes",
-#     "strikethrough",
-#     "substitution",
-#     "tasklist",
-# ]
-
-
 # -- sphinx.ext.mathjax configuration -----------------------------------------------
 mathjax3_config = {
   "tex": {

diff --git a/docs/src/img/Fmove.svg b/docs/src/img/Fmove.svg
diff --git a/docs/src/img/Rmove.svg b/docs/src/img/Rmove.svg
diff --git a/docs/src/img/fusiontensor.svg b/docs/src/img/fusiontensor.svg
diff --git a/docs/src/img/ipe/Fmove.pdf b/docs/src/img/ipe/Fmove.pdf
diff --git a/docs/src/img/ipe/conv.sh b/docs/src/img/ipe/conv.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+for i in *.pdf
+do
+    pdf2svg ${i%.*}.pdf ../${i%.*}.svg all
+done
diff --git a/docs/src/index.rst b/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/algorithms
+   lib/environments
+   lib/models
    lib/utility
    lib/caches
diff --git a/docs/src/lib/algorithms.rst b/docs/src/lib/algorithms.rst
@@ -0,0 +1,59 @@
+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
+
+
+Infinite PEPS algorithms
+------------------------
+
+.. autoclass:: src.algorithms.Ctmrg
+    :no-members:
+    :members: fixedpoint
+
+
+
+Eigsolvers
+----------
+
+.. automodule:: src.algorithms.eigsolvers
diff --git a/docs/src/lib/caches.rst b/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
-
diff --git a/docs/src/lib/environments.rst b/docs/src/lib/environments.rst
@@ -0,0 +1,13 @@
+Environments
+============
+
+.. toctree::
+   :maxdepth: 2
+
+.. module:: src
+
+This section contains the API documentation for the :mod:`.environments` module.
+
+.. autoclass:: src.environments.FiniteEnvironment
+.. autoclass:: src.environments.CtmrgEnvironment
+    :no-members:
diff --git a/docs/src/lib/models.rst b/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
+
-Original file line number
+Diff line change
@@ Expand Up @@
     .. automodule:: src.caches
     GetMD5
     ------
     .. automodule:: src.caches.GetMD5