Merge pull request #126 from OpenSourceAWE/makie-sysstate

Add sysstate conversion functions and plotting for the SysLog

Author: 1-Bart-1

.github/workflows/CI.yml

@@ -33,6 +33,7 @@ jobs:
         version:
           - '1'      # Latest stable release
           - 'lts'    # Long-term support release
+          - 'pre'
         os:
           - ubuntu-latest
           - windows-latest

.gitignore

@@ -8,6 +8,9 @@
 *.xopp
 *.so
 *.so.bak
+.claude
+AGENTS.md
+CLAUDE.md
 Manifest.toml
 Manifest*.toml
 Manifest*.default

Project.toml

@@ -22,24 +22,23 @@ Parameters = "d96e819e-fc66-5662-9728-84c9c7592b0a"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
-REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
+Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 Rotations = "6038ab10-8711-5258-84ad-4b1120ba62dc"
 SHA = "ea8e919c-243c-51af-8825-aaa63cd721ce"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 SciMLOperators = "c0aeaf25-5076-4817-a8d5-81caf7dfa961"
-Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 SteadyStateDiffEq = "9672c7b4-1e72-59bd-8a11-6ac3964bc41f"
 Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb"
 SymbolicIndexingInterface = "2efcf032-c050-4f8e-a9bb-153293bab1f5"
 SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
-TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
 Tar = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
 Timers = "21f18d07-b854-4dab-86f0-c15a3821819a"
+TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
 UnPack = "3a884ed6-31ef-47d7-9d2a-63182c4928ed"
 VortexStepMethod = "ed3cd733-9f0f-46a9-93e0-89b8d4998dd9"
 
@@ -52,15 +51,12 @@ SymbolicAWEModelsControlPlotsExt = "ControlPlots"
 SymbolicAWEModelsMakieExt = "Makie"
 
 [compat]
-Aqua = "0.8.13"
 AtmosphericModels = "0.3.2"
-BenchmarkTools = "1.6"
 CodecZlib = "0.7.8"
 ControlPlots = "0.2.4"
 ControlSystemsBase = "1.18.1"
 DiffEqBase = "6.161.0"
 DocStringExtensions = "0.9.4"
-Documenter = "1.10.1"
 KiteUtils = "0.11.0"
 LaTeXStrings = "1.4.0"
 LinearAlgebra = "1"
@@ -75,37 +71,23 @@ Parameters = "0.12"
 Pkg = "1"
 PrecompileTools = "1.2.1"
 Printf = "1"
-REPL = "1"
 RecipesBase = "1.3.4"
+Serialization = "1"
 Reexport = "1.1, 1.2"
 Rotations = "1.7"
 SHA = "0.7.0"
 SciMLBase = "2.82.1"
 SciMLOperators = "0.3.13, 1"
-Serialization = "1"
 StaticArrays = "1.9.7"
 Statistics = "1"
 StatsBase = "0.34"
 SteadyStateDiffEq = "2.5"
 Suppressor = "0.2.8"
 SymbolicIndexingInterface = "0.3"
 SymbolicUtils = "~3.29"
-TOML = "1.0.3"
 Tar = "1.10.0"
-Test = "1"
 Timers = "0.1.5"
+TOML = "1"
 UnPack = "1.0.2"
 VortexStepMethod = "2.3.0"
-julia = "1"
-
-[extras]
-Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
-BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
-Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
-StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
-TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-
-[targets]
-test = ["Test", "BenchmarkTools", "Documenter", "Makie", "StatsBase", "Aqua", "TOML"]
+julia = "1.10"

docs/src/exported_types.md

@@ -58,6 +58,9 @@ Tether(idx, segment_idxs, winch_idx)
 Winch
 Winch(idx, set::Settings, tether_idxs; tether_len, tether_vel, brake)
 Winch(idx, tether_idxs, gear_ratio, drum_radius, f_coulomb, c_vf, inertia_total; tether_len, tether_vel, brake)
+AbstractWing
+BaseWing
+VSMWing
 Wing
 Wing(idx, vsm_aero, vsm_wing, vsm_solver, group_idxs, R_b_c, pos_cad; transform_idx)
 Transform
@@ -70,5 +73,6 @@ Transform(idx, set, base_point_idx; kwargs...)
 ```@docs
 SysState
 update_sys_state!
+update_from_sysstate!
 ```
 

