MANUAL

Analyses

Download as a Dyad projecttransient_man.zipOpen in Dyad Studio›

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 DyadExampleComponents.SecondOrderSystemTest
with 2 differential equations and 0 algebraic equations

retcode: Success
Interpolation: 3rd order Hermite
t: 182-element Vector{Float64}: [0.0, 9.999999999999999e-5 … 4.994457388635665, 5.0]
u: 182-element Vector{Vector{Float64}}:
 [0.0, 0.0]
 [1.5708e-7, 5.23599e-12]
 [0.000218625, 2.72156e-7]
 [0.00306923, 1.45132e-5]
 [0.0104177, 9.42496e-5]
 [0.0224379, 0.000319948]
 [0.037897, 0.000791181]
 [0.0530897, 0.00157842]
 [0.0627454, 0.00269796]
 [0.0604399, 0.00408712]
 ⋮
 [0.000750196, 0.152786]
 [0.00732454, 0.152843]
 [0.0337494, 0.153429]
 [0.056428, 0.154631]
 [0.0630568, 0.156366]
 [0.041306, 0.158224]
 [0.0163165, 0.158963]
 [0.000481232, 0.159153]
 [-1.06822e-7, 0.159154]

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 below 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₊y(t)	sys₊integrator2₊y(t)
	Float64	Float64	Float64
