software/Nstrophy
1
Fork 0
Code Issues Pull Requests Releases Activity

fix README layout

Browse Source
This commit is contained in:
Ian Jauslin 2025-01-31 11:09:23 -05:00
parent 170aebfa0c
commit b0f82a2412
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -39,14 +39,18 @@ The available commands are
* `enstrophy`: to compute the enstrophy and various other observables. This * `enstrophy`: to compute the enstrophy and various other observables. This
command prints command prints
```step_index time average(alpha) average(energy) average(enstrophy) alpha energy enstrophy``` ```
step_index time average(alpha) average(energy) average(enstrophy) alpha energy enstrophy
```
where the averages are running averages over `print_freq`. In addition, if where the averages are running averages over `print_freq`. In addition, if
the algorithm has an adaptive step, an extra column is printed with `delta`. the algorithm has an adaptive step, an extra column is printed with `delta`.
In addition, if alpha has a negative value (even in between `print_freq` In addition, if alpha has a negative value (even in between `print_freq`
intervals), a line is printed with the information. intervals), a line is printed with the information.
* `lyapunov`: to compute the Lyapunov exponents. This command prints * `lyapunov`: to compute the Lyapunov exponents. This command prints
```time instantaneous_lyapunov lyapunov``` ```
time instantaneous_lyapunov lyapunov
```
where `instantaneous_lyapunov` is computed from the tangent flow only between where `instantaneous_lyapunov` is computed from the tangent flow only between
the given time and the previous one. the given time and the previous one.