Skip to content

Commit

Permalink
updates pages for version 0.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@CSchoel
CSchoel committed Oct 1, 2024
1 parent 430486f commit 601d7c0
Show file tree
Hide file tree
Showing 18 changed files with 484 additions and 604 deletions.
45 changes: 22 additions & 23 deletions _modules/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
<!DOCTYPE html>

<html lang="en" data-content_root="../">
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; Nolds 0.6.0 documentation</title>
<title>Overview: module code &#8212; Nolds 0.6.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=c058f7c8" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=19a2ea7e" />
<script src="../_static/documentation_options.js?v=8fa8b3e9"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=1fc5d657" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=09aae1b8"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />

<link rel="stylesheet" href="../_static/custom.css" type="text/css" />




<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>

Expand All @@ -40,7 +38,7 @@ <h1>All modules for which code is available</h1>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">Nolds</a></h1>

Expand All @@ -51,16 +49,7 @@ <h1 class="logo"><a href="../index.html">Nolds</a></h1>




<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../nolds.html"><code class="docutils literal notranslate"><span class="pre">nolds</span></code> module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples.html">Nolds examples</a></li>
Expand All @@ -74,6 +63,16 @@ <h3>Related Topics</h3>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>



Expand All @@ -87,11 +86,11 @@ <h3>Related Topics</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2016-2024, Christopher Schölzel.
&copy;2016-2024, Christopher Schölzel.

|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

</div>

Expand Down
97 changes: 38 additions & 59 deletions _modules/nolds/datasets.html
View file

Large diffs are not rendered by default.

70 changes: 27 additions & 43 deletions _modules/nolds/examples.html
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
<!DOCTYPE html>

<html lang="en" data-content_root="../../">
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nolds.examples &#8212; Nolds 0.6.0 documentation</title>
<title>nolds.examples &#8212; Nolds 0.6.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/basic.css?v=c058f7c8" />
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=19a2ea7e" />
<script src="../../_static/documentation_options.js?v=8fa8b3e9"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=1fc5d657" />
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=09aae1b8"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />

<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />




<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>

Expand All @@ -43,9 +41,7 @@ <h1>Source code for nolds.examples</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>


