Skip to content

Commit

Permalink
adds examples to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CSchoel committed Aug 6, 2024
1 parent b8af0d4 commit 6c755a8
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ You can run some examples for the functions in nolds with the command
* ``hurst-hist`` plots a histogram of hurst exponents obtained for random noise.
* ``hurst-nvals`` creates a plot that compares the results of different choices for nvals
for the function ``hurst_rs``.
* ``sampen-tol`` compares old and new default tolerance values for ``sampen``.
* ``hurst_mf_stock`` example function recreates a plot from Di Matteo (2003).
* ``barabasi_1991_figure2`` and ``barabasi_1991_figure3`` recreate the respective plots from Barabasi et al. (1991)
* ``lorenz`` calculates all main measures of ``nolds`` for x, y, and z coordinates of a Lorenz plot and compares them to prescribed values from the literature.

These tests are also available as functions inside the module ``nolds.examples``.

Expand Down

0 comments on commit 6c755a8

Please # to comment.