new howto and supporting infra

.github/workflows/ci-julia-nightly.yml

@@ -11,16 +11,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        version:
-          - nightly
-        os:
-          - ubuntu-latest
-        threads:
-          - '2'
-        jet:
-          - 'true'
-        arch:
-          - x64
+        include:
+          - os: ubuntu-latest
+            arch: x64
+            version: nightly
+            threads: 2
+            jet: 'false'
+          - os: ubuntu-latest
+            arch: x64
+            version: '1'
+            threads: 2
+            jet: 'true'
     steps:
       - uses: actions/checkout@v3
       - uses: julia-actions/setup-julia@v1

Project.toml

@@ -1,7 +1,7 @@
 name = "QuantumSavory"
 uuid = "2de2e421-972c-4cb5-a0c3-999c85908079"
 authors = ["Stefan Krastanov <[email protected]>"]
-version = "0.2.0"
+version = "0.2.1"
 
 [deps]
 ConcurrentSim = "6ed1e86c-fcaf-46a9-97e0-2b26a2cdb499"

examples/colorcentermodularcluster/3_makie_interactive.jl

@@ -6,6 +6,8 @@ using Markdown
 
 include("setup.jl");
 
+const custom_css = JSServe.DOM.style("ul {list-style: circle !important;}") # TODO remove after fix of bug in JSServe https://github.com/SimonDanisch/JSServe.jl/issues/178
+
 """Run a simulation until all links in the cluster state are established,
 then report time to completion and average link fidelity."""
 function run_until_connected(root_conf)
@@ -113,8 +115,10 @@ landing = App() do
     - crosstalk in microwave control is not modeled
     - optical crosstalk and poor extinction are not modeled
     - decoupling the electronic and nuclear spin after a failed measurement is not modeled in detail
