Merge pull request #381 from jGaboardi/demo_notebook

[ENH] connected components demo notebook
pysal · Jan 17, 2020 · 3384daa · 3384daa
2 parents 6f216e5 + 27f2b99
commit 3384daa
Show file tree

Hide file tree

Showing 47 changed files with 4,187 additions and 410 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 
 [pysal/spaghetti](http://pysal.org/spaghetti/)
-=========================================================
+=================================
 
 SPAtial GrapHs: nETworks, Topology, & Inference
-===============================================
+=====================================
 
 Spaghetti is an open-source Python library for the analysis of network-based spatial data. Originating from the `network` module in [PySAL (Python Spatial Analysis Library)](http://pysal.org), it is under active development for the inclusion of newly proposed methods for building graph-theoretic networks and the analysis of network events. This package is part of a [refactoring of PySAL](https://github.com/pysal/pysal/wiki/PEP-13:-Refactor-PySAL-Using-Submodules).
 
@@ -21,8 +21,8 @@ Spaghetti is an open-source Python library for the analysis of network-based spa
 
 
 Examples
---------
-The following examples can be launched individually as interactive binders from the links on their respective pages.
+-----------
+The following examples can be launched individually as interactive binders from the links on their respective pages. Additional examples can be found in the [Tutorials](https://pysal.org/spaghetti/tutorials.html) section of the documentation.
 * [Network Representation](https://pysal.org/spaghetti/notebooks/Basic_spaghetti_tutorial.html)
 * [Spatial Network Analysis](https://pysal.org/spaghetti/notebooks/Advanced_spaghetti_tutorial.html)
 * [Optimal Facility Location](https://pysal.org/spaghetti/notebooks/Use_case-facility_location.html)
@@ -65,44 +65,44 @@ $ pip install git+https://github.com/pysal/spaghetti
 
 
 Requirements
-------------
+----------------
 - [`esda`](https://esda.readthedocs.io/en/latest/)
 - [`libspatialindex`](https://libspatialindex.org/index.html)
 - [`numpy`](https://numpy.org/devdocs/)
 - [`rtree`](http://toblerity.org/rtree/install.html)
 - [`scipy`](http://scipy.github.io/devdocs/)
 
 Soft Dependencies
------------------
+----------------------
 - [`geopandas`](http://geopandas.org/install.html)
 - [`shapely`](https://shapely.readthedocs.io/en/latest/)
 
 Contribute
-----------
+------------
 
 PySAL-spaghetti is under active development and contributors are welcome.
 
 If you have any suggestion, feature request, or bug report, please open a new [issue](https://github.com/pysal/spaghetti/issues) on GitHub. To submit patches, please review [PySAL: Getting Started](http://pysal.org/getting_started#for-developers), the PySAL [development guidelines](https://github.com/pysal/pysal/wiki), the `spaghetti` [contributing guidelines](https://github.com/pysal/spaghetti/blob/master/.github/CONTRIBUTING.md) before  opening a [pull request](https://github.com/pysal/spaghetti/pulls). Once your changes get merged, you’ll automatically be added to the [Contributors List](https://github.com/pysal/spaghetti/graphs/contributors).
 
 Support
--------
+---------
 
 If you are having issues, please [create an issue](https://github.com/pysal/spaghetti/issues) or talk to us in the [gitter room](https://gitter.im/pysal/spaghetti).
 
 
 Code of Conduct
----------------
+--------------------
 
 As a PySAL-federated project, `spaghetti` follows the [Code of Conduct](https://github.com/pysal/governance/blob/master/conduct/code_of_conduct.rst) under the [PySAL governance model](https://github.com/pysal/governance).
 
 
 License
--------
+---------
 
 The project is licensed under the [BSD license](https://github.com/pysal/spaghetti/blob/master/LICENSE.txt).
 
 BibTeX Citation
----------------
+------------------
 
 If you use PySAL-spaghetti in a scientific publication, we would appreciate using the following citation:
 
@@ -117,5 +117,3 @@ If you use PySAL-spaghetti in a scientific publication, we would appreciate usin
     keywords  = {graph-theory,network-analysis,python,spatial-networks,topology}
 }
 ```
-
-
diff --git a/docs/.buildinfo b/docs/.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: 9914f7c728d0edd6caa6a3390f2ed9cf
+config: c0040c9f6fc37774d7272ce7c07b84a8
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_images/notebooks_Advanced_spaghetti_tutorial_32_1.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_32_1.png
diff --git a/docs/_images/notebooks_Advanced_spaghetti_tutorial_33_1.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_33_1.png
diff --git a/docs/_images/notebooks_Advanced_spaghetti_tutorial_43_0.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_43_0.png
diff --git a/docs/_images/notebooks_Advanced_spaghetti_tutorial_44_0.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_44_0.png
diff --git a/docs/_images/notebooks_Advanced_spaghetti_tutorial_46_0.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_46_0.png
diff --git a/docs/_images/notebooks_Advanced_spaghetti_tutorial_47_0.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_47_0.png
diff --git a/docs/_images/notebooks_Advanced_spaghetti_tutorial_49_0.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_49_0.png
diff --git a/docs/_images/notebooks_Advanced_spaghetti_tutorial_50_0.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_50_0.png
diff --git a/docs/_images/notebooks_Basic_spaghetti_tutorial_30_0.png b/docs/_images/notebooks_Basic_spaghetti_tutorial_30_0.png
diff --git a/docs/_images/notebooks_Connected-Components_16_1.png b/docs/_images/notebooks_Connected-Components_16_1.png
diff --git a/docs/_images/notebooks_Connected-Components_30_1.png b/docs/_images/notebooks_Connected-Components_30_1.png
diff --git a/docs/_images/notebooks_Connected-Components_43_1.png b/docs/_images/notebooks_Connected-Components_43_1.png
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -47,7 +47,7 @@
           <ul class="nav navbar-nav">
 
                 <li><a href="../installation.html">Installation</a></li>
-                <li><a href="../tutorial.html">Tutorial</a></li>
+                <li><a href="../tutorials.html">Tutorials</a></li>
                 <li><a href="../api.html">API</a></li>
                 <li><a href="../references.html">References</a></li>
 
@@ -68,8 +68,9 @@
 <li class="toctree-l2"><a class="reference internal" href="../installation.html#development-version">Development Version</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../notebooks/Basic_spaghetti_tutorial.html">Basic <code class="docutils literal notranslate"><span class="pre">pysal.spaghetti</span></code> tutorial</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/Connected-Components.html">Connected components in a spatial network</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../notebooks/Advanced_spaghetti_tutorial.html">Advanced <code class="docutils literal notranslate"><span class="pre">pysal.spaghetti</span></code> tutorial</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../notebooks/Use_case-facility_location.html">Demostrating network-based optimal facility location modeling</a></li>
 </ul>

diff --git a/docs/_modules/spaghetti/network.html b/docs/_modules/spaghetti/network.html
@@ -47,7 +47,7 @@
           <ul class="nav navbar-nav">
 
                 <li><a href="../../installation.html">Installation</a></li>
-                <li><a href="../../tutorial.html">Tutorial</a></li>
+                <li><a href="../../tutorials.html">Tutorials</a></li>
                 <li><a href="../../api.html">API</a></li>
                 <li><a href="../../references.html">References</a></li>
 
@@ -68,8 +68,9 @@
 <li class="toctree-l2"><a class="reference internal" href="../../installation.html#development-version">Development Version</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html">Tutorial</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorials.html">Tutorials</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../notebooks/Basic_spaghetti_tutorial.html">Basic <code class="docutils literal notranslate"><span class="pre">pysal.spaghetti</span></code> tutorial</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../notebooks/Connected-Components.html">Connected components in a spatial network</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../notebooks/Advanced_spaghetti_tutorial.html">Advanced <code class="docutils literal notranslate"><span class="pre">pysal.spaghetti</span></code> tutorial</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../notebooks/Use_case-facility_location.html">Demostrating network-based optimal facility location modeling</a></li>
 </ul>

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -77,7 +77,7 @@ If you use PySAL-spaghetti in a scientific publication, we would appreciate usin
    :caption: Contents:
 
    Installation <installation>
-   Tutorial <tutorial>
+   Tutorials <tutorials>
    API <api>
    References <references>
 

diff --git a/docs/_sources/notebooks/Advanced_spaghetti_tutorial.ipynb.txt b/docs/_sources/notebooks/Advanced_spaghetti_tutorial.ipynb.txt
diff --git a/docs/_sources/notebooks/Basic_spaghetti_tutorial.ipynb.txt b/docs/_sources/notebooks/Basic_spaghetti_tutorial.ipynb.txt