Skip to content

Commit a78ee61

Browse files
author
qyli
committed
setup docs
1 parent b188a22 commit a78ee61

File tree

6 files changed

+117
-94
lines changed

6 files changed

+117
-94
lines changed

‎docs/Project.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
FiniteMPS = "6b572690-f317-4dad-a5fe-5fe73a0b7d42"

‎docs/make.jl‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
11
using Documenter, FiniteMPS
22

3+
pages = ["Home" => "index.md",
4+
"Tutorial" => ["tutorial/HeisenbergXXZ.md"],
5+
"Library" => [],
6+
"Index" => ["index/index.md"]]
7+
8+
39
makedocs(;
4-
modules = [FiniteMPS],
5-
sitename="FiniteMPS.jl",
6-
authors = "Qiaoyi Li")
10+
modules = [FiniteMPS],
11+
sitename="FiniteMPS.jl",
12+
authors = "Qiaoyi Li",
13+
warnonly=[:missing_docs, :cross_references],
14+
format=Documenter.HTML(; prettyurls=true, mathengine=MathJax()),
15+
pages = pages,
16+
pagesonly = true,
17+
)
718

819
deploydocs(
920
repo = "github.com/Qiaoyi-Li/FiniteMPS.jl",
1021
devbranch="main",
11-
)
22+
)

‎docs/src/index.md‎

Lines changed: 5 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,13 @@
11
# FiniteMPS.jl
22

3+
*A julia package for finite MPS/MPO-based computations of ground-state, finite-temperature and dynamical properties.*
4+
35
```@meta
46
CurrentModule = FiniteMPS
57
```
68

9+
## Package summary
10+
711
## Contents
812
```@contents
9-
```
10-
11-
## Types
12-
### Tensor wrappers
13-
```@docs
14-
AbstractTensorWrapper
15-
AbstractMPSTensor
16-
MPSTensor
17-
CompositeMPSTensor
18-
AdjointMPSTensor
19-
AbstractEnvironmentTensor
20-
LocalLeftTensor
21-
LocalRightTensor
22-
SimpleLeftTensor
23-
SimpleRightTensor
24-
SparseLeftTensor
25-
SparseRightTensor
26-
AbstractLocalOperator
27-
IdentityOperator
28-
tag2Tuple
29-
LocalOperator
30-
SparseMPOTensor
31-
AbstractStoreType
32-
StoreMemory
33-
StoreDisk
34-
```
35-
36-
### MPS/MPO
37-
```@docs
38-
AbstractMPS
39-
DenseMPS
40-
AdjointMPS
41-
MPS
42-
MPO
43-
SparseMPO
44-
```
45-
46-
### Environment
47-
```@docs
48-
AbstractEnvironment
49-
SimpleEnvironment
50-
SparseEnvironment
51-
Environment
52-
```
53-
54-
### Projective Hamiltonian
55-
```@docs
56-
AbstractProjectiveHamiltonian
57-
IdentityProjectiveHamiltonian
58-
SparseProjectiveHamiltonian
59-
```
60-
61-
### Interaction tree
62-
```@docs
63-
InteractionTreeNode
64-
InteractionTree
65-
addIntr!
66-
addIntr1!
67-
addIntr2!
68-
addIntr4!
69-
AutomataMPO
70-
ObservableTree
71-
addObs!
72-
```
73-
74-
## Algorithms
75-
### DMRG
76-
```@docs
77-
DMRGInfo
78-
DMRGSweep2!
79-
DMRGSweep1!
80-
```
81-
82-
### TDVP
83-
```@docs
84-
TDVPInfo
85-
TDVPSweep2!
86-
TDVPSweep1!
87-
TDVPIntegrator
88-
SymmetricIntegrator
89-
```
90-
91-
### CBE
92-
```@docs
93-
CBEAlgorithm
94-
NoCBE
95-
FullCBE
96-
StandardCBE
97-
CBE
98-
```
13+
```

‎docs/src/index/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Index
2+
3+
```@index
4+
```

‎docs/src/lib/lib.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
2+
## Types
3+
### Tensor wrappers
4+
```@docs
5+
AbstractTensorWrapper
6+
AbstractMPSTensor
7+
MPSTensor
8+
CompositeMPSTensor
9+
AdjointMPSTensor
10+
AbstractEnvironmentTensor
11+
LocalLeftTensor
12+
LocalRightTensor
13+
SimpleLeftTensor
14+
SimpleRightTensor
15+
SparseLeftTensor
16+
SparseRightTensor
17+
AbstractLocalOperator
18+
IdentityOperator
19+
tag2Tuple
20+
LocalOperator
21+
SparseMPOTensor
22+
AbstractStoreType
23+
StoreMemory
24+
StoreDisk
25+
```
26+
27+
### MPS/MPO
28+
```@docs
29+
AbstractMPS
30+
DenseMPS
31+
AdjointMPS
32+
MPS
33+
MPO
34+
SparseMPO
35+
```
36+
37+
### Environment
38+
```@docs
39+
AbstractEnvironment
40+
SimpleEnvironment
41+
SparseEnvironment
42+
Environment
43+
```
44+
45+
### Projective Hamiltonian
46+
```@docs
47+
AbstractProjectiveHamiltonian
48+
IdentityProjectiveHamiltonian
49+
SparseProjectiveHamiltonian
50+
```
51+
52+
### Interaction tree
53+
```@docs
54+
InteractionTreeNode
55+
InteractionTree
56+
addIntr!
57+
addIntr1!
58+
addIntr2!
59+
addIntr4!
60+
AutomataMPO
61+
ObservableTree
62+
addObs!
63+
```
64+
65+
## Algorithms
66+
### DMRG
67+
```@docs
68+
DMRGInfo
69+
DMRGSweep2!
70+
DMRGSweep1!
71+
```
72+
73+
### TDVP
74+
```@docs
75+
TDVPInfo
76+
TDVPSweep2!
77+
TDVPSweep1!
78+
TDVPIntegrator
79+
SymmetricIntegrator
80+
```
81+
82+
### CBE
83+
```@docs
84+
CBEAlgorithm
85+
NoCBE
86+
FullCBE
87+
StandardCBE
88+
CBE
89+
```

‎docs/src/tutorial/HeisenbergXXZ.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Heisenberg XXZ model

0 commit comments

Comments
 (0)