improve doc

shuaigroup · Jun 26, 2024 · 5962b99 · 5962b99
1 parent e82ca6c
commit 5962b99
Show file tree

Hide file tree

Showing 7 changed files with 822 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ please check out the step-by-step [installation guide](https://shuaigroup.github
 - Out-of-box molecular spectra/carrier mobility/spin relaxation dynamics/ab initio calculation.
 - GPU acceleration via CuPy
 - Quantum number conservation
-- Purely Python based and eazy installation
+- Purely Python based and easy installation
 
 # Documentation
 Please check out the [official documentation](https://shuaigroup.github.io/Renormalizer/)

diff --git a/doc/source/overview.rst → doc/source/cite.rst b/doc/source/overview.rst → doc/source/cite.rst
@@ -1,16 +1,3 @@
-An overview of Renormalizer
-*****************************
-
-Renormalizer is a quantum dynamics package based on density matrix
-renormalization group (DMRG) and its time dependent formulation written in
-Python. All (TD-)DMRG algorithms are implemented within the framework of matrix
-product states (MPS) and matrix product operators (MPO). The package aims to
-provide a powerful and efficient platform for quantum dynamics simulation
-and method development with (TD-)DMRG.  
-The package is still under heavy development. Please refer to our recent papers
-for the new developments.
-
-
 How to cite
 ===========
 If you use Renormalizer in your research, please cite
@@ -53,20 +40,3 @@ Bibtex entry::
       year={2020},
       publisher={ACS Publications}
     }
-
-
-Features
-===========
-
-* Pure matrix product states (MPS) and matrix product operators (MPO) structure.
-* Support any Hamiltonian (operator) with an sum-of-products form.
-* Static state calculation:
-
-    - Ground state.
-    - State-averaged DMRG.
-    - Excited state with Tamm-Dancoff approximation (first order MPS tangent space).
-* Wavefuntion and density matrix time-dependent propagation.
-* Real-time and imaginary-time propagation.
-* Dynamical properties in the time domain and frequency domain.
-* Support GPU acceleration.
-
diff --git a/doc/source/faq.rst b/doc/source/faq.rst
@@ -1,6 +1,10 @@
 Frequently Asked Questions
 **************************
 
+Why so slow?
+============
+TBA
+
 How to build docs and view them locally?
 ========================================
 
@@ -21,3 +25,4 @@ This will setup a HTTP server on the 8000 port.
 You can visit the document via ``http://localhost:8000``
 if the document is built in local host.
 Or you may need to change ``localhost`` to the actual IP of the host where the doc is built.
+
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -2,14 +2,28 @@
 
 Welcome to Renormalizer's documentation!
 ========================================
-Renormalizer is a quantum dynamics package based on density matrix
-renormalization group (DMRG) and its time dependent formulation written in
-Python. All (TD-)DMRG algorithms are implemented within the framework of matrix
-product states (MPS) and matrix product operators (MPO). The package aims to
-provide a powerful and efficient platform for quantum dynamics simulation
-and method development with (TD-)DMRG.
-The package is still under heavy development. Please refer to our recent papers
-for the new developments.
+Renormalizer is a Python based tensor network package with a special focus on electron-phonon quantum dynamics.
+It is originally developed based on matrix product states (MPS) and matrix product operators (MPO)
+and thus the algorithms are called (TD-)DMRG.
+In 2024 tree tensor network states (TTNS) and tree tensor network operators (TTNO) utilities are implemented.
+Renormalizer can routinely perform quantum dynamics calculation involving hundreds to thousands of degrees of freedom
+in a numerically exact manner, sometimes using only a single CPU core.
+
+Renormalizer is developed by [Prof. Zhigang Shuai's group](http://www.shuaigroup.net/index.php).
+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
 
 
 Contents
@@ -19,7 +33,6 @@ Contents
    :maxdepth: 2
    :numbered:
 
-   overview.rst
    install.md
    tutorial.rst
    model.rst
@@ -29,10 +42,10 @@ Contents
    ct.rst
    cv.rst
    configs.rst
-   lib.md
    sbm.md
    faq.rst
    develop.md
+   cite.rst
 
 
 

diff --git a/doc/source/lib.md b/doc/source/lib.md
diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst
@@ -1,11 +1,21 @@
 Tutorial
 ********
 
-You can find tutorial jupyter notebooks below
+The following tutorials will start from a sample calculation for the ground state
+of the Heisenberg model, and then introduce the basic components of Renormalizer.
+
+You can skip to later practical topics if you're not interested in the mechanisms of tensor networks
+and Renormalizer.
 
 .. toctree::
     tutorials/1D-Heisenberg.ipynb
     tutorials/define_model.ipynb
+    tutorials/mps_mpo.ipynb
+
+..
+    compress mps
+    time evolution by hand forward Euler
+    time evolutions in production
 
 Here are some more details about how to use the package