v0.3.0

Author: Brad Carman

Project.toml

@@ -1,7 +1,7 @@
 name = "ModelingToolkitDesigner"
 uuid = "23d639d0-9462-4d1e-84fe-d700424865b8"
 authors = ["Brad Carman <[email protected]>"]
-version = "0.2.0"
+version = "0.3.0"
 
 [deps]
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"

README.md

@@ -2,6 +2,12 @@
 
 The ModelingToolkitDesigner.jl package is a helper tool for visualizing and editing ModelingToolkit.jl system connections.  
 
+# Updates
+## v0.3.0
+- Settings Files (*.toml) Updates/Breaking Changes
+    - icon rotation now saved with key `r`, previously was `wall` which was not the best name
+    - connectors nodes now saved with an underscore: `_name`, this helps prevent a collision with nodes named `x`, `y`, or `r`
+
 ## Examples
 Examples can be found in the "examples" folder.
 
@@ -153,14 +159,14 @@ julia> println.(ModelingToolkitDesigner.get_icons(sys.vol, path));
 The first file location comes from the `path` variable.  The second is looking for a folder `icons` in the component parent package, in this case `ModelingToolkitStandardLibrary`, and the third path is from the `icons` folder of this `ModelingToolkitDesigner` package.  The first real file is the chosen icon load path.  Feel free to contribute icons here for any other public component libraries.
 
 ## Icon Rotation
-The icon rotation is controlled by the `wall` atribute in the saved `.toml` design file.  Currently this must be edited by hand.  The default direction is "E" for east.  The image direciton can change to any "N","S","E","W".  For example, to rotate the capacitor icon by -90 degrees (i.e. from "E" to "N") simply edit the design file as
+The icon rotation is controlled by the `r` atribute in the saved `.toml` design file.  Currently this must be edited by hand.  The default direction is "E" for east.  The image direciton can change to any "N","S","E","W".  For example, to rotate the capacitor icon by -90 degrees (i.e. from "E" to "N") simply edit the design file as
 
 ```
 [capacitor]
-n = "S"
+_n = "S"
 x = 0.51
 y = 0.29
-wall = "N"
+r = "N"
 ```
 
 # Colors

examples/design/Main/Circuit.toml

@@ -1,39 +1,39 @@
 [capacitor]
-n = "S"
+_n = "S"
 x = 0.51
 y = 0.29
-wall = "N"
+r = "N"
 
 [constant]
-output = "N"
+_output = "N"
 x = 0.71
 y = -0.08
 
 [ground]
-g = "N"
+_g = "N"
 x = 0.51
 y = -0.08
 
 [pt2]
-p1 = "N"
-p2 = "W"
+_p1 = "N"
+_p2 = "W"
 x = 0.9
 y = 0.11
 
 [pt3]
-p1 = "N"
-p3 = "S"
+_p1 = "N"
+_p3 = "S"
 x = 0.51
 y = 0.11
 
 [resistor]
-n = "W"
-p = "S"
+_n = "W"
+_p = "S"
 x = 0.9
 y = 0.29
 
 [source]
-V = "S"
-n = "W"
+_V = "S"
+_n = "W"
 x = 0.71
 y = 0.11

examples/design/Main/MassSpringDamper.toml

@@ -3,29 +3,29 @@ x = 0.09
 y = 0.15
 
 [dv]
-flange_a = "W"
+_flange_a = "W"
 x = 0.44
 y = 0.2
 
 [gv]
-flange = "W"
+_flange = "W"
 x = 0.82
 y = 0.15
 
 [pt1]
-p1 = "S"
-p3 = "N"
+_p1 = "S"
+_p3 = "N"
 x = 0.65
 y = 0.15
 
 [pt2]
-p1 = "S"
-p2 = "W"
-p3 = "N"
+_p1 = "S"
+_p2 = "W"
+_p3 = "N"
 x = 0.25
 y = 0.15
 
 [sv]
-flange_a = "W"
+_flange_a = "W"
 x = 0.44
 y = 0.1

examples/design/Main/System.jl

@@ -1,4 +1,4 @@
-connect(stp.output, src.input)
+connect(stp.output, src.p)
 connect(src.port, res.port_a)
 connect(vol.port, res.port_b)
 connect(src.port, fluid)

examples/design/Main/System.toml

@@ -3,12 +3,12 @@ x = 0.38
 y = -0.01
 
 [res]
-port_a = "W"
+_port_a = "W"
 x = 0.49
 y = 0.09
 
 [src]
-input = "W"
+_p = "W"
 x = 0.28
 y = 0.09
 
@@ -17,6 +17,6 @@ x = 0.06
 y = 0.09
 
 [vol]
-port = "W"
+_port = "W"
 x = 0.7
 y = 0.09

examples/hydraulic.jl

@@ -21,7 +21,7 @@ import ModelingToolkitStandardLibrary.Blocks as B
     end
 
     eqs = [
-        connect(stp.output, src.input)
+        connect(stp.output, src.p)
         connect(src.port, res.port_a)
         connect(vol.port, res.port_b)
         connect(src.port, fluid)

icons/ModelingToolkitStandardLibrary/Blocks/Sine.png

@@ -277,13 +277,19 @@ function process_children!(
 
 
             if !is_connector
+                #if x and y are missing, add defaults
                 if !haskey(kwargs, "x") & !haskey(kwargs, "y")
                     push!(kwargs_pair, :x => i * 3 * Δh)
                     push!(kwargs_pair, :y => i * Δh)
                 end
+
+                # r => wall for icon rotation
+                if haskey(kwargs, "r")
+                    push!(kwargs_pair, :wall => kwargs["r"])
+                end
             else
-                if haskey(connectors, system.name)
-                    push!(kwargs_pair, :wall => connectors[system.name])
+                if haskey(connectors, safe_connector_name(system.name))
+                    push!(kwargs_pair, :wall => connectors[safe_connector_name(system.name)])
                 end
             end
 
@@ -1113,6 +1119,8 @@ function connection_code(io::IO, design::ODESystemDesign)
 
 end
 
+safe_connector_name(name::Symbol) = Symbol("_$name")
+
 function save_design(design::ODESystemDesign)
 
 
@@ -1127,9 +1135,15 @@ function save_design(design::ODESystemDesign)
             :y => round(y; digits = 2)
         ]
 
+        if component.wall[] != :E
+            push!(pairs, 
+                :r => string(component.wall[])
+            )
+        end
+
         for connector in component.connectors
             if connector.wall[] != :E  #don't use get_wall() here, need to preserve E1, E2, etc
-                push!(pairs, connector.system.name => string(connector.wall[]))
+                push!(pairs, safe_connector_name(connector.system.name) => string(connector.wall[]))
             end
         end