add electron mode

Author: hexaeder

NetworkDynamicsInspector/Project.toml

@@ -15,29 +15,38 @@ OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 WGLMakie = "276b4fcb-3e11-5398-bf8b-a0c2d153d008"
 
+[weakdeps]
+Electron = "a1bb12fb-d4d1-54b4-b10a-ee7951ef7ad3"
+
 [sources]
 NetworkDynamics = {path = ".."}
 
+[extensions]
+ElectronExt = ["Electron"]
+
 [compat]
 Aqua = "0.8.9"
 Bonito = "4.0.0"
 ColorSchemes = "3.29.0"
 Colors = "0.13.0"
+Electron = "6"
 ExplicitImports = "1.10.1"
 GraphMakie = "0.5.14"
 Graphs = "1.12.0"
 NetworkDynamics = "0.9.13"
 Observables = "0.5.5"
 OrderedCollections = "1.8.0"
 SciMLBase = "2.75.1"
-WGLMakie = "0.11"
 Test = "1"
+WGLMakie = "0.11"
 julia = "1.10"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 ExplicitImports = "7d51a73a-1435-4ff3-83d9-f097790105c7"
+ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
+OrdinaryDiffEqTsit5 = "b1df2697-797e-41e3-8120-5422d3b24e4a"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Aqua", "ExplicitImports", "Test"]
+test = ["Aqua", "Electron", "ExplicitImports", "ModelingToolkit", "OrdinaryDiffEqTsit5", "Test"]

NetworkDynamicsInspector/ext/ElectronExt.jl

@@ -0,0 +1,15 @@
+module ElectronExt
+
+using NetworkDynamicsInspector: NetworkDynamicsInspector as NDI
+using Electron: Electron
+using Bonito: Bonito
+
+function NDI.display_electron_app()
+    webapp = NDI.get_webapp()
+    # disp = Bonito.use_electron_display()
+    disp = Bonito.use_electron_display(devtools = true)
+    display(disp, webapp)
+    nothing
+end
+
+end

NetworkDynamicsInspector/src/NetworkDynamicsInspector.jl

@@ -145,8 +145,25 @@ function start_server!(restart=true)
         error("No appstate to restart")
     end
 
-    app = APPSTATE[]
+    webapp = get_webapp()
+
+    SERVER[] = Bonito.Server(webapp, "localhost", 8080)
+    url = SERVER[].url
+    port = SERVER[].port
+    @info "Visit $url:$port to launch App"
+end
 
+function start_electron()
+    if isempty(methods(display_electron_app))
+        @error "Electron.jl not available. Please install Electron.jl and `using Electron` before calling this function."
+    else
+        display_electron_app()
+    end
+end
+function display_electron_app end
+
+function get_webapp()
+    app = APPSTATE[]
     webapp = Bonito.App() do session
         @info "New GUI Session started"
         if !isnothing(SESSION[]) && Base.isopen(SESSION[])
@@ -210,24 +227,20 @@ function start_server!(restart=true)
             class="maingrid"
         )
     end;
-
-    SERVER[] = Bonito.Server(webapp, "localhost", 8080)
-    url = SERVER[].url
-    port = SERVER[].port
-    @info "Visit $url:$port to launch App"
 end
 
 """
-    inspect(sol; restart=false, reset=false)
+    inspect(sol; restart=false, reset=false, electron=false)
 
 Main entry point for gui. Starts the server and serves the app for
 soution `sol`.
 
 - `restart`: If `true`, stop the server if it is running and start a new one.
 - `reset`: If `true`, reset the appstate with the new solution `sol`.
+- `electron`: If `true`, start the app in an electron window (only possible after `using Electron`).
 """
-function inspect(sol; restart=false, reset=false)
-    if restart && server_running()
+function inspect(sol; restart=false, reset=false, electron=false)
+    if (restart || electron) && server_running()
         stop_server!()
     end
     if isnothing(APPSTATE[]) || reset
@@ -236,10 +249,14 @@ function inspect(sol; restart=false, reset=false)
         APPSTATE[].sol[] = sol
     end
 
-    if !server_running()
-        start_server!()
+    if electron
+        start_electron()
     else
