Ready to go

MunchLab · May 28, 2024 · a8046c4 · a8046c4
1 parent 081b37e
commit a8046c4
Show file tree

Hide file tree

Showing 53 changed files with 668 additions and 2,133 deletions.
diff --git a/doc_source/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb b/doc_source/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb
diff --git a/doc_source/tutorials.rst b/doc_source/tutorials.rst
@@ -6,4 +6,5 @@ Tutorials
    :caption: Contents:
 
    notebooks/Tutorial-ECT_for_embedded_graphs
+   notebooks/Tutorial-ECT_for_CW_Complexes
 
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_10_1.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_10_1.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_12_1.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_12_1.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_13_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_13_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_14_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_14_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_15_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_15_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_18_2.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_18_2.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_19_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_19_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_19_1.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_19_1.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_20_2.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_20_2.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_21_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_21_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_2_1.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_2_1.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_3_1.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_3_1.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_5_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_5_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_5_1.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_5_1.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_7_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_7_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_7_1.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_7_1.png
diff --git a/docs/_modules/ect_graph.html b/docs/_modules/ect_graph.html
@@ -225,6 +225,7 @@ <h1>Source code for ect_graph</h1><div class="highlight"><pre>
 <span class="sd">                If None, uses the following in order: (i) the bounding radius stored in the class; or if not available (ii) the bounding radius of the given graph. Otherwise, should be a postive float :math:`R` where the ECC will be computed at thresholds in :math:`[-R,R]`. Default is None.</span>
 <span class="sd">            return_counts (bool):</span>
 <span class="sd">                Whether to return the counts of vertices, edges, and faces below the threshold. Default is False.</span>
+
 <span class="sd">        &quot;&quot;&quot;</span>
 
         <span class="n">r</span><span class="p">,</span> <span class="n">r_threshes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_radius_and_thresh</span><span class="p">(</span><span class="n">G</span><span class="p">,</span> <span class="n">bound_radius</span><span class="p">)</span>
@@ -360,6 +361,8 @@ <h1>Source code for ect_graph</h1><div class="highlight"><pre>
 <span class="sd">                The angle in :math:`[0,2\pi]` for the direction to plot the ECC.</span>
 <span class="sd">            bound_radius (float):</span>
 <span class="sd">                If None, uses the following in order: (i) the bounding radius stored in the class; or if not available (ii) the bounding radius of the given graph. Otherwise, should be a postive float :math:`R` where the ECC will be computed at thresholds in :math:`[-R,R]`. Default is None. </span>
+<span class="sd">            draw_counts (bool):</span>
+<span class="sd">                Whether to draw the counts of vertices, edges, and faces varying across thresholds. Default is False.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
 
         <span class="n">r</span><span class="p">,</span> <span class="n">r_threshes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_radius_and_thresh</span><span class="p">(</span><span class="n">graph</span><span class="p">,</span> <span class="n">bound_radius</span><span class="p">)</span>

diff --git a/docs/_sources/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb.txt b/docs/_sources/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb.txt
diff --git a/docs/_sources/tutorials.rst.txt b/docs/_sources/tutorials.rst.txt
@@ -6,4 +6,5 @@ Tutorials
    :caption: Contents:
 
    notebooks/Tutorial-ECT_for_embedded_graphs
+   notebooks/Tutorial-ECT_for_CW_Complexes
 
diff --git a/docs/contributing.html b/docs/contributing.html
@@ -24,7 +24,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="5. GPL-3.0 License" href="license.html" />
-    <link rel="prev" title="3.1. Tutorial : ECT for embedded graphs" href="notebooks/Tutorial-ECT_for_embedded_graphs.html" /> 
+    <link rel="prev" title="3.2. Tutorial: ECT for CW complexes" href="notebooks/Tutorial-ECT_for_CW_Complexes.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -212,7 +212,7 @@ <h2><span class="section-number">4.3. </span>Conclusion<a class="headerlink" hre
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="notebooks/Tutorial-ECT_for_embedded_graphs.html" class="btn btn-neutral float-left" title="3.1. Tutorial : ECT for embedded graphs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="notebooks/Tutorial-ECT_for_CW_Complexes.html" class="btn btn-neutral float-left" title="3.2. Tutorial: ECT for CW complexes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="license.html" class="btn btn-neutral float-right" title="5. GPL-3.0 License" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

diff --git a/docs/doctrees/ect_on_graphs.doctree b/docs/doctrees/ect_on_graphs.doctree
diff --git a/docs/doctrees/embed_cw.doctree b/docs/doctrees/embed_cw.doctree
diff --git a/docs/doctrees/embed_graph.doctree b/docs/doctrees/embed_graph.doctree
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/nbsphinx/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb b/docs/doctrees/nbsphinx/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_10_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_10_1.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_12_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_12_1.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_13_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_13_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_14_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_14_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_15_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_15_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_18_2.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_18_2.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_19_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_19_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_19_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_19_1.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_20_2.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_20_2.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_21_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_21_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_2_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_2_1.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_3_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_3_1.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_5_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_5_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_5_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_5_1.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_7_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_7_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_7_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_7_1.png
diff --git a/docs/doctrees/notebooks/Tutorial-ECT_for_CW_Complexes.doctree b/docs/doctrees/notebooks/Tutorial-ECT_for_CW_Complexes.doctree
diff --git a/docs/doctrees/tutorials.doctree b/docs/doctrees/tutorials.doctree
diff --git a/docs/ect_on_graphs.html b/docs/ect_on_graphs.html
@@ -249,6 +249,7 @@
 <li><p><strong>graph</strong> (<em>EmbeddedGraph/EmbeddedCW</em>) – The input graph or CW complex.</p></li>
 <li><p><strong>theta</strong> (<em>float</em>) – The angle in <span class="math notranslate nohighlight">\([0,2\pi]\)</span> for the direction to plot the ECC.</p></li>
 <li><p><strong>bound_radius</strong> (<em>float</em>) – If None, uses the following in order: (i) the bounding radius stored in the class; or if not available (ii) the bounding radius of the given graph. Otherwise, should be a postive float <span class="math notranslate nohighlight">\(R\)</span> where the ECC will be computed at thresholds in <span class="math notranslate nohighlight">\([-R,R]\)</span>. Default is None.</p></li>
+<li><p><strong>draw_counts</strong> (<em>bool</em>) – Whether to draw the counts of vertices, edges, and faces varying across thresholds. Default is False.</p></li>
 </ul>
 </dd>
 </dl>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,5 @@ Tutorials
		:caption: Contents:

		notebooks/Tutorial-ECT_for_embedded_graphs
		notebooks/Tutorial-ECT_for_CW_Complexes