Skip to content

Commit 4df91fb

Browse files
authored
[Docs] Update documentation for time evolution (#241)
* update documentation for time evolution * separate `sesolve` and `mesolve` in docs
1 parent 1913fd9 commit 4df91fb

File tree

8 files changed

+79
-2
lines changed

8 files changed

+79
-2
lines changed

docs/make.jl

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ using Documenter
66

77
DocMeta.setdocmeta!(QuantumToolbox, :DocTestSetup, :(using QuantumToolbox); recursive = true)
88

9+
const DRAFT = false # set `true` to disable cell evaluation
10+
911
const MathEngine = MathJax3(
1012
Dict(
1113
:loader => Dict("load" => ["[tex]/physics"]),
@@ -33,6 +35,12 @@ const PAGES = [
3335
"Tensor Products and Partial Traces" => "users_guide/tensor.md",
3436
"Time Evolution and Dynamics" => [
3537
"Introduction" => "users_guide/time_evolution/intro.md",
38+
"Time Evolution Solutions" => "users_guide/time_evolution/solution.md",
39+
"Schrödinger Equation Solver" => "users_guide/time_evolution/sesolve.md",
40+
"Lindblad Master Equation Solver" => "users_guide/time_evolution/mesolve.md",
41+
"Monte-Carlo Solver" => "users_guide/time_evolution/mcsolve.md",
42+
"Stochastic Solver" => "users_guide/time_evolution/stochastic.md",
43+
"Solving Problems with Time-dependent Hamiltonians" => "users_guide/time_evolution/time_dependent.md",
3644
],
3745
"Solving for Steady-State Solutions" => "users_guide/steadystate.md",
3846
"Symmetries" => [],
@@ -66,7 +74,8 @@ makedocs(;
6674
assets = ["assets/favicon.ico"],
6775
mathengine = MathEngine,
6876
size_threshold_ignore = ["api.md"],
69-
)
77+
),
78+
draft = DRAFT,
7079
)
7180

7281
deploydocs(; repo = "github.com/qutip/QuantumToolbox.jl", devbranch = "main")
Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
# [Time Evolution and Quantum System Dynamics](@id doc:Time-Evolution-and-Quantum-System-Dynamics)
22

3-
This page is still under construction, please visit [API](@ref doc-API) first.
3+
**Table of contents**
4+
5+
```@contents
6+
Pages = [
7+
"intro.md",
8+
"solution.md",
9+
"sesolve.md",
10+
"mesolve.md",
11+
"mcsolve.md",
12+
"stochastic.md",
13+
"time_dependent.md",
14+
]
15+
Depth = 2:3
16+
```
17+
18+
## [Introduction](@id doc-TE:Introduction)
19+
20+
Although in some cases, we want to find the stationary states of a quantum system, often we are interested in the dynamics: how the state of a system or an ensemble of systems evolves with time. `QuantumToolbox` provides many ways to model dynamics.
21+
22+
There are two kinds of quantum systems: open systems that interact with a larger environment and closed systems that do not. In a closed system, the state can be described by a state vector. When we are modeling an open system, or an ensemble of systems, the use of the density matrix is mandatory.
23+
24+
The following table lists the solvers provided by `QuantumToolbox` for dynamic quantum systems and the corresponding type of solution returned by the solver:
25+
26+
| **Equation** | **Function Call** | **Returned Solution** |
27+
|:-------------|:------------------|:----------------------|
28+
| Unitary evolution, Schrödinger equation | [`sesolve`](@ref) | [`TimeEvolutionSol`](@ref) |
29+
| Lindblad master eqn. or Von Neuman eqn. | [`mesolve`](@ref) | [`TimeEvolutionSol`](@ref) |
30+
| Monte Carlo evolution | [`mcsolve`](@ref) | [`TimeEvolutionMCSol`](@ref) |
31+
| Stochastic Schrödinger equation | [`ssesolve`](@ref) | [`TimeEvolutionSSESol`](@ref) |
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Time Evolution and Quantum System Dynamics
2+
3+
## [Monte-Carlo Solver](@id doc-TE:Monte-Carlo-Solver)
4+
5+
This page is still under construction, please visit [API](@ref doc-API) first.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Time Evolution and Quantum System Dynamics
2+
3+
## [Lindblad Master Equation Solver](@id doc-TE:Lindblad-Master-Equation-Solver)
4+
5+
This page is still under construction, please visit [API](@ref doc-API) first.
6+
7+
### Von Neumann equation
8+
9+
### The Lindblad master equation
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Time Evolution and Quantum System Dynamics
2+
3+
## [Schrödinger Equation Solver](@id doc-TE:Schrödinger-Equation-Solver)
4+
5+
This page is still under construction, please visit [API](@ref doc-API) first.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Time Evolution and Quantum System Dynamics
2+
3+
## [Time Evolution Solutions](@id doc-TE:Time-Evolution-Solutions)
4+
5+
This page is still under construction, please visit [API](@ref doc-API) first.
6+
7+
### Solution
8+
9+
### Multiple trajectories solution
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Time Evolution and Quantum System Dynamics
2+
3+
## [Stochastic Solver](@id doc-TE:Stochastic-Solver)
4+
5+
This page is still under construction, please visit [API](@ref doc-API) first.
6+
7+
### Stochastic Schrodinger equation
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Time Evolution and Quantum System Dynamics
2+
3+
## [Solving Problems with Time-dependent Hamiltonians](@id doc-TE:Solving-Problems-with-Time-dependent-Hamiltonians)
4+
5+
This page is still under construction, please visit [API](@ref doc-API) first.

0 commit comments

Comments
 (0)