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

• Analyze the stability of a controller

• Run a parameter sweep

• Build an FMU

• Calibrate the model to data

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 the Julia-Level Analysis Interface (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]
 [1.570795034867126e-7, 5.235985172127158e-12]
 [1.9004744117386418e-5, 6.96868358226933e-9]
 [0.001082229838963192, 3.0097302167917294e-6]
 [0.006225003772697508, 4.2586980271460544e-5]
 [0.015233187179644574, 0.00017120580283004052]
 [0.029154681007367428, 0.0004966351536118307]
 [0.044697643775799545, 0.001086423955575106]
 [0.05821496992128405, 0.0020147352711609875]
 [0.06364655339936032, 0.003246186171341479]
 ⋮
 [0.008089192380912012, 0.15272489320982]
 [0.00037674211351357365, 0.15278920304907562]
 [0.020108237903993548, 0.1530559990679548]
 [0.04548838153343388, 0.15391424244864715]
 [0.06267301888539197, 0.15546784489516705]
 [0.05700223440147551, 0.1572593431510165]
 [0.030448410416964455, 0.15861955285769966]
 [0.0076090530191528305, 0.15909685828945228]
 [2.2880449245464218e-7, 0.159154823505216]

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

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.