Analyses

In Dyad, an analysis is "the things you can do with a model". A typical workflow in Dyad is to create a set of components, and then create an analysis that runs on the entry point to that set of components. It produces a solution object that provides information about the model, and can be used to build various visualizations.

Analyses can perform a wide variety of model analytics, such as:

• Simulate the model over a given time span

• Auto-tune a PID

• Build an FMU

• Calibrate the model to data

• Run a parameter sweep

and much more. All analyses have a common interface which take in the model, run an analysis, and give back a pre-defined set of artifacts, such as plots of the solution or generated binaries.

Using an Analysis (Dyad Studio)

Dyad Studio includes a lower level interface to define and interact with analyses at the Julia level, with more flexibility than what is exposed in the GUI.

Example: TransientAnalysis of a Simple Block

Using the Dyad-Level Analysis Interface (Dyad Studio)

A TransientAnalysis for the SecondOrderSystemTest component is written in Dyad as:

analysis SecondOrderSystemTransient
  extends TransientAnalysis(stop=5)
  model = DyadExampleComponents.SecondOrderSystemTest()
end

The Dyad compiler will generate the SecondOrderSystemTransient function that will run the analysis.

result = SecondOrderSystemTransient()

Transient Analysis Solution for TransientAnalysis
retcode: Success
Interpolation: 3rd order Hermite
t: 182-element Vector{Float64}:
 0.0
 9.999999999999999e-5
 0.0010999999999999998
 0.008324114235506148
 0.020246779930185234
 0.03253967894598337
 0.047320529812637624
 0.06324562634002115
 0.08110198582213118
 0.10099103713853302
 ⋮
 4.776797022759093
 4.804900620409804
 4.83799448361324
 4.864115348471153
 4.892044049104142
 4.920967923448576
 4.951383245743508
 4.977527261899837
 5.0
u: 182-element Vector{Vector{Float64}}:
 [0.0, 0.0]
 [5.235985172127158e-12, 1.570795034867126e-7]
 [6.96868358226933e-9, 1.9004744117386418e-5]
 [3.0097302167917294e-6, 0.001082229838963192]
 [4.2586980271460544e-5, 0.006225003772697508]
 [0.00017120580283004052, 0.015233187179644574]
 [0.0004966351536118307, 0.029154681007367428]
 [0.001086423955575106, 0.044697643775799545]
 [0.0020147352711609875, 0.05821496992128405]
 [0.003246186171341479, 0.06364655339936032]
 ⋮
 [0.15272489320982, 0.008089192380912012]
 [0.15278920304907562, 0.00037674211351357365]
 [0.1530559990679548, 0.020108237903993548]
 [0.15391424244864715, 0.04548838153343388]
 [0.15546784489516705, 0.06267301888539197]
 [0.1572593431510165, 0.05700223440147551]
 [0.15861955285769966, 0.030448410416964455]
 [0.15909685828945228, 0.0076090530191528305]
 [0.159154823505216, 2.2880449245464218e-7]

We can plot this result, using either Plots.jl or Makie.jl. We'll use Plots here:

using Plots
plot(result)

See the plotting guide for more details on how to plot the results of an analysis.

We can also get artifacts from this result, like:

using DyadInterface: artifacts
artifacts(result, :SimulationSolutionTable)

182×3 DataFrame

Row	timestamp	sys₊integrator2₊x(t)	sys₊integrator1₊x(t)
	Float64	Float64	Float64
