Skip to content

Commit 12e8fd5

Browse files
committed
Documentation update
1 parent e38257e commit 12e8fd5

File tree

4 files changed

+7
-8
lines changed

4 files changed

+7
-8
lines changed

docs/src/example_lodahl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ In many of the examples considered so far, we only consider a single waveguide t
99
![`alt text`](./illustrations/two_waveguide_lodahl.png)
1010

1111

12-
A way to model this scenario is to have two waveguides: a waveguide to the left and the right, describing the first half of the waveguide and the latter half. For this, we use [`WaveguideBasis`](@ref) but with an extra argument specifying that we need two waveguides (see [`twowaveguide`](@ref) for an introduction). We initialize [`WaveguideBasis`](@ref) with two waveguides and a basis for the atom (note that a fockbasis with only one excitation allowed is the same as a two-level-system):
12+
A way to model this scenario is to have two waveguides: a waveguide to the left and the right, describing the first half of the waveguide and the latter half. For this, we use [`WaveguideBasis`](@ref) but with an extra argument specifying that we need two waveguides (see [`Multiple Waveguides`](@ref twowaveguide) for an introduction). We initialize [`WaveguideBasis`](@ref) with two waveguides and a basis for the atom (note that a fockbasis with only one excitation allowed is the same as a two-level-system):
1313

1414
```@example lodahl
1515
using WaveguideQED #hide
@@ -101,7 +101,7 @@ rcParams = PyPlot.PyDict(PyPlot.matplotlib."rcParams") #hide
101101
rcParams["font.size"] = 20 #hide
102102
rcParams["font.family"] = "serif" #hide
103103
rcParams["mathtext.fontset"] ="cm" #hide
104-
fig,axs = subplots(3,2,figsize=(6,17))
104+
fig,axs = subplots(3,2,figsize=(6,9))
105105
plot_list = [ψ2RightScat,ψ2LeftScat,ψ2LeftRightScat,ψ1RightScat,ψ1LeftScat,ψ1LeftRightScat]
106106
for (i,ax) in enumerate(axs)
107107
plot_twophoton!(ax,plot_list[i],times)

docs/src/theoreticalbackground.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ nothing #hide
108108
```
109109
![alt text](created_onephoton_continuous_fockstate.svg)
110110

111-
We see a spike around `t = times[10] = 0.9`, where we now created an excitation. In itself, the waveguide basis, states, and operators are not particularly interesting, but when combined with other quantum mechanical systems such as cavities and emitters, the framework can produce powerful results. See [`combining`](@ref) for an introduction on how to combine with quantum systems defined in ['QuantumOptics.jl'](https://qojulia.org/).
111+
We see a spike around `t = times[10] = 0.9`, where we now created an excitation. In itself, the waveguide basis, states, and operators are not particularly interesting, but when combined with other quantum mechanical systems such as cavities and emitters, the framework can produce powerful results. See [`Combining with QuantumOptics`](@ref combining) for an introduction on how to combine with quantum systems defined in ['QuantumOptics.jl'](https://qojulia.org/).
112112

113113

114114
## Continuous two-photon fock states
@@ -172,7 +172,7 @@ If we want to create a two-photon Gaussian state, we instead do:
172172
nothing #hide
173173
```
174174

175-
Here, we defined the two-photon equivalent of our single-photon Gaussian state. When we visualize it, we now need two times, and we make a contour plot. This is easily done by viewing the two-photon state and using [`plot_twophoton`](@ref):
175+
Here, we defined the two-photon equivalent of our single-photon Gaussian state. When we visualize it, we now need two times, and we make a contour plot. This is easily done by viewing the two-photon state and using [`plot_twophoton!`](@ref):
176176

177177
```@example theory
178178
viewed_state = TwoPhotonView(ψ)

src/WaveguideInteraction.jl

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,7 @@ const TensorWaveguideInteraction = LazyTensor{B,B,F,V,T} where {B,F,V,T<:Tuple{W
257257

258258
function expect(a::T,psi::Ket) where T<:Union{WaveguideInteraction,TensorWaveguideInteraction}
259259
out = 0
260-
tmp_data = QuantumOpticsBase._tp_matmul_get_tmp(eltype(psi.data), (length(psi.data),), :tp_ex, psi.data)
261-
tmp_ket = Ket(psi.basis,tmp_data)
260+
tmp_ket = Ket(psi.basis)
262261
for i in 1:get_nsteps(basis(a))
263262
set_waveguidetimeindex!(a,i)
264263
mul!(tmp_ket,a,psi,1,0)

src/WaveguideOperator.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Annihilation operator ``w`` for [`WaveguideBasis`](@ref) ``w_i(t_k) | 1_j \\empt
7070
- `i` determines which waveguide the operator acts on and should be `i ≤ Nw`. If `Nw=1` then `i=1` is assumed (there is only one waveguide).
7171
7272
# Returns
73-
[`WaveguideDestroy{B,B,Np,i} <: WaveguideOperator`](@ref)
73+
[`WaveguideDestroy`](@ref)
7474
"""
7575
function destroy(basis::WaveguideBasis{Np,1}) where {Np}
7676
B = typeof(basis)
@@ -95,7 +95,7 @@ Creation operator ``w^\\dagger`` for [`WaveguideBasis`](@ref) ``w_i(t_k)^\\dagge
9595
- `i` determines which waveguide the operator acts on and should be `i ≤ Nw`. If `Nw=1` then `i=1` is assumed (there is only one waveguide).
9696
9797
# Returns
98-
[`WaveguideCreate{B,B,Np,i} <: WaveguideOperator`](@ref)
98+
[`WaveguideCreate`](@ref)
9999
"""
100100
function create(basis::WaveguideBasis{Np,1}) where {Np}
101101
B = typeof(basis)

0 commit comments

Comments
 (0)