Skip to content

Commit

Permalink
Autonomous flows docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@stanweer1
stanweer1 committed Aug 23, 2024
1 parent f7d7aee commit 0a9db01
Show file tree
Hide file tree
Showing 155 changed files with 16,556 additions and 3,558 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 14c0d7c06b21106d06dd8ce8198cd514
config: 57959a0acaf4fa6441a0088b37c57423
tags: 645f666f9bcd5a90fca523b33c5a78b7
38 changes: 15 additions & 23 deletions docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; teaspoon 1.3.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />


<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/plot_directive.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=d4a0791e"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
Expand All @@ -29,16 +28,12 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: white" >



<a href="../index.html" class="icon icon-home">
teaspoon
<img src="../_static/teaspoon.png" class="logo" alt="Logo"/>
<a href="../index.html" class="icon icon-home"> teaspoon
<img src="../_static/teaspoon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
Expand Down Expand Up @@ -133,7 +128,7 @@
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li><a href="../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Overview: module code</li>
<li class="wy-breadcrumbs-aside">
</li>
Expand All @@ -144,11 +139,8 @@
<div itemprop="articleBody">

<h1>All modules for which code is available</h1>
<ul><li><a href="teaspoon/ML/PD_Classification.html">teaspoon.ML.PD_Classification</a></li>
<li><a href="teaspoon/ML/feature_functions.html">teaspoon.ML.feature_functions</a></li>
<li><a href="teaspoon/ML/load_datasets.html">teaspoon.ML.load_datasets</a></li>
<ul><li><a href="teaspoon/ML/load_datasets.html">teaspoon.ML.load_datasets</a></li>
<li><a href="teaspoon/MakeData/DynSysLib/DynSysLib.html">teaspoon.MakeData.DynSysLib.DynSysLib</a></li>
<li><a href="teaspoon/MakeData/DynSysLib/autonomous_dissipative_flows.html">teaspoon.MakeData.DynSysLib.autonomous_dissipative_flows</a></li>
<li><a href="teaspoon/MakeData/DynSysLib/conservative_flows.html">teaspoon.MakeData.DynSysLib.conservative_flows</a></li>
<li><a href="teaspoon/MakeData/DynSysLib/delayed_flows.html">teaspoon.MakeData.DynSysLib.delayed_flows</a></li>
<li><a href="teaspoon/MakeData/DynSysLib/driven_dissipative_flows.html">teaspoon.MakeData.DynSysLib.driven_dissipative_flows</a></li>
Expand Down
48 changes: 17 additions & 31 deletions docs/_modules/teaspoon/ML/load_datasets.html
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../../">
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>teaspoon.ML.load_datasets &mdash; teaspoon 1.3.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../../../_static/plot_directive.css" />


<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/plot_directive.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=d4a0791e"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/sphinx_highlight.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
Expand All @@ -29,16 +28,12 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: white" >



<a href="../../../index.html" class="icon icon-home">
teaspoon
<img src="../../../_static/teaspoon.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> teaspoon
<img src="../../../_static/teaspoon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
Expand Down Expand Up @@ -133,7 +128,7 @@
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li><a href="../../../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
<li class="breadcrumb-item active">teaspoon.ML.load_datasets</li>
<li class="wy-breadcrumbs-aside">
Expand All @@ -149,9 +144,7 @@ <h1>Source code for teaspoon.ML.load_datasets</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">importlib_resources</span>


<div class="viewcode-block" id="mpeg7">
<a class="viewcode-back" href="../../../modules/ML/DS.html#teaspoon.ML.load_datasets.mpeg7">[docs]</a>
<span class="k">def</span> <span class="nf">mpeg7</span><span class="p">():</span>
<div class="viewcode-block" id="mpeg7"><a class="viewcode-back" href="../../../modules/ML/DS.html#teaspoon.ML.load_datasets.mpeg7">[docs]</a><span class="k">def</span> <span class="nf">mpeg7</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Load the persistence diagrams from the MPEG7 dataset</span>

Expand All @@ -162,10 +155,7 @@ <h1>Source code for teaspoon.ML.load_datasets</h1><div class="highlight"><pre>
<span class="k">return</span><span class="p">(</span><span class="n">data</span><span class="p">)</span></div>



