Background Map for Plotting

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## v0.5.1-dev
 
 - Add `classical_delay` and `quantum_delay` as keyword arguments to the `RegisterNet` constructor to set a default global network edge latency.
+- Plots of networks can now overlay real-world maps (see `generate_map`).
 
 ## v0.5.0 - 2024-10-16
 

Project.toml

@@ -27,19 +27,22 @@ SumTypes = "8e1ec7a9-0e02-4297-b0fe-6433085c89f2"
 
 [weakdeps]
 Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
+GeoMakie = "db073c08-6b98-4ee5-b6a4-5efafb3259c6"
 
 [extensions]
+QuantumSavoryGeoMakie = ["GeoMakie", "Makie"]
 QuantumSavoryMakie = "Makie"
 
 [compat]
 Combinatorics = "1"
 ConcurrentSim = "1.4.1"
 Distributions = "0.25.90"
 DocStringExtensions = "0.9"
+GeoMakie = "0.7.8"
 Graphs = "1.9"
 IterTools = "1.4.0"
 LinearAlgebra = "1"
-Makie = "0.20, 0.21"
+Makie = "0.21"
 NetworkLayout = "0.4.4"
 PrecompileTools = "1"
 Printf = "1"

ext/QuantumSavoryGeoMakie/QuantumSavoryGeoMakie.jl

@@ -0,0 +1,30 @@
+module QuantumSavoryGeoMakie
+
+import Makie, GeoMakie
+using GeoMakie: GeoAxis, image!, poly!, naturalearth
+
+"""
+Generates a default map with country and state boundaries and returns a GeoAxis. The returned GeoAxis can be used as an input for `registernetplot_axis`.
+
+For borders, the optional `scale` parameter can be set to 10, 50, or 110, corresponding to Natural Earth resolutions of 1:10m, 1:50m, and 1:110m.
+"""
+function generate_map(subfig::Makie.GridPosition, scale::Int=110)
+    if scale ∉ (10, 50, 110)
+        error("Invalid scale value: scale must be 10, 50, or 110.")
+    end
+    ax = GeoAxis(subfig; limits=((-180, 180), (-90, 90)), dest="+proj=longlat +datum=WGS84")
+    countries = naturalearth("admin_0_countries", scale)
+    states = naturalearth("admin_1_states_provinces_lakes", scale)
+    image!(ax, (-180, 180), (-90, 90), GeoMakie.earth() |> rotr90; interpolate=false, inspectable=false)
+    poly!(ax, GeoMakie.land(); color=:lightyellow, strokecolor=:transparent, inspectable=false)
+    poly!(ax, GeoMakie.to_multipoly.(countries.geometry), color=:transparent, strokecolor=:black, strokewidth=1, inspectable=false)
+    poly!(ax, GeoMakie.to_multipoly.(states.geometry); color=:transparent, strokecolor=:grey, strokewidth=0.7, inspectable=false)
+    return ax
+end
+
+function generate_map()
+    fig = Makie.Figure()
+    generate_map(fig[1, 1])
+end
+
+end

ext/QuantumSavoryMakie/QuantumSavoryMakie.jl

@@ -280,27 +280,44 @@
 
 ##
 
-"""Draw the given registers on a given Makie axis.
+"""Draw the given registers on a given Makie axis or a subfigure.
 
 It returns a tuple of (subfigure, axis, plot, observable).
 The observable can be used to issue a `notify` call that updates
 the plot with the current state of the network."""
-function registernetplot_axis(subfig, registersobservable; infocli=true, datainspector=true, kwargs...)
-    ax = Makie.Axis(subfig)
+function registernetplot_axis end
+
+function registernetplot_axis(ax::Makie.AbstractAxis, registersobservable; infocli=true, datainspector=true, map=false, kwargs...)
     p = registernetplot!(ax, registersobservable; kwargs...)
     ax.aspect = Makie.DataAspect()
-    Makie.hidedecorations!(ax)
-    Makie.hidespines!(ax)
+    if hasmethod(Makie.hidedecorations!, Tuple{typeof(ax)})
+        Makie.hidedecorations!(ax)
+    end
+    if hasmethod(Makie.hidespines!, Tuple{typeof(ax)})
+        Makie.hidespines!(ax)
+    end
     Makie.deregister_interaction!(ax, :rectanglezoom)
     if infocli
         rnh = RNHandler(p)
         Makie.register_interaction!(ax, :registernet, rnh)
     end
     if datainspector
-        DataInspector(subfig)
+        DataInspector(ax.parent)
     end
-    Makie.autolimits!(ax)
-    subfig, ax, p, p[1]
+    if hasmethod(Makie.autolimits!, Tuple{typeof(ax)})
+        Makie.autolimits!(ax)
+    end
+    ax.parent, ax, p, p[1]
+end
+
+function registernetplot_axis(subfig::Makie.GridPosition, registersobservable; infocli=true, datainspector=true, kwargs...)
+    registernetplot_axis(Makie.Axis(subfig), registersobservable; infocli, datainspector, kwargs...)
+end
+
+function registernetplot_axis(registersobservable; infocli=true, datainspector=true, kwargs...)
+    fig = Figure()
+    ax = Axis(fig[1, 1])
+    registernetplot_axis(ax, registersobservable; infocli, datainspector, kwargs...)
 end
 
 ##
@@ -358,4 +375,4 @@
     tuple(Makie.shift_project(ax.scene, p.registercoords[][reg].+(0,slot-1))...);
 end
 
-end
+end

src/QuantumSavory.jl

@@ -69,7 +69,7 @@ export
     # noninstant.jl
     AbstractNoninstantOperation, NonInstantGate, ConstantHamiltonianEvolution,
     # plots.jl
-    registernetplot, registernetplot!, registernetplot_axis, resourceplot_axis
+    registernetplot, registernetplot!, registernetplot_axis, resourceplot_axis, generate_map
 
 
 #TODO you can not assume you can always in-place modify a state. Have all these functions work on stateref, not stateref[]

src/plots.jl

@@ -1,24 +1,59 @@
 """Draw the given register network.
 
 Requires a Makie backend be already imported."""
-function registernetplot end
+function registernetplot(args...; kwargs...)
+    ext = Base.get_extension(QuantumSavory, :QuantumSavoryMakie)
+    if isnothing(ext)
+        throw("`registernetplot` requires the package `Makie`; please make sure `Makie` is installed and imported first.")
+    end
+    return ext.registernetplot(args...; kwargs...)
+end
 
 """Draw the given register network on a given Makie axis.
 
 Requires a Makie backend be already imported."""
-function registernetplot! end
+function registernetplot!(args...; kwargs...)
+    ext = Base.get_extension(QuantumSavory, :QuantumSavoryMakie)
+    if isnothing(ext)
+        throw("`registernetplot!` requires the package `Makie`; please make sure `Makie` is installed and imported first.")
+    end
+    return ext.registernetplot!(args...; kwargs...)
+end
 
-"""Draw the given register network on a given Makie subfigure and modify the axis with numerous visualization enhancements.
+"""Draw the given register network on a given Makie axis or subfigure and modify the axis with numerous visualization enhancements.
 
 Requires a Makie backend be already imported."""
