You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-14Lines changed: 15 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,17 +29,17 @@
29
29
30
30
## Table of contents
31
31
32
-
*[Description](#description)
33
-
*[Installation and dependencies](#installation-and-dependencies)
34
-
* [Installing via PIP](#installing-via-pip)
35
-
* [Installing from source](#installing-from-source)
36
-
*[Documentation](#documentation)
37
-
*[Testing](#testing)
38
-
*[Tutorials](#tutorials)
39
-
*[References](#references)
40
-
*[Recent works with PySPOD](#recent-works-with-pyspod)
41
-
*[Authors and contributors](#authors-and-contributors)
42
-
*[License](#license)
32
+
* [Description](#description)
33
+
* [Installation and dependencies](#installation-and-dependencies)
34
+
* [Installing via PIP](#installing-via-pip)
35
+
* [Installing from source](#installing-from-source)
36
+
* [Documentation](#documentation)
37
+
* [Testing](#testing)
38
+
* [Tutorials](#tutorials)
39
+
* [References](#references)
40
+
* [Recent works with PySPOD](#recent-works-with-pyspod)
41
+
* [Authors and contributors](#authors-and-contributors)
42
+
* [License](#license)
43
43
44
44
## Description
45
45
**PySPOD** is a Python package that implements the so-called **Spectral Proper Orthgonal Decomposition** whose name was first conied by (picard-&-delville-2000), and goes back to the original work by [(Lumley 1970)](#lumley-1970). The implementation proposed here follows the original contributions by [(Towne et al. 2018)](#towne-et-al-2018), [(Schmidt and Towne 2019)](#schmidt-and-towne-2019).
@@ -51,9 +51,10 @@ The SPOD approach targets statistically stationary problems and involves the dec
51
51
This can help identifying relations to multiple variables or understanding the reduced order behavior of a given phenomenon of interest and represent a powerful tool for the data-driven analysis of nonlinear dynamical systems. The SPOD approach shares some relationships with the dynamic mode decomposition (DMD), and the resolvent analysis, [(Towne et al. 2018)](#Towne-et-al-2018), that are also widely used approaches for the data-driven analysis of nonlinear systems. SPOD can be used for both experimental and simulation data, and a general description of its key parameters can be found in [(Schmidt and Colonius 2020)](#schmidt-and-colonius-2020).
52
52
53
53
In this package we implement three version of SPOD
54
-
- SPOD_low_storage: that is intended for large RAM machines or small datasets
55
-
- SPOD_low_ram: that is intended for small RAM machines or large datasets, and
56
-
- SPOD_streaming: that is the algorithm presented in [(Schmidt and Towne 2019)](schmidt-and-towne-2019), and it is intended for large datasets.
54
+
55
+
- SPOD_low_storage: that is intended for large RAM machines or small datasets
56
+
- SPOD_low_ram: that is intended for small RAM machines or large datasets, and
57
+
- SPOD_streaming: that is the algorithm presented in [(Schmidt and Towne 2019)](schmidt-and-towne-2019), and it is intended for large datasets.
57
58
58
59
To see how to use the **PySPOD** package and its user-friendly interface, you can look at the [**Tutorials**](tutorials/README.md).
0 commit comments