Skip to content

Commit 705cb44

Browse files
authored
Update README.md
1 parent 4b70299 commit 705cb44

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,19 @@ bopdmd.fit(X, t)
140140

141141
Note that modules and functions may be parameterized by a variety of inputs for added customization, so we generally recommend that new users refer to our [module documentation](https://pydmd.github.io/PyDMD/code.html), [plotting tool documentation](https://pydmd.github.io/PyDMD/plotter.html), and to our module-specific [tutorials](tutorials/README.md) for more information.
142142

143+
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.
144+
145+
<p align="center">
146+
<img src="readme/pydmd_guide.svg" width="1000" />
147+
</p>
148+
143149
## Examples and Tutorials
144150
You can find useful tutorials on how to use the package in the [tutorials](tutorials/README.md) folder.
145151

146152
Here we show a simple application (taken from [tutorial 2](tutorials/tutorial2/tutorial-2-adv-dmd.ipynb)): we collect few snapshots from a toy system with some noise and reconstruct the entire system evolution.
153+
154+
Also provided below is an example output of the `plot_summary()` function when given a DMD model fitted to this data set. 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 amplitudes or importance.
155+
147156
<p align="center">
148157
<img src="readme/dmd-example.png" alt>
149158
<em>The original snapshots used as input for the dynamic mode decomposition</em>
@@ -154,15 +163,9 @@ Here we show a simple application (taken from [tutorial 2](tutorials/tutorial2/t
154163
<em>The system evolution reconstructed with dynamic mode decomposition</em>
155164
</p>
156165

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.
158166
<p align="center">
159167
<img src="readme/summary-example.png" alt></br>
160-
</p>
161-
162-
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.
163-
164-
<p align="center">
165-
<img src="readme/pydmd_guide.svg" width="1000" />
168+
<em>Sample output of the plot_summary function.</em>
166169
</p>
167170

168171
## Awards

0 commit comments

Comments
 (0)