docs/src/tutorial_system_structure.md

@@ -64,7 +64,7 @@ transforms = [Transform(1, deg2rad(-80), 0.0, 0.0;
               rot_point_idx=points[end].idx)]
 ```
 
-From the points, segments and transform we create a [`SystemStructure(name, set)`](@ref), which can be plotted in 2d to quickly investigate if the model is correct.
+From the points, segments and transform we create a [`SystemStructure(name, set)`](@ref), which can be plotted in 3D to quickly investigate if the model is correct.
 ```julia
 sys_struct = SystemStructure("tether", set; points, segments, transforms)
 plot(sys_struct, 0.0)
@@ -76,9 +76,10 @@ If the system looks good, we can easily model it, by first creating a [`Symbolic
 sam = SymbolicAWEModel(set, sys_struct)
 
 init!(sam; remake=false)
+plot(sys_struct, 0.0)  # Create initial plot
 for i in 1:80
-    plot(sam, i/set.sample_freq)
     next_step!(sam)
+    plot(sys_struct, i/set.sample_freq)  # Update plot
 end
 ```
 ![Tether during simulation](assets/tether_during_sim.png)
@@ -99,18 +100,19 @@ using WinchModels
 winches = [Winch(1, set, [1])]
 ```
 
-The 2d plot of the [`SystemStructure`](@ref) should still look the same, so we don't have to plot that. We can just create the system, and simulate it. We just need to be sure that we call plot with `t=0.0` to reset the plot.
+The plot of the [`SystemStructure`](@ref) should still look the same, so we don't have to plot that. We can just create the system, and simulate it. We call `plot(sys_struct, 0.0)` to create a new plot.
 
 ```julia
 sys_struct = SystemStructure("winch", set; points, segments, tethers, winches, transforms)
 sam = SymbolicAWEModel(set, sys_struct)
 init!(sam; remake=false)
 ss = SysState(sam)
 
+plot(sys_struct, 0.0)  # Create initial plot
 for i in 1:80
-    plot(sam, (i-1)/set.sample_freq)
     next_step!(sam; set_values=[-20.0])
     update_sys_state!(ss, sam)
+    plot(sys_struct, i/set.sample_freq)  # Update plot
 end
 ```
 
@@ -157,17 +159,18 @@ We can then use a [`Transform`](@ref) to describe the orientation of the initial
 ```julia
 transforms = [Transform(1, -deg2rad(0.0), 0.0, 0.0; base_pos=[1.0, 0.0, 4.0], base_point_idx=1, rot_point_idx=2)]
 sys_struct = SymbolicAWEModels.SystemStructure("pulley", set; points, segments, pulleys, transforms)
-plot(sys_struct, 0.0; zoom=false, l_tether=set.l_tether)
+plot(sys_struct, 0.0)
 ```
 
 If the plot of the [`SystemStructure`](@ref) looks good, we can continue by creating a [`SymbolicAWEModel`](@ref) and simulating through time.
 
 ```julia
 sam = SymbolicAWEModel(set, sys_struct)
 init!(sam; remake=false)
+plot(sys_struct, 0.0)  # Create initial plot
 for i in 1:100
-    plot(sam, i/set.sample_freq; zoom=false)
     next_step!(sam)
+    plot(sys_struct, i/set.sample_freq)  # Update plot
 end
 ```
 

examples/Project.toml

@@ -2,5 +2,7 @@
 ControlSystemsBase = "aaaaaaaa-a6ca-5380-bf3e-84a91bcd477e"
 GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
 KiteUtils = "90980105-b163-44e5-ba9f-8b1c83bb0533"
+Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
 ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
 SymbolicAWEModels = "9c9a347c-5289-41db-a9b9-25ccc76c3360"
+VortexStepMethod = "ed3cd733-9f0f-46a9-93e0-89b8d4998dd9"

examples/ram_air_kite.jl

@@ -34,4 +34,5 @@ end
 
 sl, _ = sim_oscillate!(sam; dt, total_time, vsm_interval, steering_freq, steering_magnitude, 
                        bias, prn=true)
-display(plot(sam.sys_struct, sl))
+# display(plot(sam.sys_struct, sl))
+replay(sl, sam.sys_struct)