add ttn tutorial

shuaigroup · Jul 2, 2024 · ec0e361 · ec0e361
1 parent 94747e0
commit ec0e361
Show file tree

Hide file tree

Showing 11 changed files with 1,169 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -16,14 +16,14 @@ For users who are not familiar with python,
 please check out the step-by-step [installation guide](https://shuaigroup.github.io/Renormalizer/install.html).
 
 # Features
-- MPS/MPO based ground state search/excited state search/time evolution/dynamical properties
-- TTNS/TTNO based ground state search/time evolution
-- Custom Hamiltonian through automatic MPO/TTNO construction
-- Finite temperature time evolution through imaginary time evolution or thermofield transformation
-- Out-of-box molecular spectra/carrier mobility/spin relaxation dynamics/ab initio calculation.
-- GPU acceleration via CuPy
-- Quantum number conservation
-- Purely Python based and easy installation
+- 🚂 MPS/MPO based ground state search/excited state search/time evolution/dynamical properties. 
+- 🌲 TTNS/TTNO based ground state search/time evolution. 
+- ⚙️Custom Hamiltonian through automatic MPO/TTNO construction. 
+- 🌡️ Finite temperature time evolution through imaginary time evolution or thermofield transformation. 
+- 🧪 Out-of-box molecular spectra/carrier mobility/spin relaxation dynamics/ab initio calculation
+- 🏃 GPU acceleration via CuPy. 
+- ⚖️ Quantum number conservation
+- 🐍 Purely Python based and easy installation
 
 # Documentation
 Please check out the [official documentation](https://shuaigroup.github.io/Renormalizer/)

diff --git a/doc/source/api.rst b/doc/source/api.rst
@@ -11,4 +11,5 @@ API Reference
    ct.rst
    cv.rst
    sbm.rst
+   ttn.rst
    configs.rst
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -189,4 +189,4 @@
 # -- Google Analytics -----------------------------------------------------
 if os.getenv("GITHUB_ACTIONS"):
   extensions.append("sphinxcontrib.googleanalytics")
-  googleanalytics_id = "G-VMR8V3W3BR"
+  googleanalytics_id = "G-3HTENNM8CV"
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -16,14 +16,14 @@ Its source code is hosted on `GitHub <https://github.com/shuaigroup/Renormalizer
 Features
 ===========
 
-* MPS/MPO based ground state search/excited state search/time evolution/dynamical properties
-* TTNS/TTNO based ground state search/time evolution
-* Custom Hamiltonian through automatic MPO/TTNO construction
-* Finite temperature time evolution through imaginary time evolution or thermofield transformation
-* Out-of-box molecular spectra/carrier mobility/spin relaxation dynamics/ab initio calculation
-* GPU acceleration via CuPy
-* Quantum number conservation
-* Purely Python based and easy installation
+* 🚂 MPS/MPO based ground state search/excited state search/time evolution/dynamical properties.
+* 🌲 TTNS/TTNO based ground state search/time evolution.
+* ⚙️Custom Hamiltonian through automatic MPO/TTNO construction.
+* 🌡️ Finite temperature time evolution through imaginary time evolution or thermofield transformation.
+* 🧪 Out-of-box molecular spectra/carrier mobility/spin relaxation dynamics/ab initio calculation
+* 🏃 GPU acceleration via CuPy.
+* ⚖️ Quantum number conservation
+* 🐍 Purely Python based and easy installation
 
 
 Contents

diff --git a/doc/source/ttn.rst b/doc/source/ttn.rst
@@ -0,0 +1,12 @@
+Tree Tensor Network Algorithms
+***************************************
+
+The Basis Tree
+==========================
+.. autoclass:: renormalizer.tn.TreeNodeBasis
+    :members:
+    :inherited-members:
+
+.. autoclass:: renormalizer.tn.BasisTree
+    :members:
+    :inherited-members:
diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst
@@ -9,6 +9,7 @@ please refer to the :doc:`applications`.
     tutorials/define_model.ipynb
     tutorials/mps_mpo.ipynb
     tutorials/compress_mps.ipynb
+    tutorials/ttn_basic.ipynb
 
 ..
     setting quantum number