From 6c755a88237e82971add948287a18e65ce414867 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christopher=20Sch=C3=B6lzel?= Date: Tue, 6 Aug 2024 21:55:30 +0200 Subject: [PATCH] adds examples to docs --- doc/source/examples.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/source/examples.rst b/doc/source/examples.rst index 7ee0fb8..a1256c7 100644 --- a/doc/source/examples.rst +++ b/doc/source/examples.rst @@ -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``.