<div class="viewcode-block" id="weron_2002_figure2">
<a class="viewcode-back" href="../../examples.html#nolds.examples.weron_2002_figure2">[docs]</a>
<span class="k">def</span> <span class="nf">weron_2002_figure2</span><span class="p">(</span><span class="n">n</span><span class="o">=</span><span class="mi">10000</span><span class="p">):</span>
<div class="viewcode-block" id="weron_2002_figure2"><a class="viewcode-back" href="../../examples.html#nolds.examples.weron_2002_figure2">[docs]</a><span class="k">def</span> <span class="nf">weron_2002_figure2</span><span class="p">(</span><span class="n">n</span><span class="o">=</span><span class="mi">10000</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Recreates figure 2 of [w]_ comparing the reported values by Weron to the</span>
<span class="sd"> values obtained by the functions in this package.</span>
Expand Down Expand Up @@ -122,10 +118,7 @@ <h1>Source code for nolds.examples</h1><div class="highlight"><pre>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span></div>



<div class="viewcode-block" id="plot_hurst_hist">
<a class="viewcode-back" href="../../examples.html#nolds.examples.plot_hurst_hist">[docs]</a>
<span class="k">def</span> <span class="nf">plot_hurst_hist</span><span class="p">():</span>
<div class="viewcode-block" id="plot_hurst_hist"><a class="viewcode-back" href="../../examples.html#nolds.examples.plot_hurst_hist">[docs]</a><span class="k">def</span> <span class="nf">plot_hurst_hist</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Plots a histogram of values obtained for the hurst exponent of uniformly</span>
<span class="sd"> distributed white noise.</span>
Expand All @@ -144,10 +137,7 @@ <h1>Source code for nolds.examples</h1><div class="highlight"><pre>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span></div>



<div class="viewcode-block" id="plot_lyap">
<a class="viewcode-back" href="../../examples.html#nolds.examples.plot_lyap">[docs]</a>
<span class="k">def</span> <span class="nf">plot_lyap</span><span class="p">(</span><span class="n">maptype</span><span class="o">=</span><span class="s2">&quot;logistic&quot;</span><span class="p">):</span>
<div class="viewcode-block" id="plot_lyap"><a class="viewcode-back" href="../../examples.html#nolds.examples.plot_lyap">[docs]</a><span class="k">def</span> <span class="nf">plot_lyap</span><span class="p">(</span><span class="n">maptype</span><span class="o">=</span><span class="s2">&quot;logistic&quot;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Plots a bifurcation plot of the given map and superimposes the true</span>
<span class="sd"> lyapunov exponent as well as the estimates of the largest lyapunov exponent</span>
Expand Down Expand Up @@ -229,10 +219,7 @@ <h1>Source code for nolds.examples</h1><div class="highlight"><pre>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span></div>



<div class="viewcode-block" id="profiling">
<a class="viewcode-back" href="../../examples.html#nolds.examples.profiling">[docs]</a>
<span class="k">def</span> <span class="nf">profiling</span><span class="p">():</span>
<div class="viewcode-block" id="profiling"><a class="viewcode-back" href="../../examples.html#nolds.examples.profiling">[docs]</a><span class="k">def</span> <span class="nf">profiling</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Runs a profiling test for the function ``lyap_e`` (mainly used for</span>
<span class="sd"> development)</span>
Expand All @@ -245,10 +232,7 @@ <h1>Source code for nolds.examples</h1><div class="highlight"><pre>
<span class="n">cProfile</span><span class="o">.</span><span class="n">runctx</span><span class="p">(</span><span class="s1">&#39;lyap_e(data)&#39;</span><span class="p">,</span> <span class="p">{</span><span class="s1">&#39;lyap_e&#39;</span><span class="p">:</span> <span class="n">nolds</span><span class="o">.</span><span class="n">lyap_e</span><span class="p">},</span> <span class="p">{</span><span class="s1">&#39;data&#39;</span><span class="p">:</span> <span class="n">data</span><span class="p">})</span></div>



<div class="viewcode-block" id="hurst_compare_nvals">
<a class="viewcode-back" href="../../examples.html#nolds.examples.hurst_compare_nvals">[docs]</a>
<span class="k">def</span> <span class="nf">hurst_compare_nvals</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">nvals</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<div class="viewcode-block" id="hurst_compare_nvals"><a class="viewcode-back" href="../../examples.html#nolds.examples.hurst_compare_nvals">[docs]</a><span class="k">def</span> <span class="nf">hurst_compare_nvals</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">nvals</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a plot that compares the results of different choices for nvals</span>
<span class="sd"> for the function hurst_rs.</span>
Expand Down Expand Up @@ -296,7 +280,6 @@ <h1>Source code for nolds.examples</h1><div class="highlight"><pre>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;custom: </span><span class="si">%.3f</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">dd_cst</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span></div>


<span class="k">def</span> <span class="nf">sampen_default_tolerance</span><span class="p">():</span>
<span class="n">data</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">datasets</span><span class="o">.</span><span class="n">logistic_map</span><span class="p">(</span><span class="mf">0.34</span><span class="p">,</span> <span class="mi">1000</span><span class="p">,</span> <span class="n">r</span><span class="o">=</span><span class="mf">3.9</span><span class="p">))</span>
<span class="n">oldtol</span> <span class="o">=</span> <span class="mf">0.2</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">std</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">ddof</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
Expand Down Expand Up @@ -672,7 +655,7 @@ <h1>Source code for nolds.examples</h1><div class="highlight"><pre>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Nolds</a></h1>

Expand All @@ -683,16 +666,7 @@ <h1 class="logo"><a href="../../index.html">Nolds</a></h1>




<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../nolds.html"><code class="docutils literal notranslate"><span class="pre">nolds</span></code> module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../examples.html">Nolds examples</a></li>
Expand All @@ -708,6 +682,16 @@ <h3>Related Topics</h3>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>



Expand All @@ -721,11 +705,11 @@ <h3>Related Topics</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2016-2024, Christopher Schölzel.
&copy;2016-2024, Christopher Schölzel.

|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

</div>

Expand Down
Loading

0 comments on commit 601d7c0

Please sign in to comment.