-function registernetplot_axis end
+function registernetplot_axis(args...; kwargs...)
+    ext = Base.get_extension(QuantumSavory, :QuantumSavoryMakie)
+    if isnothing(ext)
+        throw("`registernetplot_axis` requires the package `Makie`; please make sure `Makie` is installed and imported first.")
+    end
+    return ext.registernetplot_axis(args...; kwargs...)
+end
 
 """Draw the various resources and locks stored in the given meta-graph on a given Makie axis.
 
 Requires a Makie backend be already imported."""
-function resourceplot_axis end
+function resourceplot_axis(args...; kwargs...)
+    ext = Base.get_extension(QuantumSavory, :QuantumSavoryMakie)
+    if isnothing(ext)
+        throw("`resourceplot_axis` requires the package `Makie`; please make sure `Makie` is installed and imported first.")
+    end
+    return ext.resourceplot_axis(args...; kwargs...)
+end
 
 """Show the metadata tooltip for a given register slot."""
 function showmetadata end
 
 function showonplot end
+
+"""Generates a default map with country and state boundaries and returns a GeoAxis. The returned GeoAxis can be used as an input for registernetplot_axis.
+
+The `GeoMakie` package must be installed and imported."""
+function generate_map(args...; kwargs...)
+    ext = Base.get_extension(QuantumSavory, :QuantumSavoryGeoMakie)
+    if isnothing(ext)
+        throw("`generate_map` requires the package `GeoMakie`; please make sure `GeoMakie` is installed and imported first.")
+    end
+    return ext.generate_map(args...; kwargs...)
+end

test/Project.toml

@@ -7,6 +7,7 @@ DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
+GeoMakie = "db073c08-6b98-4ee5-b6a4-5efafb3259c6"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 IterTools = "c8e1da08-722c-5040-9ed9-7db0dc04731e"

test/test_plotting_3_maps.jl

@@ -0,0 +1,32 @@
+using FileIO
+using GeoMakie
+using QuantumSavory
+
+sizes = [2,3,5]
+registers = Register[]
+for s in sizes
+    traits = [Qubit() for _ in 1:s]
+    bg = [T2Dephasing(1.0) for _ in 1:s]
+    push!(registers, Register(traits,bg))
+end
+network = RegisterNet(registers)
+map_axis = generate_map()
+coords = [Point2f(-71, 42), Point2f(-111, 34), Point2f(-122, 37)]
+_, _, plt, netobs = registernetplot_axis(map_axis, network, registercoords=coords)
+save(File{format"PNG"}(mktemp()[1]), fig)
+
+initialize!(network[1,1])
+initialize!(network[2,1])
+notify(netobs)
+save(File{format"PNG"}(mktemp()[1]), fig)
+
+apply!([network[1,1],network[2,1]], CNOT)
+notify(netobs)
+save(File{format"PNG"}(mktemp()[1]), fig)
+
+display(fig)
+
+fig = Figure()
+map_axis = generate_map(fig[1, 1])
+_, _, plt, netobs = registernetplot_axis(map_axis, network, registercoords=coords)
+save(File{format"PNG"}(mktemp()[1]), fig)

test/test_plotting_cairo.jl

@@ -9,4 +9,7 @@ end
 @testset "arguments and observables and tags" begin
     include("test_plotting_2_tags_observables.jl")
 end
+@testset "background map" begin
+    include("test_plotting_3_maps.jl")
+end
 end

test/test_plotting_gl.jl

@@ -9,6 +9,9 @@ end
 @testset "arguments and observables and tags" begin
     include("test_plotting_2_tags_observables.jl")
 end
+@testset "background map" begin
+    include("test_plotting_3_maps.jl")
+end
 
 @testset "data inspectors" begin # only available in GLMakie
     # create a network of qubit registers