1	0.0	0.0	0.0
2	0.0001	5.23599e-12	1.5708e-7
3	0.0011	6.96868e-9	1.90047e-5
4	0.00832411	3.00973e-6	0.00108223
5	0.0202468	4.2587e-5	0.006225
6	0.0325397	0.000171206	0.0152332
7	0.0473205	0.000496635	0.0291547
8	0.0632456	0.00108642	0.0446976
9	0.081102	0.00201474	0.058215
10	0.100991	0.00324619	0.0636466
11	0.125776	0.00473726	0.0537838
12	0.148036	0.00572341	0.033794
13	0.171157	0.00624562	0.0121974
14	0.194759	0.00636544	0.000430447
15	0.221504	0.00641709	0.0069915
16	0.248256	0.00689053	0.0300875
17	0.272923	0.00792576	0.0528233
18	0.298967	0.00948352	0.0636452
19	0.328341	0.011239	0.051857
20	0.355164	0.0123051	0.0266893
21	0.381288	0.0126987	0.00534364
22	0.408378	0.0127355	0.00109621
23	0.443246	0.0131185	0.0251278
24	0.467992	0.014041	0.0488802
25	0.496427	0.0156883	0.0634616
26	0.525747	0.0174681	0.0538047
27	0.554604	0.0186562	0.0272431
28	0.581037	0.0190635	0.00548326
29	0.608976	0.0191024	0.0012572
30	0.644522	0.0195175	0.0263794
31	0.669585	0.0204862	0.0502036
32	0.698461	0.0221837	0.0636246
33	0.728574	0.0239834	0.0516748
34	0.757009	0.0250851	0.0248781
35	0.783841	0.0254429	0.00401422
36	0.812047	0.0254738	0.00225245
37	0.847086	0.0259546	0.0289212
38	0.872224	0.0269876	0.0522924
39	0.901206	0.0287246	0.0636389
40	0.932276	0.0305354	0.048653
41	0.959943	0.0315201	0.0220487
42	0.987171	0.0318199	0.00255035
43	1.01561	0.0318506	0.00375262
44	1.04826	0.0323555	0.0300946
45	1.07386	0.0334405	0.0535211
46	1.10236	0.035164	0.0635745
47	1.13402	0.036985	0.0471496
48	1.16115	0.0379121	0.020908
49	1.18854	0.0381892	0.00203965
50	1.21701	0.0382225	0.00443638
51	1.24885	0.0387394	0.0306795
52	1.27457	0.0398448	0.0540348
53	1.30289	0.0415642	0.0635303
54	1.33482	0.0433888	0.0464402
55	1.36172	0.0442901	0.0203718
56	1.38919	0.0445567	0.00181725
57	1.41768	0.0445917	0.00478456
58	1.44918	0.0451156	0.0310062
59	1.47496	0.0462317	0.0543071
60	1.50321	0.0479504	0.0635002
61	1.5353	0.0497771	0.0460111
62	1.56208	0.0506635	0.0200366
63	1.5896	0.0509235	0.00168247
64	1.61812	0.05096	0.0050191
65	1.64941	0.0514891	0.031241
66	1.67523	0.0526127	0.0545004
67	1.70345	0.0543317	0.0634752
68	1.73568	0.0561604	0.0456754
69	1.76237	0.0570354	0.0197683
70	1.78994	0.0572902	0.00157691
71	1.81848	0.057328	0.00521703
72	1.84962	0.0578617	0.0314464
73	1.87547	0.058992	0.0546679
74	1.90366	0.0607116	0.063451
75	1.93602	0.0625422	0.0453661
76	1.96264	0.0634069	0.0195186
77	1.99025	0.0636569	0.00148093
78	2.01883	0.063696	0.00540815
79	2.04982	0.0642342	0.0316484
80	2.0757	0.065371	0.0548311
81	2.10388	0.0670915	0.0634255
82	2.13637	0.068924	0.045052
83	2.16292	0.0697784	0.0192648
84	2.19057	0.0700235	0.00138576
85	2.21918	0.0700642	0.00560837
86	2.25003	0.0706072	0.0318622
87	2.27595	0.0717508	0.0550018
88	2.30411	0.0734723	0.0633966
89	2.33674	0.0753069	0.0447114
90	2.36322	0.0761503	0.0189903
91	2.39092	0.0763901	0.00128567
92	2.41957	0.0764325	0.00583141
93	2.45027	0.076981	0.0321028
94	2.47623	0.0781323	0.0551915
95	2.50437	0.0798551	0.0633617
96	2.53717	0.0816921	0.0443193
97	2.56356	0.082523	0.0186753
98	2.59133	0.0827568	0.00117466
99	2.62003	0.0828014	0.00609542
100	2.65056	0.0833565	0.0323892
101	2.67656	0.0845167	0.0554141
102	2.70469	0.0862412	0.0633172
103	2.73768	0.0880812	0.043841
104	2.76398	0.0888969	0.0182933
105	2.79182	0.0891235	0.0010456
106	2.82059	0.0891711	0.00642758
107	2.85092	0.0897344	0.0327513
108	2.87697	0.0909059	0.055691
109	2.90509	0.0926327	0.063256
110	2.93835	0.0944765	0.043219
111	2.96453	0.095273	0.0178002
112	2.99246	0.0954903	0.000888483
113	3.02132	0.0955421	0.00687591
114	3.05141	0.0961168	0.0332417
115	3.07753	0.0973034	0.056058
116	3.10564	0.0990335	0.0631642
117	3.13928	0.100882	0.0423452
118	3.1653	0.101653	0.0171155
119	3.19337	0.101857	0.000688617
120	3.22236	0.101916	0.00753719
121	3.25214	0.102507	0.0339662
122	3.27836	0.103716	0.0565848
123	3.30646	0.105451	0.0630096
124	3.34071	0.107308	0.0409901
125	3.36649	0.108038	0.0160722
126	3.39478	0.108224	0.000427735
127	3.42401	0.108295	0.00863717
128	3.45334	0.108915	0.0351653
129	3.47972	0.11016	0.0574179
130	3.50784	0.111904	0.0627026
131	3.54314	0.113771	0.0386429
132	3.56855	0.114436	0.0143172
133	3.59723	0.114591	0.000120917
134	3.62698	0.11469	0.010765
135	3.65562	0.115364	0.037425
136	3.6823	0.116676	0.0588649
137	3.71052	0.118438	0.06194
138	3.74671	0.120269	0.0351156
139	3.77177	0.120844	0.011717
140	3.80091	0.120957	1.32188e-5
141	3.83174	0.121117	0.0145605
142	3.85945	0.121881	0.0411477
143	3.88665	0.123303	0.0609018
144	3.91519	0.125089	0.0601065
145	3.94839	0.126693	0.0334428
146	3.974	0.127235	0.0100396
147	4.00255	0.127324	0.000102644
148	4.03422	0.127522	0.0166934
149	4.06122	0.128321	0.0428187
150	4.08867	0.129793	0.0616663
151	4.11728	0.13158	0.0590871
152	4.14924	0.133087	0.0325923
153	4.17506	0.133611	0.00928433
154	4.20335	0.13369	0.000175924
155	4.23545	0.133909	0.0177848
156	4.2621	0.134726	0.0436461
157	4.28969	0.136222	0.062006
158	4.31835	0.138009	0.0585202
159	4.34978	0.139471	0.0320532
160	4.37568	0.139983	0.00884543
161	4.40387	0.140056	0.000235852
162	4.43629	0.140291	0.018544
163	4.46275	0.14112	0.0442421
164	4.49044	0.142635	0.062236
165	4.51916	0.144423	0.0580675
166	4.55024	0.145852	0.0315902
167	4.57622	0.146354	0.0084782
168	4.60436	0.146423	0.000298212
169	4.63708	0.146672	0.0192666
170	4.66338	0.147515	0.0448184
171	4.69117	0.149047	0.062446
172	4.71998	0.150837	0.0575937
173	4.75074	0.152234	0.0310876
174	4.7768	0.152725	0.00808919
175	4.8049	0.152789	0.000376742
176	4.83799	0.153056	0.0201082
177	4.86412	0.153914	0.0454884
178	4.89204	0.155468	0.062673
179	4.92097	0.157259	0.0570022
180	4.95138	0.15862	0.0304484
181	4.97753	0.159097	0.00760905
182	5.0	0.159155	2.28804e-7

