Skip to content

Commit 4b70299

Browse files
authored
Added plot_summary example
1 parent 8cf7b33 commit 4b70299

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ Users may also build highly complex DMD models with PyDMD. Below is an example o
123123
from pydmd import BOPDMD
124124

125125
# Build a bagging, optimized DMD (BOP-DMD) model.
126+
# For Optimized DMD (without bagging), use BOPDMD(svd_rank=15, num_trials=0).
126127
bopdmd = BOPDMD(
127128
svd_rank=15, # Rank of the DMD fit.
128129
num_trials=100, # Number of bagging trials to perform.
@@ -153,6 +154,11 @@ Here we show a simple application (taken from [tutorial 2](tutorials/tutorial2/t
153154
<em>The system evolution reconstructed with dynamic mode decomposition</em>
154155
</p>
155156

157+
Also provided below is an example output of the `plot_summary()` function when given a DMD model fitted to the data above. A rank-2 Optimized DMD model was used to generate the summary below. Note that the eigenvalues, modes, and dynamics are color-coded to indicate associations, and that eigenvalue marker sizes indicate spatiotemporal mode amplitude or importance.
158+
<p align="center">
159+
<img src="readme/summary-example.png" alt></br>
160+
</p>
161+
156162
For users who are unsure of which DMD method is best for them, we provide the following flow chart, which outlines how one might choose an appropriate DMD variant based on specific problem types or data sets.
157163

158164
<p align="center">

0 commit comments

Comments
 (0)