Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ using Documenter

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

const DRAFT = false # set `true` to disable cell evaluation

const MathEngine = MathJax3(
Dict(
:loader => Dict("load" => ["[tex]/physics"]),
Expand Down Expand Up @@ -33,6 +35,11 @@ const PAGES = [
"Tensor Products and Partial Traces" => "users_guide/tensor.md",
"Time Evolution and Dynamics" => [
"Introduction" => "users_guide/time_evolution/intro.md",
"Time Evolution Solutions" => "users_guide/time_evolution/solution.md",
"Lindblad Master Equation Solver" => "users_guide/time_evolution/sesolve_and_mesolve.md",
"Monte-Carlo Solver" => "users_guide/time_evolution/mcsolve.md",
"Stochastic Solver" => "users_guide/time_evolution/stochastic.md",
"Solving Problems with Time-dependent Hamiltonians" => "users_guide/time_evolution/time_dependent.md",
],
"Solving for Steady-State Solutions" => [],
"Symmetries" => [],
Expand Down Expand Up @@ -66,7 +73,8 @@ makedocs(;
assets = ["assets/favicon.ico"],
mathengine = MathEngine,
size_threshold_ignore = ["api.md"],
)
),
draft = DRAFT,
)

deploydocs(; repo = "github.com/qutip/QuantumToolbox.jl", devbranch = "main")
29 changes: 28 additions & 1 deletion docs/src/users_guide/time_evolution/intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# [Time Evolution and Quantum System Dynamics](@id doc:Time-Evolution-and-Quantum-System-Dynamics)

This page is still under construction, please visit [API](@ref doc-API) first.
**Table of contents**

```@contents
Pages = [
"intro.md",
"solution.md",
"sesolve_and_mesolve.md",
"mcsolve.md",
"stochastic.md",
"time_dependent.md",
]
Depth = 2:3
```

## [Introduction](@id doc-TE:Introduction)

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.

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.

The following table lists the solvers provided by `QuantumToolbox` for dynamic quantum systems and the corresponding type of solution returned by the solver:

| **Equation** | **Function Call** | **Returned Solution** |
|:-------------|:------------------|:----------------------|
| Unitary evolution, Schrödinger equation | [`sesolve`](@ref) | [`TimeEvolutionSol`](@ref) |
| Lindblad master eqn. or Von Neuman eqn. | [`mesolve`](@ref) | [`TimeEvolutionSol`](@ref) |
| Monte Carlo evolution | [`mcsolve`](@ref) | [`TimeEvolutionMCSol`](@ref) |
| Stochastic Schrödinger equation | [`ssesolve`](@ref) | [`TimeEvolutionSSESol`](@ref) |
5 changes: 5 additions & 0 deletions docs/src/users_guide/time_evolution/mcsolve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Time Evolution and Quantum System Dynamics

## [Monte-Carlo Solver](@id doc-TE:Monte-Carlo-Solver)

This page is still under construction, please visit [API](@ref doc-API) first.
11 changes: 11 additions & 0 deletions docs/src/users_guide/time_evolution/sesolve_and_mesolve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Time Evolution and Quantum System Dynamics

## [Lindblad Master Equation Solver](@id doc-TE:Lindblad-Master-Equation-Solver)

This page is still under construction, please visit [API](@ref doc-API) first.

### Unitary evolution

### Non-unitary evolution

### The Lindblad master equation
9 changes: 9 additions & 0 deletions docs/src/users_guide/time_evolution/solution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Time Evolution and Quantum System Dynamics

## [Time Evolution Solutions](@id doc-TE:Time-Evolution-Solutions)

This page is still under construction, please visit [API](@ref doc-API) first.

### Solution

### Multiple trajectories solution
7 changes: 7 additions & 0 deletions docs/src/users_guide/time_evolution/stochastic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Time Evolution and Quantum System Dynamics

## [Stochastic Solver](@id doc-TE:Stochastic-Solver)

This page is still under construction, please visit [API](@ref doc-API) first.

### Stochastic Schrodinger equation
5 changes: 5 additions & 0 deletions docs/src/users_guide/time_evolution/time_dependent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Time Evolution and Quantum System Dynamics

## [Solving Problems with Time-dependent Hamiltonians](@id doc-TE:Solving-Problems-with-Time-dependent-Hamiltonians)

This page is still under construction, please visit [API](@ref doc-API) first.