For the artifacts allowed for a given analysis, see the pages which define the given analysis.

Defining and Running an Analysis

Any analysis is available and meant to run in Julia. For an analysis called MyAnalysis in Dyad, the generated Julia code will be created with the following format:

result = MyAnalysis(; kwargs...)

where the kwargs are keyword arguments corresponding to the arguments of the analysis run definition (i.e. the fields that can be set at the Dyad level). This invocation will be set to automatically have the keyword arguments default to the values defined in the Dyad version, for example for a TransientAnalysis if one had set stop = 10.0, then stop = 10.0 will be the default value in the generated function. These defaults can thus be overruled by declaring the keyword argument, for example MyAnalysis(; stop=20.0) will run a version of the analysis which overrides the stop time to 20.0.

Analysis Result Interface

The analysis results can be interacted with in two ways: there are the customizable plot and the artifacts. The most basic usage is to get the artifacts via:

artifacts(result, name::Symbol)

The allowed artifacts can be queried via:

artifacts(results)

which returns a list of all the available artifact names. For more details about all the artifacts,

AnalysisSolutionMetadata(result)

can be used, which also includes descriptions for all the artifacts.

Additionally, some analyses include a customizable visualization:

customizable_visualization(::AbstractAnalysisSolution, ::PlotlyVisualizationSpec)

This will be defined fully in future versions.

Defining Your Own Analysis

At the lowest level, analyses are implemented in Julia, see the Custom analysis tutorial for more details on how to write your own.