<div class="viewcode-block" id="shrec14">
<a class="viewcode-back" href="../../../modules/ML/DS.html#teaspoon.ML.load_datasets.shrec14">[docs]</a>
<span class="k">def</span> <span class="nf">shrec14</span><span class="p">():</span>
<div class="viewcode-block" id="shrec14"><a class="viewcode-back" href="../../../modules/ML/DS.html#teaspoon.ML.load_datasets.shrec14">[docs]</a><span class="k">def</span> <span class="nf">shrec14</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Load the persistence diagrams from the shrec14 dataset</span>

Expand All @@ -175,10 +165,7 @@ <h1>Source code for teaspoon.ML.load_datasets</h1><div class="highlight"><pre>
<span class="k">return</span><span class="p">(</span><span class="n">data</span><span class="p">)</span></div>



<div class="viewcode-block" id="mnist">
<a class="viewcode-back" href="../../../modules/ML/DS.html#teaspoon.ML.load_datasets.mnist">[docs]</a>
<span class="k">def</span> <span class="nf">mnist</span><span class="p">():</span>
<div class="viewcode-block" id="mnist"><a class="viewcode-back" href="../../../modules/ML/DS.html#teaspoon.ML.load_datasets.mnist">[docs]</a><span class="k">def</span> <span class="nf">mnist</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Load the persistence diagrams from the training portion of the MNIST dataset from http://yann.lecun.com/exdb/mnist/</span>

Expand All @@ -197,7 +184,6 @@ <h1>Source code for teaspoon.ML.load_datasets</h1><div class="highlight"><pre>
<span class="n">stream</span> <span class="o">=</span> <span class="n">importlib_resources</span><span class="o">.</span><span class="n">files</span><span class="p">(</span><span class="s1">&#39;datasets&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="s1">&#39;mnist.pickle&#39;</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_pickle</span><span class="p">(</span><span class="n">stream</span><span class="p">)</span>
<span class="k">return</span><span class="p">(</span><span class="n">data</span><span class="p">)</span></div>

</pre></div>

</div>
Expand Down
38 changes: 15 additions & 23 deletions docs/_modules/teaspoon/MakeData/DynSysLib/DynSysLib.html
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../../../">
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>teaspoon.MakeData.DynSysLib.DynSysLib &mdash; teaspoon 1.3.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../../../../_static/plot_directive.css" />


<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/plot_directive.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../../_static/documentation_options.js?v=d4a0791e"></script>
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/sphinx_highlight.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
Expand All @@ -29,16 +28,12 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: white" >



<a href="../../../../index.html" class="icon icon-home">
teaspoon
<img src="../../../../_static/teaspoon.png" class="logo" alt="Logo"/>
<a href="../../../../index.html" class="icon icon-home"> teaspoon
<img src="../../../../_static/teaspoon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
Expand Down Expand Up @@ -133,7 +128,7 @@
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li><a href="../../../../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
<li class="breadcrumb-item active">teaspoon.MakeData.DynSysLib.DynSysLib</li>
<li class="wy-breadcrumbs-aside">
Expand All @@ -147,9 +142,7 @@
<h1>Source code for teaspoon.MakeData.DynSysLib.DynSysLib</h1><div class="highlight"><pre>
<span></span>

<div class="viewcode-block" id="DynamicSystems">
<a class="viewcode-back" href="../../../../modules/MakeData/DynSysLib/index.html#teaspoon.MakeData.DynSysLib.DynSysLib.DynamicSystems">[docs]</a>
<span class="k">def</span> <span class="nf">DynamicSystems</span><span class="p">(</span><span class="n">system</span><span class="p">,</span> <span class="n">dynamic_state</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">L</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">fs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<div class="viewcode-block" id="DynamicSystems"><a class="viewcode-back" href="../../../../modules/MakeData/DynSysLib/index.html#teaspoon.MakeData.DynSysLib.DynSysLib.DynamicSystems">[docs]</a><span class="k">def</span> <span class="nf">DynamicSystems</span><span class="p">(</span><span class="n">system</span><span class="p">,</span> <span class="n">dynamic_state</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">L</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">fs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">SampleSize</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">InitialConditions</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">UserGuide</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;This function provides a library of dynamical system models to simulate with the time series as the output. </span>
Expand Down Expand Up @@ -302,7 +295,6 @@ <h1>Source code for teaspoon.MakeData.DynSysLib.DynSysLib</h1><div class="highli
<span class="k">return</span> <span class="n">t</span><span class="p">,</span> <span class="n">ts</span></div>



<span class="c1"># In[ ]:</span>

<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>
Expand Down
Loading

0 comments on commit 0a9db01

Please sign in to comment.