Skip to content

Commit

Permalink
[Docs] fix typo in @example block (#246)
Browse files Browse the repository at this point in the history
  • Loading branch information
ytdHuang authored Sep 30, 2024
1 parent 88519ac commit f6ccbba
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
7 changes: 4 additions & 3 deletions docs/src/users_guide/steadystate.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ using QuantumToolbox
using CairoMakie
CairoMakie.enable_only_mime!(MIME"image/svg+xml"())
# Define parameters
N = 20 # number of basis states to consider
a = destroy(N)
Expand All @@ -81,8 +80,10 @@ H = a' * a
n_th = 2 # temperature with average of 2 excitations
# collapse operators
# c_op_list = [ emission ; absorption ]
c_op_list = [ sqrt(κ * (1 + n_th)) * a ; sqrt(κ * n_th) * a' ]
c_op_list = [
sqrt(κ * (n_th + 1)) * a, # emission
sqrt(κ * n_th ) * a' # absorption
]
# find steady-state solution
ρ_ss = steadystate(H, c_op_list)
Expand Down
22 changes: 14 additions & 8 deletions docs/src/users_guide/time_evolution/solution.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,16 @@ using QuantumToolbox
To understand how to access the data in solution, we will use an example as a guide, although we do not worry about the simulation details at this stage. The Schrödinger equation solver ([`sesolve`](@ref)) used in this example returns [`TimeEvolutionSol`](@ref):

```@example TE-solution
H = 0.5 * sigmax()
H = 0.5 * sigmay()
ψ0 = basis(2, 0)
e_ops = [
proj(basis(2, 0)),
proj(basis(2, 1)),
basis(2, 0) * basis(2, 1)'
]
tlist = LinRange(0, 10, 100)
sol = sesolve(H, ψ0, tlist, e_ops = e_ops, progress_bar = Val(false)); nothing # hide
sol = sesolve(H, ψ0, tlist, e_ops = e_ops, progress_bar = Val(false))
nothing # hide
```

To see what is contained inside the solution, we can use the `print` function:
Expand All @@ -46,15 +47,17 @@ It tells us the number of expectation values are computed and the number of stat
```@example TE-solution
expt1 = real(sol.expect[1,:])
expt2 = real(sol.expect[2,:])
expt3 = real(sol.expect[3,:]); nothing # hide
expt3 = real(sol.expect[3,:])
nothing # hide
```

Recall that `Julia` uses `Fortran`-style indexing that begins with one (i.e., `[1,:]` represents the 1-st observable, where `:` represents all values corresponding to `tlist`).

Together with the array of times at which these expectation values are calculated:

```@example TE-solution
times = sol.times; nothing # hide
times = sol.times
nothing # hide
```

we can plot the resulting expectation values:
Expand All @@ -64,10 +67,13 @@ using CairoMakie
CairoMakie.enable_only_mime!(MIME"image/svg+xml"())
fig = Figure()
ax = Axis(fig[1, 1])
lines!(ax, times, expt1, label = L"P_00")
lines!(ax, times, expt2, label = L"P_11")
lines!(ax, times, expt3, label = L"P_01")
ax = Axis(fig[1, 1], xlabel = L"t")
lines!(ax, times, expt1, label = L"\langle 0 | \rho(t) | 0 \rangle")
lines!(ax, times, expt2, label = L"\langle 1 | \rho(t) | 1 \rangle")
lines!(ax, times, expt3, label = L"\langle 0 | \rho(t) | 1 \rangle")
ylims!(ax, (-0.5, 1.0))
axislegend(ax, position = :lb)
fig
```
Expand Down

0 comments on commit f6ccbba

Please sign in to comment.