-        @info "App still served at $(SERVER[].url):$(SERVER[].port)"
+        if !server_running()
+            start_server!()
+        else
+            @info "App still served at $(SERVER[].url):$(SERVER[].port)"
+        end
     end
     nothing
 end

NetworkDynamicsInspector/test/runtests.jl

@@ -1,19 +1,79 @@
 using Test
 using NetworkDynamics
 using NetworkDynamicsInspector
+using NetworkDynamicsInspector: NetworkDynamicsInspector as NDI
 using ExplicitImports
 using Aqua
+using Electron
+using Bonito
+using OrdinaryDiffEqTsit5
+using NetworkDynamics.Graphs
 
-@testset "Package Quality Tests" begin
-    @test check_no_implicit_imports(NetworkDynamicsInspector) === nothing
-    @test check_no_stale_explicit_imports(NetworkDynamicsInspector) === nothing
+include(joinpath(pkgdir(NetworkDynamics), "test", "ComponentLibrary.jl"))
 
-    Aqua.test_all(NetworkDynamicsInspector;
-        ambiguities=false,
-        stale_deps=true,
-        persistent_tasks=false,
-        piracies = (;treat_as_own = [NetworkDynamics.extract_nw])
-    )
+function get_sol()
+    g = SimpleGraph([0 1 1 0 1;
+                     1 0 1 1 0;
+                     1 1 0 1 0;
+                     0 1 1 0 1;
+                     1 0 0 1 0])
+    vs = [Lib.swing_mtk() for _ in 1:5];
+    set_default!(vs[1], :Pmech, -1)
+    set_default!(vs[2], :Pmech, 1.5)
+    set_default!(vs[3], :Pmech, -1)
+    set_default!(vs[4], :Pmech, -1)
+    set_default!(vs[5], :Pmech, 1.5)
+    ls = [Lib.line_mtk() for _ in 1:7];
+    nw = Network(g, vs, ls)
+    sinit = NWState(nw)
+    s0 = find_fixpoint(nw)
+    set_defaults!(nw, s0)
+
+    # set_position!(vs[1], (0.0, 0.0))
+    set_marker!(vs[1], :dtriangle)
+    set_marker!(vs[2], :utriangle)
+    set_marker!(vs[3], :dtriangle)
+    set_marker!(vs[4], :dtriangle)
+    set_marker!(vs[5], :utriangle)
+
+    cond = ComponentCondition([:P, :₋P, :srcθ], [:limit, :K]) do u, p, t
+        abs(u[:P]) - p[:limit]
+    end
+    affect = ComponentAffect([],[:active]) do u, p, ctx
+        @info "Trip line $(ctx.eidx) between $(ctx.src) and $(ctx.dst) at t=$(ctx.t)"
+        p[:active] = 0
+    end
+    cb = ContinousComponentCallback(cond, affect)
+    set_callback!.(ls, Ref(cb))
+
+    tripfirst = PresetTimeComponentCallback(1.0, affect) # reuse the same affect
+    add_callback!(nw[EIndex(5)], tripfirst)
+
+    nwcb = NetworkDynamics.get_callbacks(nw);
+    s0 = NWState(nw)
+    prob = ODEProblem(nw, uflat(s0), (0,6), copy(pflat(s0)), callback=nwcb)
+    sol = solve(prob, Tsit5())
+end
+
+@testset "NetworkDynamicsInspector.jl Tests" begin
+    @testset "Package Quality Tests" begin
+        @test check_no_implicit_imports(NetworkDynamicsInspector) === nothing
+        @test check_no_stale_explicit_imports(NetworkDynamicsInspector) === nothing
+
+        Aqua.test_all(NetworkDynamicsInspector;
+            ambiguities=false,
+            stale_deps=true,
+            persistent_tasks=false,
+            piracies = (;treat_as_own = [NetworkDynamics.extract_nw])
+        )
+
+        @test_broken isempty(Docs.undocumented_names(NetworkDynamicsInspector))
+    end
+
+    @testset "Test simple app creation" begin
+        sol = get_sol()
+        inspect(sol; electron=true)
+    end
+end
 
-    @test_broken isempty(Docs.undocumented_names(NetworkDynamicsInspector))
 end