Update document

[liwt31]

• Fix the Heisenberg tutorial bug
• Add time evolution page. #143
• Add the FAQ page

update @ 2023.4.8 @jjren

• remove the m_max argument in _update_mps in mp.py. First, because it is duplicated with mps.compress_config. The more important reason is that if we want to adaptively control the bond dimension by truncation threshold in the two-site tdvp-ps or ground state algorithm, the former implementation can not achieve that. (What I haven't modified is OFS algorithm because one loss function depends on m_max, so I added an assertion to make sure the bond dimension is fixed.)

• add scipy ivp solver company to Krylov solver in the tdvp related evolution algorithm. This will make the evolution algorithm suitable for non-Hermitian operators.

• add quadrature in SineDVR basis by using the sympy expression to support more operators. This feature is only experimental, not fully tested.

• bump up dependencies (numpy, scipy) in requirement.txt

[liwt31]

I may work on the tutorial module while you finish the time evolution part. @jjren

[codecov[bot]]

Codecov Report

Patch coverage: 79.38% and project coverage change: -0.53 :warning:

Comparison is base (87dc576) 85.27% compared to head (4a03f1d) 84.74%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #144 +/- ## ========================================== - Coverage 85.27% 84.74% -0.53% ========================================== Files 105 105 Lines 9995 10140 +145 ========================================== + Hits 8523 8593 +70 - Misses 1472 1547 +75 ``` | [Impacted Files](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup) | Coverage Δ | | |---|---|---| | [renormalizer/mps/mp.py](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup#diff-cmVub3JtYWxpemVyL21wcy9tcC5weQ==) | `84.75% <42.85%> (-3.81%)` | :arrow_down: | | [renormalizer/spectra/base.py](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup#diff-cmVub3JtYWxpemVyL3NwZWN0cmEvYmFzZS5weQ==) | `95.65% <75.00%> (-4.35%)` | :arrow_down: | | [renormalizer/model/basis.py](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup#diff-cmVub3JtYWxpemVyL21vZGVsL2Jhc2lzLnB5) | `88.77% <82.97%> (-0.55%)` | :arrow_down: | | [renormalizer/mps/gs.py](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup#diff-cmVub3JtYWxpemVyL21wcy9ncy5weQ==) | `95.81% <86.66%> (-1.28%)` | :arrow_down: | | [renormalizer/mps/mps.py](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup#diff-cmVub3JtYWxpemVyL21wcy9tcHMucHk=) | `90.52% <92.85%> (-0.03%)` | :arrow_down: | | [renormalizer/cv/spectra\_cv.py](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup#diff-cmVub3JtYWxpemVyL2N2L3NwZWN0cmFfY3YucHk=) | `88.88% <100.00%> (+0.09%)` | :arrow_up: | | [renormalizer/cv/tests/test\_H\_chain.py](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup#diff-cmVub3JtYWxpemVyL2N2L3Rlc3RzL3Rlc3RfSF9jaGFpbi5weQ==) | `100.00% <100.00%> (ø)` | | | [renormalizer/cv/zerot.py](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup#diff-cmVub3JtYWxpemVyL2N2L3plcm90LnB5) | `98.14% <100.00%> (ø)` | | | [renormalizer/lib/tests/test\_krylov.py](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup#diff-cmVub3JtYWxpemVyL2xpYi90ZXN0cy90ZXN0X2tyeWxvdi5weQ==) | `100.00% <100.00%> (ø)` | | | [renormalizer/model/tests/test\_basis.py](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup#diff-cmVub3JtYWxpemVyL21vZGVsL3Rlc3RzL3Rlc3RfYmFzaXMucHk=) | `100.00% <100.00%> (ø)` | | | ... and [7 more](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup) | | ... and [2 files with indirect coverage changes](https://app.codecov.io/gh/shuaigroup/Renormalizer/pull/144/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=shuaigroup)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

[jjren]

Hi Weitang @liwt31 , at the beginning of this PR, you mentioned the Heisenberg tutorial bug, but I didn't find any changes to the Heisenberg tutorial. What I found is that the jupyter notebook of Heisenberg tutorial is supposed to move into doc/source/tutorial, but it doesn't.
Did I do something wrong during the force push ... or you haven't move the jupyter notebook of Heisenberg into doc/source/tutorial?

[jjren]

My another question is what the difference between the three CI tests. From my understanding, ci / test (pull request) is the PR branch + master, ci / test (push) is the PR branch only. Then what is ci/circleci ?

[jjren]

Hi Weitang @liwt31 , at the beginning of this PR, you mentioned the Heisenberg tutorial bug, but I didn't find any changes to the Heisenberg tutorial. What I found is that the jupyter notebook of Heisenberg tutorial is supposed to move into doc/source/tutorial, but it doesn't. Did I do something wrong during the force push ... or you haven't move the jupyter notebook of Heisenberg into doc/source/tutorial?

I found that in the successful ci/circleci run, it showed that

Running Sphinx v5.3.0
copying ../../example/1D-Heisenberg.ipynb
making output directory... done

How did it happen? I can't find a rule anywhere in the package to do this.

[jjren]

Hi Weitang @liwt31 , at the beginning of this PR, you mentioned the Heisenberg tutorial bug, but I didn't find any changes to the Heisenberg tutorial. What I found is that the jupyter notebook of Heisenberg tutorial is supposed to move into doc/source/tutorial, but it doesn't. Did I do something wrong during the force push ... or you haven't move the jupyter notebook of Heisenberg into doc/source/tutorial?

I found that in the successful ci/circleci run, it showed that

Running Sphinx v5.3.0
copying ../../example/1D-Heisenberg.ipynb
making output directory... done

How did it happen? I can't find a rule anywhere in the package to do this.

Oh, finally, I found it in /home/jjren/Code/Renormalizer/doc/source/conf.py ! The remaining question is that

• the bug in Heisenberg model tutorial
• pandoc seems to have not been installed successfully in the two ci/test.

[liwt31]

• CI/CircleCI is based on the PR branch only. We are in the middle of switching from circleci to GitHub actions.
• I can't really remember the bug exactly. Probably related to documentation generation and not the content in the notebook
• CircleCI passes because in this branch the installation of pandoc is added to .circleci/config.yaml. The same lines should be added to .github/workflow/ci.yaml

[liwt31]

In general looks good! Only need to resolve the problem of the default thread number.

[jjren]

Finally. :turtle:

[liwt31]

great stuff, thanks! Just a reminder: the document still needs a lot of work.