+
+    [See and modify the code for this simulation on github.](https://github.com/QuantumSavory/QuantumSavory.jl/tree/master/examples/colorcentermodularcluster)
     """
-    return DOM.div(JSServe.MarkdownCSS, JSServe.Styling, content)
+    return DOM.div(JSServe.MarkdownCSS, JSServe.Styling, custom_css, content)
 end;
 
 ##
@@ -181,8 +185,10 @@ ensemble = App() do
     `Ctrl`+click resets the view.
 
     Back at the [landing page](/..) you can view multiple other ways to simulate and visualize this cluster state preparation experiment.
+
+    [See and modify the code for this simulation on github.](https://github.com/QuantumSavory/QuantumSavory.jl/tree/master/examples/colorcentermodularcluster)
     """
-    return DOM.div(JSServe.MarkdownCSS, JSServe.Styling, content)
+    return DOM.div(JSServe.MarkdownCSS, JSServe.Styling, custom_css, content)
 end;
 
 ##
@@ -316,8 +322,10 @@ singletraj = App() do
     $(config_str)
 
     Back at the [landing page](/..) you can view multiple other ways to simulate and visualize this cluster state preparation experiment.
+
+    [See and modify the code for this simulation on github.](https://github.com/QuantumSavory/QuantumSavory.jl/tree/master/examples/colorcentermodularcluster)
     """
-    return DOM.div(JSServe.MarkdownCSS, JSServe.Styling, content)
+    return DOM.div(JSServe.MarkdownCSS, JSServe.Styling, custom_css, content)
 end;
 
 ##

examples/congestionchain/1_visualization.jl

@@ -0,0 +1,57 @@
+include("setup.jl")
+
+using GLMakie # For plotting
+GLMakie.activate!(inline=false)
+
+##
+# Demo visualizations of the performance of the network
+##
+len = 5                    # Number of registers in the chain
+regsize = 2                # Number of qubits in each register
+T2 = 100.0                 # T2 dephasing time of all qubits
+F = 0.97                   # Fidelity of the raw Bell pairs
+entangler_wait_time = 0.1  # How long to wait if all qubits are busy before retring entangling
+entangler_busy_λinv = 0.5     # How long it takes to establish a newly entangled pair (Exponential distribution parameter)
+swapper_wait_time = 0.1    # How long to wait if all qubits are unavailable for swapping
+swapper_busy_time = 0.55   # How long it takes to swap two qubits
+consume_wait_time = 0.1    # How long to wait if there are no qubits ready for consumption
+
+sim, network = simulation_setup(len, regsize, T2)
+
+noisy_pair = noisy_pair_func(F)
+for (;src, dst) in edges(network)
+    @process entangler(sim, network, src, dst, noisy_pair, entangler_wait_time, 1/entangler_busy_λinv)
+end
+
+for node in vertices(network)
+    @process swapper(sim, network, node, swapper_wait_time, swapper_busy_time)
+end
+
+ts = Observable(Float64[])
+fidXX = Observable(Float64[])
+fidZZ = Observable(Float64[])
+@process consumer(sim, network, 1, len, consume_wait_time,ts,fidXX,fidZZ)
+
+fig = Figure(resolution=(800,400))
+_,ax,_,obs = registernetplot_axis(fig[1,1],network)
+
+ax_fidXX = Axis(fig[1,2][1,1], xlabel="", ylabel="XX Stabilizer\nExpectation")
+ax_fidZZ = Axis(fig[1,2][2,1], xlabel="time", ylabel="ZZ Stabilizer\nExpectation")
+c1 = Makie.wong_colors()[1]
+c2 = Makie.wong_colors()[2]
+scatter!(ax_fidXX,ts,fidXX,label="XX",color=(c1,0.1))
+scatter!(ax_fidZZ,ts,fidZZ,label="ZZ",color=(c2,0.1))
+
+display(fig)
+
+step_ts = range(0, 1000, step=0.1)
+for t in step_ts
+    run(sim, t)
+    ax.title = "t=$(t)"
+    notify(obs)
+    notify(ts)
+    autolimits!(ax_fidXX)
+    autolimits!(ax_fidZZ)
+end
+
+##

examples/congestionchain/2_makie_interactive.jl

@@ -0,0 +1,181 @@
+using WGLMakie
+WGLMakie.activate!()
+using JSServe
+using Markdown
+
+include("setup.jl")
+
+const custom_css = JSServe.DOM.style("ul {list-style: circle !important;}") # TODO remove after fix of bug in JSServe https://github.com/SimonDanisch/JSServe.jl/issues/178
+
+##
+# Demo visualizations of the performance of the network
+##
+
+function prepare_singlerun(
+    fig;
+    len = 5,                    # Number of registers in the chain
+    regsize = 2,                # Number of qubits in each register
+    T2 = 100.0,                 # T2 dephasing time of all qubits
+    F = 0.97,                   # Fidelity of the raw Bell pairs
+    entangler_wait_time = 0.1,  # How long to wait if all qubits are busy before retring entangling
+    entangler_busy_λinv = 0.5,  # How long it takes to establish a newly entangled pair (Exponential distribution parameter)
+    swapper_wait_time = 0.1,    # How long to wait if all qubits are unavailable for swapping
+    swapper_busy_time = 0.55,   # How long it takes to swap two qubits
+    consume_wait_time = 0.1,    # How long to wait if there are no qubits ready for consumption
+)
+    sim, network = simulation_setup(len, regsize, T2)
+
+    noisy_pair = noisy_pair_func(F)
+    for (;src, dst) in edges(network)
+        @process entangler(sim, network, src, dst, noisy_pair, entangler_wait_time, 1/entangler_busy_λinv)
+    end
+
+    for node in vertices(network)
+        @process swapper(sim, network, node, swapper_wait_time, swapper_busy_time)
+    end
+
+    ts = Observable(Float64[])
+    fidXX = Observable(Float64[])
+    fidZZ = Observable(Float64[])
+    @process consumer(sim, network, 1, len, consume_wait_time,ts,fidXX,fidZZ)
+
+    registercoords = [Point2{Float64}(2*cos(pi/(len+1)*i),sin(pi/(len+1)*i)).*(regsize+2) for i in 1:len]
+    _,ax,_,obs = registernetplot_axis(fig[1,1],network; interactions=false, registercoords)
+
+    ax_fidXX = Axis(fig[1,2][1,1], xlabel="", ylabel="XX Stabilizer\nExpectation")
+    ax_fidZZ = Axis(fig[1,2][2,1], xlabel="time", ylabel="ZZ Stabilizer\nExpectation")
+    c1 = Makie.wong_colors()[1]
+    c2 = Makie.wong_colors()[2]
+    scatter!(ax_fidXX,ts,fidXX,label="XX",color=(c1,0.1))
+    scatter!(ax_fidZZ,ts,fidZZ,label="ZZ",color=(c2,0.1))
+
+    sim, network, obs, ts, ax, ax_fidXX, ax_fidZZ
+end
+
+function continue_singlerun!(sim, network, observables, axes, running)
+    step_ts = range(0, 1000, step=0.1)
+    for t in step_ts
+        run(sim, t)
+        # axes[1].title = "t=$(t)" # TODO does not update consistently
+        notify.(observables)
+        autolimits!.(axes)
+    end
+    running[] = nothing
+end
+
+##
+
+landing = App() do
+    fig = Figure(resolution=(800,700))
+
+    fig[1, 1] = buttongrid = GridLayout(tellwidth = false)
+
+    running = Observable{Any}(false)
+    buttongrid[1,1] = b = Makie.Button(fig, label = @lift(isnothing($running) ? "Done" : $running ? "Running..." : "Run once"))
+    conf_obs = add_conf_sliders(fig[1,2])
+
+    on(b.clicks) do _
+        if !running[]
+            running[] = true
+        end
+    end
+    on(running) do r
+        if r
+            sim, network, obs, ts, ax, ax_fidXX, ax_fidZZ = prepare_singlerun(fig[2,1:2]; conf_obs[]...)
+            Threads.@spawn continue_singlerun!(sim, network, (obs, ts), (ax, ax_fidXX, ax_fidZZ), running)
+        end
+    end
+
+    content = md"""
+    Pick simulation settings and hit run (see below for technical details).
+
+    $(fig.scene)
+
+    # Simulations of a chain of repeaters
+
+    Two processes occur in this system
+
+    - nearest neighbors have entanglement being generated between them
+    - each repeater performs an entanglement swap as soon as possible
+
+    In this simulation you can manipulate:
+    - number of repeaters
+    - number of qubits available as memories at each repeater
+    - the mean time to successful generation of a raw Bell pair (governed by an exponential distribution)
+    - the time it takes to perform a swap at a reapeater
+    - the fidelity of a raw Bell pair (assuming depolarization noise)
+    - T₂ memory time (only dephasing is modeled)
+
+    Local gates are assumed perfect.
+
+    To avoid deadlocks, entangled pairs are being generated only on even/odd pair of registers:
+    for a given pair of neighboring repeaters a raw entagled pair can be stored only in odd registers
+    on the left repeater and in even registers on the right repeater.
+    This staggering makes it impossible for the concurrent processes of entangling generation and swapping
+    to deadlock each other.
+
+    This simulation is a convenient tool for studying congestion on the repeater chain.
+
+    [See and modify the code for this simulation on github.](https://github.com/QuantumSavory/QuantumSavory.jl/tree/master/examples/congestionchain)
+    """
+    return DOM.div(JSServe.MarkdownCSS, JSServe.Styling, custom_css, content)
+end;
+
+
+##
+# A helper to add parameter sliders to visualizations
+
+function add_conf_sliders(fig)
+    conf = Dict(
+        :len => 5,
+        :regsize => 2,
+        :T2 => 100.0,
+        :F => 0.97,
+        :entangler_busy_λinv => 0.5,
+        :swapper_busy_time => 0.5
+    )
+    conf_obs = Observable(conf)
+    sg = SliderGrid(
+        fig,
+        (label = "repeater chain length",
+            range = 3:1:10, format = "{:d}", startvalue = conf[:len]),
+
+        (label = "repeater size (nb of qubits)",
+            range = 2:1:5, format = "{:d}", startvalue = conf[:regsize]),
+
+        (label = "T₂ of memories",
+            range = 1.0:10.:500.0, format = "{:.1f}", startvalue = conf[:T2]),
+        (label = "fidelity of raw pairs",
+            range = 0.6:0.01:1.0, format = "{:.2f}", startvalue = conf[:F]),
+        (label = "avg. time of ent. generation",
+            range = 0.05:0.05:1.0, format = "{:.2f}", startvalue = conf[:entangler_busy_λinv]),
+        (label = "swap duration",
+            range = 0.05:0.05:1.0, format = "{:.2f}", startvalue = conf[:swapper_busy_time]),
+        width = 600,
+        #tellheight = false
+    )
+
+    # TODO there should be a nicer way to link sliders to the configuration
+    names = [:len, :regsize, :T2, :F, :entangler_busy_λinv, :swapper_busy_time]
+    for (name,slider) in zip(names,sg.sliders)
+        on(slider.value) do val
+            conf_obs[][name] = val
+        end
+    end
+    conf_obs
+end
+
+##
+# Serve the Makie app
+
+isdefined(Main, :server) && close(server);
+port = parse(Int, get(ENV, "QS_CONGENSTIONCHAIN_PORT", "8888"))
+interface = get(ENV, "QS_CONGENSTIONCHAIN_IP", "127.0.0.1")
+proxy_url = get(ENV, "QS_CONGENSTIONCHAIN_PROXY", "")
+server = JSServe.Server(interface, port; proxy_url);
+JSServe.HTTPServer.start(server)
+JSServe.route!(server, "/" => landing);
+
+##
+
+wait(server)

examples/congestionchain/Project.toml

@@ -0,0 +1,15 @@
+[deps]
+ConcurrentSim = "6ed1e86c-fcaf-46a9-97e0-2b26a2cdb499"
+Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
+JSServe = "824d6782-a2ef-11e9-3a09-e5662e0c26f9"
+Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
+QuantumOptics = "6e0679c1-51ea-5a7c-ac74-d61b76210b0c"
+QuantumSavory = "2de2e421-972c-4cb5-a0c3-999c85908079"
+QuantumSymbolics = "efa7fd63-0460-4890-beb7-be1bbdfbaeae"
+ResumableFunctions = "c5292f4c-5179-55e1-98c5-05642aab7184"
+Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
+WGLMakie = "276b4fcb-3e11-5398-bf8b-a0c2d153d008"
+
+[compat]
+JSServe = "2.2.7"

examples/congestionchain/README.md

@@ -0,0 +1,13 @@
+# A Simulation of Congestion on a Quantum Repeater Chain
+
+For detailed description of the code consult the `QuantumSavory.jl`
+[example page in the documentation](https://quantumsavory.github.io/QuantumSavory.jl/dev/howto-congestionchain/)
+
+A simple, more instructive, example is also
+[available in the documentation](https://quantumsavory.github.io/QuantumSavory.jl/dev/howto-firstgenrepeater/)
+
+
+The `setup.jl` file implements all necessary base functionality.
+The other files run the simulation and generate visuals in a number of different circumstances:
+1. A single simulator script convenient for exploratory coding;
+2. A web-app version of the simulator;