updated to version 0.3.0

ComplexSystem · LifeWorks · Apr 29, 2020 · May 2, 2019 · Sep 10, 2019 · Sep 16, 2019
commit a02265f6933d4b1f09084701a024df7eac7c20ee
diff --git a/build_docs.sh b/build_docs.sh
@@ -1,11 +1,13 @@
 #!/bin/bash
 
 rm -rf docs/build
-rm -rf docs/source/classes 
+rm -rf docs/source/classes
+rm -rf docs/source/algorithms 
 rm -rf docs/source/drawing 
 rm -rf docs/source/reports
 
 sphinx-apidoc -o docs/source/classes hypernetx/classes
+sphinx-apidoc -o docs/source/algorithms hypernetx/algorithms
 sphinx-apidoc -o docs/source/drawing hypernetx/drawing
 sphinx-apidoc -o docs/source/reports hypernetx/reports
 sphinx-build -b html docs/source docs/build
diff --git a/docs/build/.buildinfo b/docs/build/.buildinfo
@@ -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: 3539ecd7d41e3c89ec0585615692d6c6
+config: 673a2b0b26a4af3560f6f8e3e7022acd
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/.doctrees/algorithms/algorithms.doctree b/docs/build/.doctrees/algorithms/algorithms.doctree
diff --git a/docs/build/.doctrees/algorithms/modules.doctree b/docs/build/.doctrees/algorithms/modules.doctree
diff --git a/docs/build/.doctrees/classes/classes.doctree b/docs/build/.doctrees/classes/classes.doctree
diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle
diff --git a/docs/build/.doctrees/index.doctree b/docs/build/.doctrees/index.doctree
diff --git a/docs/build/_modules/algorithms/homology_mod2.html b/docs/build/_modules/algorithms/homology_mod2.html
diff --git a/docs/build/_modules/classes/entity.html b/docs/build/_modules/classes/entity.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>classes.entity &mdash; HyperNetX 0.2.6 documentation</title>
+  <title>classes.entity &mdash; HyperNetX 0.3.0 documentation</title>
 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -92,6 +92,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../install.html">Installing HyperNetX</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../classes/modules.html">Hypergraphs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../algorithms/modules.html">Algorithms</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../drawing/modules.html">Drawing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../reports/modules.html">Reports</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>

diff --git a/docs/build/_modules/classes/hg_constructors.html b/docs/build/_modules/classes/hg_constructors.html
diff --git a/docs/build/_modules/classes/hypergraph.html b/docs/build/_modules/classes/hypergraph.html
diff --git a/docs/build/_modules/drawing/rubber_band.html b/docs/build/_modules/drawing/rubber_band.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>drawing.rubber_band &mdash; HyperNetX 0.2.6 documentation</title>
+  <title>drawing.rubber_band &mdash; HyperNetX 0.3.0 documentation</title>
 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -92,6 +92,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../install.html">Installing HyperNetX</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../classes/modules.html">Hypergraphs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../algorithms/modules.html">Algorithms</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../drawing/modules.html">Drawing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../reports/modules.html">Reports</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>

diff --git a/docs/build/_modules/drawing/two_column.html b/docs/build/_modules/drawing/two_column.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>drawing.two_column &mdash; HyperNetX 0.2.6 documentation</title>
+  <title>drawing.two_column &mdash; HyperNetX 0.3.0 documentation</title>
 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -92,6 +92,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../install.html">Installing HyperNetX</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../classes/modules.html">Hypergraphs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../algorithms/modules.html">Algorithms</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../drawing/modules.html">Drawing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../reports/modules.html">Reports</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>

diff --git a/docs/build/_modules/drawing/util.html b/docs/build/_modules/drawing/util.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>drawing.util &mdash; HyperNetX 0.2.6 documentation</title>
+  <title>drawing.util &mdash; HyperNetX 0.3.0 documentation</title>
 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -92,6 +92,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../install.html">Installing HyperNetX</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../classes/modules.html">Hypergraphs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../algorithms/modules.html">Algorithms</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../drawing/modules.html">Drawing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../reports/modules.html">Reports</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>

diff --git a/docs/build/_modules/index.html b/docs/build/_modules/index.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; HyperNetX 0.2.6 documentation</title>
+  <title>Overview: module code &mdash; HyperNetX 0.3.0 documentation</title>
 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -92,6 +92,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../install.html">Installing HyperNetX</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../classes/modules.html">Hypergraphs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../algorithms/modules.html">Algorithms</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../drawing/modules.html">Drawing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reports/modules.html">Reports</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
@@ -156,8 +157,8 @@
            <div itemprop="articleBody">
 
   <h1>All modules for which code is available</h1>
-<ul><li><a href="classes/entity.html">classes.entity</a></li>
-<li><a href="classes/hg_constructors.html">classes.hg_constructors</a></li>
+<ul><li><a href="algorithms/homology_mod2.html">algorithms.homology_mod2</a></li>
+<li><a href="classes/entity.html">classes.entity</a></li>
 <li><a href="classes/hypergraph.html">classes.hypergraph</a></li>
 <li><a href="drawing/rubber_band.html">drawing.rubber_band</a></li>
 <li><a href="drawing/two_column.html">drawing.two_column</a></li>

diff --git a/docs/build/_modules/reports/descriptive_stats.html b/docs/build/_modules/reports/descriptive_stats.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>reports.descriptive_stats &mdash; HyperNetX 0.2.6 documentation</title>
+  <title>reports.descriptive_stats &mdash; HyperNetX 0.3.0 documentation</title>
 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -92,6 +92,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../install.html">Installing HyperNetX</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../classes/modules.html">Hypergraphs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../algorithms/modules.html">Algorithms</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../drawing/modules.html">Drawing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../reports/modules.html">Reports</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>

diff --git a/docs/build/_sources/algorithms/algorithms.rst.txt b/docs/build/_sources/algorithms/algorithms.rst.txt
@@ -0,0 +1,22 @@
+algorithms package
+==================
+
+Submodules
+----------
+
+algorithms.homology\_mod2 module
+--------------------------------
+
+.. automodule:: algorithms.homology_mod2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: algorithms
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/build/_sources/algorithms/modules.rst.txt b/docs/build/_sources/algorithms/modules.rst.txt
@@ -0,0 +1,7 @@
+algorithms
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   algorithms
diff --git a/docs/build/_sources/classes/classes.rst.txt b/docs/build/_sources/classes/classes.rst.txt
@@ -12,14 +12,6 @@ classes.entity module
    :undoc-members:
    :show-inheritance:
 
-classes.hg\_constructors module
--------------------------------
-
-.. automodule:: classes.hg_constructors
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 classes.hypergraph module
 -------------------------
 

diff --git a/docs/build/_sources/index.rst.txt b/docs/build/_sources/index.rst.txt
@@ -26,6 +26,7 @@ Contents
    install
    Glossary <glossary>
    Hypergraphs <classes/modules.rst>
+   Algorithms <algorithms/modules.rst>
    Drawing <drawing/modules.rst>
    Reports <reports/modules.rst>
    license

diff --git a/docs/build/_static/documentation_options.js b/docs/build/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.2.6',
+    VERSION: '0.3.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',