Feature: projects with live sync, selections of several, groups

.github/workflows/CompatHelper.yml

@@ -0,0 +1,20 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      # The runner image ships no Julia
+      - uses: julia-actions/setup-julia@v3
+        with:
+          version: '1'
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia -e 'using CompatHelper; CompatHelper.main(; subdirs = ["", "test", "docs"])'

AGENTS.md

@@ -1,6 +1,6 @@
 # BeamletOpticsGUI.jl: developer instructions for coding agents
 
-The interactive GUI of [BeamletOptics.jl](https://github.com/JuliaPhysics/BeamletOptics.jl) (BMO):
+The interactive GUI of [BeamletOptics.jl](https://github.com/StackEnjoyer/BeamletOptics.jl) (BMO):
 `live_view` and the tools around it (kinematic controls, view cube, cards, custom panels, controls
 and tools), built on Makie. BMO does the physics and draws the components; this package arranges
 them into an interactive window.
@@ -174,8 +174,9 @@ describe it as available in docs or the skill.
 
 ## Releases
 
-The users of a registered version get BeamletOptics from the registry: Pkg reads `[sources]` only
-in the active project, never in a dependency. The entries stay in the registered version; the
+The users of a registered version get BeamletOptics from the registry: Pkg reads `[sources]` of
+the active project and of dependencies tracked by path, never of a registered dependency (checked
+on Julia 1.13). The entries stay in the registered version; the
 docs of a tag remove them and use the registered BMO. BMO and the GUI are released together: the
 latest registered GUI works with the latest registered BMO.
 

Project.toml

@@ -1,6 +1,6 @@
 name = "BeamletOpticsGUI"
 uuid = "d62ba671-5e61-47cc-8a7f-19d21d414e61"
-version = "0.3.0"
+version = "0.3.1"
 authors = ["Hugo Uittenbosch <hugo.uittenbosch@dlr.de>, Oliver Kliebisch <oliver.kliebisch@dlr.de> and Thomas Dekorsy <thomas.dekorsy@dlr.de>"]
 
 [workspace]
@@ -9,12 +9,16 @@ projects = ["test", "docs"]
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
 BeamletOptics = "c387492b-ffec-4e51-9a46-bd230226031c"
+BeamletOpticsProjects = "cd81f88b-d4c6-44ce-ae16-166b70b38414"
+FileWatching = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
 GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
+NativeFileDialog = "e1fe445b-aa65-4df4-81c1-2041507f0fd4"
 PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
 Preferences = "21216c6a-2e73-6563-6e65-726566657250"
+TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
 
 [weakdeps]
 GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
@@ -23,16 +27,21 @@ GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
 BeamletOpticsGUIGLMakieExt = "GLMakie"
 
 [sources]
-BeamletOptics = {url = "https://github.com/JuliaPhysics/BeamletOptics.jl", rev = "master"}
+BeamletOptics = {url = "https://github.com/StackEnjoyer/BeamletOptics.jl", rev = "master"}
+BeamletOpticsProjects = {url = "https://github.com/StackEnjoyer/BeamletOpticsProjects.jl", rev = "feature/own-types"}
 
 [compat]
 AbstractTrees = "0.4"
-BeamletOptics = "0.14"
+BeamletOptics = "0.14.1"
+BeamletOpticsProjects = "0.1"
+FileWatching = "1"
 GLMakie = "0.13"
 GeometryBasics = "0.5"
 InteractiveUtils = "1"
 LinearAlgebra = "1"
 Makie = "0.24"
+NativeFileDialog = "0.2"
 PrecompileTools = "1"
 Preferences = "1"
+TOML = "1"
 julia = "1.12"

README.md

@@ -10,7 +10,7 @@
 [![codecov](https://codecov.io/gh/StackEnjoyer/BeamletOpticsGUI.jl/graph/badge.svg)](https://codecov.io/gh/StackEnjoyer/BeamletOpticsGUI.jl)
 [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
-Interactive GUI for [BeamletOptics.jl](https://github.com/JuliaPhysics/BeamletOptics.jl): move the
+Interactive GUI for [BeamletOptics.jl](https://github.com/StackEnjoyer/BeamletOptics.jl): move the
 components of an optical setup with the mouse and keyboard, and see the beams and detector signals
 update live. BeamletOptics computes the physics and draws the components; this package arranges
 them into an interactive window.

benchmark/drive_io.jl

@@ -0,0 +1,47 @@
+# How long the file accesses of a project take on a drive: the accesses that the window does on its
+# own thread (the autosave, the look of the watcher, the presence), one by one, without the GUI.
+# Run it on each machine with a folder on the shared drive (and once with a folder on the local
+# disk to compare); it writes only into `<folder>/drive-io-<host>`, which it removes at the end.
+#
+#     julia benchmark/drive_io.jl <folder> [n = 40]
+#
+# Prints per access the median and the maximum in ms. Only the standard library is needed.
+using Printf
+
+const DIR = joinpath(abspath(ARGS[1]), "drive-io-" * gethostname())
+const N = length(ARGS) >= 2 ? parse(Int, ARGS[2]) : 40
+
+median(x) = (s = sort(x); n = length(s); isodd(n) ? s[(n + 1) ÷ 2] : (s[n ÷ 2] + s[n ÷ 2 + 1]) / 2)
+
+function measure()
+    rm(DIR; recursive = true, force = true)
+    mkpath(joinpath(DIR, "sub"))
+    text = repeat("@component L1 = SphericalLens(0.05, -0.05, 0.005, 0.0254, ConstantRefractiveIndex(1.5)) pos = (0.0, 0.1, 0.0)\n", 30)
+    file = joinpath(DIR, "system.jl")
+    write(file, text)
+    for i in 1:10
+        write(joinpath(DIR, "sub", "f$i.toml"), "x = $i\n")
+    end
+    ops = [
+        "isfile" => () -> isfile(file),
+        "mtime" => () -> mtime(file),
+        "read 3 KB" => () -> read(file, String),
+        "readdir (10 files)" => () -> readdir(joinpath(DIR, "sub")),
+        "write in place" => () -> write(file, text),
+        "write tmp + rename" => () -> (tmp = file * ".tmp"; write(tmp, text); mv(tmp, file; force = true)),
+        "create + remove" => () -> (f = joinpath(DIR, "lock"); write(f, "x"); rm(f)),
+        "mkdir + rmdir" => () -> (d = joinpath(DIR, "d"); mkdir(d); rm(d)),
+    ]
+    println("folder: ", DIR, ", ", N, " times each")
+    for (name, f) in ops
+        f()
+        t = Float64[]
+        for _ in 1:N
+            push!(t, @elapsed f())
+        end
+        @printf("%-20s median %8.2f ms   max %8.2f ms\n", name, 1000 * median(t), 1000 * maximum(t))
+    end
+    rm(DIR; recursive = true, force = true)
+end
+
+measure()

benchmark/save_io.jl

@@ -0,0 +1,54 @@
+# The parts of an autosave after a change, on the local disk and over SMB, to find the file
+# accesses that cost the thread of the window.
+#
+#     julia --project=test benchmark/save_io.jl <project folder on C:> [<folder on a drive>]
+#
+# Without the second folder, the copy of the project is measured on the local disk and through
+# \\localhost\C$\...; with it, on the local disk and in a copy inside that folder (e.g. a folder on a
+# shared drive), which is removed at the end.
+using GLMakie, BeamletOptics, BeamletOpticsGUI, BeamletOpticsProjects
+const G = BeamletOpticsGUI
+const P = BeamletOpticsProjects
+
+ms(t) = round(1000t; digits = 1)
+
+copy_dir = joinpath(mktempdir(), basename(ARGS[1]))
+cp(ARGS[1], copy_dir)
+rm(joinpath(copy_dir, ".bmo"); force = true, recursive = true)
+remote = if length(ARGS) >= 2
+    d = joinpath(abspath(ARGS[2]), "save-io-" * gethostname(), basename(ARGS[1]))
+    rm(dirname(d); recursive = true, force = true)
+    mkpath(dirname(d))
+    cp(copy_dir, d)
+    d
+else
+    raw"\\localhost\C$" * copy_dir[3:end]
+end
+try
+    for dir in (copy_dir, remote)
+        t_open = @elapsed(gui = open_project(dir; display = false, trace_budget = Inf, throttle = false, detectors = []))
+        obj = first(x for x in keys(gui.sync.ids) if haskey(gui.components.origin, x))
+        times = Dict{String, Float64}()
+        for i in 1:4
+            G.translate3d!(gui, obj, [0.0, 0.0, 1e-4])
+            t = Dict(
+                "project_stamp" => @elapsed(P.project_stamp(dir)),
+                "file_marks" => @elapsed(G._file_marks(dir)),
+                "project_parts" => @elapsed(G._project_parts(gui, dir; name = gui.sync.base.name)),
+                "save_project" => @elapsed(save_project(gui, dir)),
+                "write_presence" => @elapsed(G._write_presence!(gui)),
+                "write_session" => @elapsed(G._write_session!(gui)),
+                "files_look" => @elapsed(G._files_look(dir; stamp = true, except = G._person().id, known = String[])),
+                "claims" => @elapsed(P.claims(dir)),
+            )
+            i > 1 && mergewith!(+, times, t)
+        end
+        println(dir, "   (open_project ", ms(t_open), " ms, the first time compiles)")
+        for (k, v) in sort(collect(times); by = last, rev = true)
+            println("  ", rpad(k, 16), ms(v / 3), " ms")
+        end
+        close(gui)
+    end
+finally
+    length(ARGS) >= 2 && rm(dirname(remote); recursive = true, force = true)
+end