1	0.0	0.0	0.0
2	0.0001	1.5708e-7	5.23599e-12
3	0.00373284	0.000218625	2.72156e-7
4	0.0140931	0.00306923	1.45132e-5
5	0.0265126	0.0104177	9.42496e-5
6	0.040465	0.0224379	0.000319948
7	0.0561033	0.037897	0.000791181
8	0.073279	0.0530897	0.00157842
9	0.0923426	0.0627454	0.00269796
10	0.114446	0.0604399	0.00408712
11	0.139493	0.0421486	0.0053987
12	0.161434	0.0206412	0.00608715
13	0.185255	0.0033547	0.00634959
14	0.210064	0.00157775	0.00637151
15	0.242371	0.0242746	0.00673065
16	0.265738	0.0469351	0.00756681
17	0.29279	0.0628487	0.00909223
18	0.320343	0.0573799	0.0108012
19	0.349821	0.0320102	0.0121483
20	0.375266	0.00913586	0.0126555
21	0.4026	0.000106104	0.0127325
22	0.433885	0.0163957	0.0129249
23	0.460257	0.0419117	0.0136894
24	0.487363	0.0611863	0.0151215
25	0.51542	0.0599993	0.0168782
26	0.54796	0.0338691	0.0184532
27	0.573421	0.0104665	0.0190036
28	0.601658	4.31658e-5	0.0190986
29	0.632747	0.0154106	0.019273
30	0.659841	0.0415157	0.0200382
31	0.687015	0.0610499	0.0214664
32	0.715345	0.0600341	0.0232399
33	0.748159	0.0336709	0.0248261
34	0.77373	0.0102389	0.025373
35	0.802116	7.03303e-5	0.0254648
36	0.833484	0.0160465	0.0256507
37	0.86053	0.0421703	0.0264332
38	0.887841	0.0613676	0.0278831
39	0.916306	0.0595761	0.0296635
40	0.948641	0.0331899	0.0312084
41	0.974344	0.00979164	0.0317454
42	1.00266	0.000111409	0.0318311
43	1.03433	0.0167843	0.0320308
44	1.0612	0.0427971	0.0328277
45	1.08861	0.0616474	0.0342969
46	1.11715	0.0591531	0.0360798
47	1.14906	0.0327689	0.0375885
48	1.17485	0.0094268	0.0381165
49	1.2031	0.000151029	0.0381973
50	1.235	0.0173834	0.0384085
51	1.26172	0.043286	0.0392164
52	1.28922	0.0618539	0.0407005
53	1.3178	0.058811	0.0424846
54	1.34941	0.0324221	0.043966
55	1.37526	0.00913812	0.0444865
56	1.40346	0.000187896	0.0445636
57	1.43556	0.0178846	0.0447846
58	1.46215	0.0436925	0.0456016
59	1.48973	0.0620187	0.0470981
60	1.51836	0.0585128	0.0488834
61	1.54972	0.0321122	0.0503422
62	1.57562	0.00888629	0.0508559
63	1.60378	0.00022475	0.0509298
64	1.63608	0.0183493	0.0511601
65	1.66256	0.0440698	0.0519857
66	1.6902	0.0621661	0.0534939
67	1.71888	0.0582233	0.0552802
68	1.75003	0.0318055	0.0567182
69	1.77598	0.00864151	0.0572252
70	1.80411	0.000265084	0.0572961
71	1.8366	0.0188271	0.0575361
72	1.86298	0.0444568	0.0583705
73	1.8907	0.0623116	0.0598907
74	1.91943	0.0579129	0.0616782
75	1.95036	0.0314726	0.063095
76	1.97636	0.00838044	0.0635947
77	2.00447	0.000313217	0.0636624
78	2.03719	0.0193644	0.0639135
79	2.06346	0.0448902	0.0647578
80	2.09125	0.0624673	0.0662916
81	2.12006	0.0575497	0.0680804
82	2.15075	0.0310783	0.0694735
83	2.17681	0.00807744	0.0699646
84	2.2049	0.000376095	0.0700287
85	2.2379	0.0200242	0.0702937
86	2.26404	0.0454186	0.0711503
87	2.29194	0.0626464	0.0727007
88	2.32083	0.0570836	0.0744912
89	2.35126	0.0305691	0.0758554
90	2.37739	0.00769507	0.0763353
91	2.40546	0.000466814	0.0763952
92	2.43886	0.0209129	0.0766794
93	2.46482	0.0461227	0.0775523
94	2.49287	0.0628658	0.0791251
95	2.5219	0.0564217	0.0809178
96	2.55199	0.0298438	0.0822435
97	2.57822	0.00716666	0.0827076
98	2.60627	0.000614902	0.0827618
99	2.64027	0.0222493	0.083076
100	2.666	0.0471633	0.0839733
101	2.69427	0.0631469	0.0855796
102	2.72353	0.0553526	0.0873753
103	2.75316	0.0286763	0.0886439
104	2.77954	0.00635318	0.0890827
105	2.80759	0.000901373	0.0891289
106	2.84264	0.0245329	0.0894976
107	2.868	0.0488904	0.0904359
108	2.89667	0.0634877	0.092098
109	2.92642	0.0533148	0.0938982
110	2.95536	0.0265005	0.0950706
111	2.982	0.00495263	0.0954628
112	3.01014	0.0016019	0.0954982
113	3.04636	0.0281941	0.0959618
114	3.07132	0.0515919	0.0969687
115	3.10053	0.0636572	0.0987096
116	3.13135	0.0494333	0.100518
117	3.15931	0.0226564	0.101534
118	3.18646	0.00283614	0.101846
119	3.21491	0.00342606	0.101876
120	3.24812	0.0299485	0.102379
121	3.27363	0.0533498	0.103456
122	3.30226	0.0635811	0.105186
123	3.33391	0.0472422	0.107008
124	3.36112	0.0209324	0.10794
125	3.38853	0.0020453	0.108217
126	3.41703	0.00444684	0.108251
127	3.44893	0.0307613	0.10877
128	3.47466	0.0540975	0.109878
129	3.50301	0.0635192	0.1116
130	3.53505	0.0462334	0.113427
131	3.56192	0.0201834	0.114322
132	3.58944	0.00173646	0.114585
133	3.61797	0.00493623	0.114621
134	3.64938	0.0312088	0.11515
135	3.67519	0.0544695	0.116272
136	3.70344	0.063476	0.117993
137	3.73571	0.0456412	0.119824
138	3.76242	0.0197267	0.120698
139	3.79	0.00155728	0.120952
140	3.81857	0.00526353	0.12099
141	3.8497	0.0315335	0.121526
142	3.87556	0.0547339	0.122659
143	3.90377	0.0634384	0.12438
144	3.93624	0.0451648	0.126214
145	3.96283	0.0193485	0.127072
146	3.99048	0.00141391	0.127319
147	4.01909	0.00555386	0.127359
148	4.05	0.0318343	0.127902
149	4.07591	0.0549756	0.129044
150	4.10409	0.063399	0.130767
151	4.13676	0.0446935	0.132603
152	4.16324	0.0189715	0.133446
153	4.19096	0.00127618	0.133686
154	4.21962	0.00585812	0.133728
155	4.25033	0.0321573	0.134278
156	4.27629	0.0552308	0.135431
157	4.30444	0.0633522	0.137155
158	4.33733	0.0441658	0.138995
159	4.3637	0.0185499	0.139821
160	4.3915	0.00112895	0.140053
161	4.42023	0.0062141	0.140098
162	4.45071	0.0325404	0.140657
163	4.47673	0.0555278	0.141822
164	4.50486	0.063291	0.143548
165	4.53804	0.0435159	0.145392
166	4.56427	0.0180341	0.146198
167	4.59217	0.000959045	0.146419
168	4.62099	0.00667202	0.146469
169	4.65121	0.0330374	0.147039
170	4.6773	0.0559044	0.14822
171	4.70541	0.0632023	0.149949
172	4.73897	0.0426368	0.151799
173	4.76504	0.0173437	0.152577
174	4.79307	0.000750196	0.152786
175	4.82203	0.00732454	0.152843
176	4.85192	0.0337494	0.153429
177	4.87811	0.056428	0.154631
178	4.90622	0.0630568	0.156366
179	4.94038	0.041306	0.158224
180	4.96621	0.0163165	0.158963
181	4.99446	0.000481232	0.159153
182	5.0	-1.06822e-7	0.159154

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.