Merge pull request #386 from jGaboardi/tsp_notebook

[WIP] TSP notebook
pysal · Jan 25, 2020 · 1dde027 · 1dde027
2 parents 8cbf391 + f695eae
commit 1dde027
Show file tree

Hide file tree

Showing 66 changed files with 4,102 additions and 5,441 deletions.
diff --git a/README.md b/README.md
@@ -22,10 +22,10 @@ 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. Additional examples can be found in the [Tutorials](https://pysal.org/spaghetti/tutorials.html) section of the documentation. See the [`pysal/notebooks`](http://pysal.org/notebooks) project for a [`jupyter-book`](https://github.com/choldgraf/jupyter-book) version of this repository.
-* [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)
+The following are a selection of some examples that 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. See the [`pysal/notebooks`](http://pysal.org/notebooks) project for a [`jupyter-book`](https://github.com/choldgraf/jupyter-book) version of this repository.
+* [Network Representation](https://pysal.org/spaghetti/notebooks/quickstart.html)
+* [Spatial Network Analysis](https://pysal.org/spaghetti/notebooks/network-analysis.html)
+* [Optimal Facility Location](https://pysal.org/spaghetti/notebooks/facility_location.html)
 
 
 Installation

diff --git a/...books_Use-case-facility-location_26_0.png → ...ages/notebooks_facility-location_26_0.png b/...books_Use-case-facility-location_26_0.png → ...ages/notebooks_facility-location_26_0.png
diff --git a/...books_Use-case-facility-location_31_0.png → ...ages/notebooks_facility-location_31_0.png b/...books_Use-case-facility-location_31_0.png → ...ages/notebooks_facility-location_31_0.png
diff --git a/...books_Use-case-facility-location_37_0.png → ...ages/notebooks_facility-location_37_0.png b/...books_Use-case-facility-location_37_0.png → ...ages/notebooks_facility-location_37_0.png
diff --git a/...books_Use-case-facility-location_45_0.png → ...ages/notebooks_facility-location_45_0.png b/...books_Use-case-facility-location_45_0.png → ...ages/notebooks_facility-location_45_0.png
diff --git a/...books_Use-case-facility-location_51_0.png → ...ages/notebooks_facility-location_51_0.png b/...books_Use-case-facility-location_51_0.png → ...ages/notebooks_facility-location_51_0.png
diff --git a/...books_Use-case-facility-location_55_0.png → ...ages/notebooks_facility-location_55_0.png b/...books_Use-case-facility-location_55_0.png → ...ages/notebooks_facility-location_55_0.png
diff --git a/...books_Use-case-facility-location_59_0.png → ...ages/notebooks_facility-location_59_0.png b/...books_Use-case-facility-location_59_0.png → ...ages/notebooks_facility-location_59_0.png
diff --git a/...books_Use-case-facility-location_63_0.png → ...ages/notebooks_facility-location_63_0.png b/...books_Use-case-facility-location_63_0.png → ...ages/notebooks_facility-location_63_0.png
diff --git a/...books_Use-case-facility-location_72_0.png → ...ages/notebooks_facility-location_72_0.png b/...books_Use-case-facility-location_72_0.png → ...ages/notebooks_facility-location_72_0.png
diff --git a/...ooks_Advanced-spaghetti-tutorial_32_0.png → ...mages/notebooks_network-analysis_32_0.png b/...ooks_Advanced-spaghetti-tutorial_32_0.png → ...mages/notebooks_network-analysis_32_0.png
diff --git a/...ooks_Advanced-spaghetti-tutorial_43_0.png → ...mages/notebooks_network-analysis_43_0.png b/...ooks_Advanced-spaghetti-tutorial_43_0.png → ...mages/notebooks_network-analysis_43_0.png
diff --git a/...ooks_Advanced-spaghetti-tutorial_46_0.png → ...mages/notebooks_network-analysis_46_0.png b/...ooks_Advanced-spaghetti-tutorial_46_0.png → ...mages/notebooks_network-analysis_46_0.png
diff --git a/...ooks_Advanced-spaghetti-tutorial_49_0.png → ...mages/notebooks_network-analysis_49_0.png b/...ooks_Advanced-spaghetti-tutorial_49_0.png → ...mages/notebooks_network-analysis_49_0.png
diff --git a/...tebooks_Basic-spaghetti-tutorial_30_0.png → docs/_images/notebooks_quickstart_30_0.png b/...tebooks_Basic-spaghetti-tutorial_30_0.png → docs/_images/notebooks_quickstart_30_0.png
diff --git a/docs/_images/notebooks_tsp_15_1.png b/docs/_images/notebooks_tsp_15_1.png
diff --git a/docs/_images/notebooks_tsp_17_1.png b/docs/_images/notebooks_tsp_17_1.png
diff --git a/docs/_images/notebooks_tsp_18_1.png b/docs/_images/notebooks_tsp_18_1.png
diff --git a/docs/_images/notebooks_tsp_20_1.png b/docs/_images/notebooks_tsp_20_1.png
diff --git a/docs/_images/notebooks_tsp_22_1.png b/docs/_images/notebooks_tsp_22_1.png
diff --git a/docs/_images/notebooks_tsp_25_1.png b/docs/_images/notebooks_tsp_25_1.png
diff --git a/docs/_images/notebooks_tsp_31_0.png b/docs/_images/notebooks_tsp_31_0.png
diff --git a/docs/_images/notebooks_tsp_32_0.png b/docs/_images/notebooks_tsp_32_0.png
diff --git a/docs/_images/notebooks_tsp_33_0.png b/docs/_images/notebooks_tsp_33_0.png
diff --git a/docs/_images/notebooks_tsp_38_0.png b/docs/_images/notebooks_tsp_38_0.png
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -69,11 +69,12 @@
 </ul>
 </li>
 <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/Shortest-path-visualization.html">Generating regular lattices and visualizing shortest paths</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>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/quickstart.html">Quickstart</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/shortest-path-visualization.html">Generating regular lattices and visualizing shortest paths</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/network-analysis.html">Spatial network analysis</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/facility-location.html">Demostrating network-based optimal facility location modeling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../notebooks/tsp.html">The Traveling Sales(man)(person) Problem — TSP</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../api.html">API</a><ul>

diff --git a/docs/_modules/spaghetti/network.html b/docs/_modules/spaghetti/network.html
@@ -69,11 +69,12 @@
 </ul>
 </li>
 <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/Shortest-path-visualization.html">Generating regular lattices and visualizing shortest paths</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>
+<li class="toctree-l2"><a class="reference internal" href="../../notebooks/quickstart.html">Quickstart</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/shortest-path-visualization.html">Generating regular lattices and visualizing shortest paths</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../notebooks/network-analysis.html">Spatial network analysis</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../notebooks/facility-location.html">Demostrating network-based optimal facility location modeling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../notebooks/tsp.html">The Traveling Sales(man)(person) Problem — TSP</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../api.html">API</a><ul>

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -21,23 +21,23 @@ and usage tutorials are provided here through the links above.
         <div class="col-sm-.5 col-xs-hidden">
         </div>
         <div class="col-md-4 col-xs-15">
-            <a href="https://pysal.org/spaghetti/notebooks/Basic-spaghetti-tutorial.html" class="thumbnail">
+            <a href="https://pysal.org/spaghetti/notebooks/quickstart.html" class="thumbnail">
                 <img src="_static/images/net_rep.png" class="img-responsive center-block">
                 <div class="caption text-center">
                 <h6>Network Representation</h6>
                 </div>
             </a>
         </div>
         <div class="col-sm-4 col-xs-15">
-            <a href="https://pysal.org/spaghetti/notebooks/Advanced-spaghetti-tutorial.html" class="thumbnail">
+            <a href="https://pysal.org/spaghetti/notebooks/network-analysis.html" class="thumbnail">
                 <img src="_static/images/network_k.png" class="img-responsive center-block">
                 <div class="caption text-center">
                 <h6>Spatial Network Analysis</h6>
                 </div>
             </a>
         </div>
         <div class="col-sm-4 col-xs-15">
-            <a href="https://pysal.org/spaghetti/notebooks/Use-case-facility-location.html" class="thumbnail">
+            <a href="https://pysal.org/spaghetti/notebooks/facility-location.html" class="thumbnail">
                 <img src="_static/images/facility_location.png"
                 class="img-responsive center-block">
                 <div class="caption text-center">

diff --git a/...ooks/Use-case-facility-location.ipynb.txt → ...ces/notebooks/facility-location.ipynb.txt b/...ooks/Use-case-facility-location.ipynb.txt → ...ces/notebooks/facility-location.ipynb.txt
diff --git a/...oks/Advanced-spaghetti-tutorial.ipynb.txt → ...rces/notebooks/network-analysis.ipynb.txt b/...oks/Advanced-spaghetti-tutorial.ipynb.txt → ...rces/notebooks/network-analysis.ipynb.txt
@@ -27,8 +27,8 @@
     "\n",
     "----------------\n",
     "\n",
-    "## Advanced `pysal.spaghetti` tutorial\n",
-    "### Creating and visualizing a `spaghetti.Network` object\n",
+    "## Spatial network analysis\n",
+    "### Demonstrating network representation and cluster detection\n",
     "\n",
     "**Author: James D. Gaboardi** **<jgaboardi@gmail.com>**\n",
     "\n",

diff --git a/notebooks/Basic-spaghetti-tutorial.ipynb → docs/_sources/notebooks/quickstart.ipynb.txt b/notebooks/Basic-spaghetti-tutorial.ipynb → docs/_sources/notebooks/quickstart.ipynb.txt
@@ -10,7 +10,7 @@
     "\n",
     "\n",
     "----------------\n",
-    "## Basic `pysal.spaghetti` tutorial\n",
+    "## Quickstart\n",
     "### Creating and visualizing a `spaghetti.Network` object\n",
     "\n",
     "**Author: James D. Gaboardi** **<jgaboardi@gmail.com>**\n",