attempt screenshot in docs

Author: hexaeder

.github/workflows/Documentation.yaml

@@ -19,6 +19,10 @@ jobs:
       contents: write
       statuses: write
     steps:
+      - name: Install xvfb
+        run: |
+          sudo apt update
+          sudo apt install -y xvfb mesa-utils mesa-vulkan-drivers dbus x11-xserver-utils
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
         with:
@@ -35,6 +39,11 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+          LIBGL_ALWAYS_SOFTWARE: "1"
+          MESA_GL_VERSION_OVERRIDE: "4.5"
+          MESA_GLSL_VERSION_OVERRIDE: "450"
+        with:
+          prefix: xvfb-run --auto-servernum
       - name: Run doctests
         shell: julia --project=docs --color=yes {0}
         run: |

NetworkDynamicsInspector/src/serving.jl

@@ -34,6 +34,7 @@ function serve_app(display, app)
     end
 end
 close_display(::Nothing; kwargs...) = nothing
+close_display() = close_display(CURRENT_DISPLAY[]; strict=true)
 
 ####
 #### Server Display
@@ -132,8 +133,9 @@ function get_electron_app end
 function get_electron_window end
 
 function save_electron_screenshot(path=joinpath(@__DIR__, "screenshot.png"))
+    path = isabspath(path) ? path : joinpath(pwd(), path)
     has_electron_window()|| error("No Electron window exists!")
-    winid = NDI.get_electron_window().id
+    winid = get_electron_window().id
     js = """
     let win = BrowserWindow.fromId($winid)
     win.webContents.capturePage().then(image => {
@@ -142,6 +144,7 @@ function save_electron_screenshot(path=joinpath(@__DIR__, "screenshot.png"))
         console.log('Screenshot saved to ', screenshotPath);
     });
     """
-    d = run(NDI.get_electron_app(), js)
-    path
+    wait_for()
+    d = run(get_electron_app(), js)
+    nothing
 end

docs/Project.toml

@@ -7,13 +7,15 @@ Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 DynamicQuantities = "06fc5a27-2a28-4c7c-a15d-362465fb6821"
+Electron = "a1bb12fb-d4d1-54b4-b10a-ee7951ef7ad3"
 GraphMakie = "1ecd5474-83a3-4783-bb4f-06765db800d2"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LinearInterpolations = "b20c7882-2490-4592-a606-fbbfe9e745e8"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
 NetworkDynamics = "22e9dc34-2a0d-11e9-0de0-8588d035468b"
+NetworkDynamicsInspector = "0a4713f2-d58f-43f2-b63b-1b5d5ee4e65a"
 OrdinaryDiffEqNonlinearSolve = "127b3ac7-2247-4354-8eb6-78cf4e7c58e8"
 OrdinaryDiffEqRosenbrock = "43230ef6-c299-4910-a778-202eb28ce4ce"
 OrdinaryDiffEqSDIRK = "2d112036-d095-4a1e-ab9a-08536f3ecdbf"
@@ -30,6 +32,7 @@ SymbolicIndexingInterface = "2efcf032-c050-4f8e-a9bb-153293bab1f5"
 
 [sources]
 NetworkDynamics = {path = ".."}
+NetworkDynamicsInspector = {path = "../NetworkDynamicsInspector"}
 
 [compat]
 CairoMakie = "0.13.1"

docs/make.jl

@@ -1,7 +1,8 @@
-ENV["GKSwstype"] = "100" # needed for plotting with GitHub Actions and GR (?)
+# ENV["GKSwstype"] = "100" # needed for plotting with GitHub Actions and GR (?)
 
 using Documenter
 using NetworkDynamics
+using NetworkDynamicsInspector
 using SciMLBase
 using Literate
 using ModelingToolkit
@@ -29,7 +30,7 @@ mtkext = Base.get_extension(NetworkDynamics, :MTKExt)
 kwargs = (;
     root=joinpath(pkgdir(NetworkDynamics), "docs"),
     sitename="NetworkDynamics",
-    modules=[NetworkDynamics, mtkext],
+    modules=[NetworkDynamics, mtkext, NetworkDynamicsInspector],
     linkcheck=true, # checks if external links resolve
     pagesonly=true,
     plugins=[links],
@@ -44,6 +45,7 @@ kwargs = (;
             "callbacks.md",
             "mtk_integration.md",
             "external_inputs.md",
+            "inspector.md",
         ],
         "API.md",
         "Tutorials" => [

docs/src/inspector.md

@@ -0,0 +1,68 @@
+# NetworkDynamicsInspector
+
+```@example ndi
+using NetworkDynamics
+using NetworkDynamicsInspector
+using NetworkDynamicsInspector: NetworkDynamicsInspector as NDI #hide
+using Electron # hide
+using OrdinaryDiffEqTsit5
+using Graphs
+
+include(joinpath(pkgdir(NetworkDynamics), "test", "ComponentLibrary.jl"))
+function get_sol(;limit=1.0)
+    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)
+    s0.p.e[:, :limit] .= limit
+
+    prob = ODEProblem(nw, uflat(s0), (0,6), copy(pflat(s0)), callback=nwcb)
+    sol = solve(prob, Tsit5())
+end
+
+sol = get_sol()
+
+
+
+NDI.CURRENT_DISPLAY[] = ElectronDisp(resolution=(1000,1000)) # hide
+@info "open gui"
+inspect(sol)
+NDI.save_electron_screenshot("screenshot.png")
+NDI.close_display()
+```
+![screenshot](screenshot.png)