You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/inspector.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Interactive Solution Inspection
2
2
3
-
Interactive solution inspection tool based on [WGLMakie](https://makie.org/website/) and [Bonito](https://github.com/SimonDanisch/Bonito.jl)are provided through the helper package `NetworkDynamicsInspector`.
3
+
An interactive solution inspection tool based on [WGLMakie](https://makie.org/website/) and [Bonito](https://github.com/SimonDanisch/Bonito.jl)is provided through the helper package `NetworkDynamicsInspector`.
4
4
5
-
Firstoff, we need to define the system we want to interactively inspect.
5
+
First, we need to define the system we want to inspect.
6
6
7
7
!!! details "Define some network, simulate it and get a solution object"
8
8
```@example ndi
@@ -63,7 +63,7 @@ Firstoff, we need to define the system we want to interactively inspect.
63
63
sol = get_sol()
64
64
```
65
65
66
-
No that we have and`ODESolution``sol`, we can call [`inspect`](@ref) to open the inspector gui. In the docstring you can find several options to chose how the app is displayed.
66
+
Now that we have an`ODESolution``sol`, we can call [`inspect`](@ref) to open the inspector GUI. The docstring provides several options to customize how the app is displayed.
Internally, the `NetworkDynamicsInspector`holds a global reference to an object `AppState`. This AppState reflects the changes the user made to the GUI and can be also altered programmaticially.
80
+
## Programmatic Access and GUI State Manipulation
81
+
Internally, the `NetworkDynamicsInspector`maintains a global reference to an `AppState` object. This AppState reflects changes made to the GUI by the user and can also be modified programmatically.
82
82
83
-
See [NetworkDynamicsInspector API](@ref) for a list of all available function.
84
-
As a good starting point, there is a function [`dump_app_state`](@ref)
85
-
which helps you to recreate the GUI state which was previously adjusted by hand.
83
+
See the [NetworkDynamicsInspector API](@ref) for a complete list of available functions.
84
+
A good starting point is the [`dump_app_state`](@ref) function, which helps you recreate a GUI state that was previously configured manually.
86
85
87
-
Lets say we've adjuste the appstate to include another timeseries plot for the node states.
86
+
Let's say we've adjusted the AppState to include an additional time series plot for the node states.
0 commit comments