Merge pull request #382 from jGaboardi/routes

[WIP][ENH] addressing shortest path extract
pysal · Jan 20, 2020 · 703aa82 · 703aa82
2 parents 07c128b + e277291
commit 703aa82
Show file tree

Hide file tree

Showing 80 changed files with 4,466 additions and 11,531 deletions.
diff --git a/docs/_images/notebooks_Advanced-spaghetti-tutorial_32_0.png b/docs/_images/notebooks_Advanced-spaghetti-tutorial_32_0.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_46_0.png b/docs/_images/notebooks_Advanced-spaghetti-tutorial_46_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_32_0.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_32_0.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_46_0.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_46_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_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_0.png b/docs/_images/notebooks_Connected-Components_16_0.png
diff --git a/docs/_images/notebooks_Connected-Components_30_0.png b/docs/_images/notebooks_Connected-Components_30_0.png
diff --git a/docs/_images/notebooks_Connected-Components_43_0.png b/docs/_images/notebooks_Connected-Components_43_0.png
diff --git a/docs/_images/notebooks_Shortest-path-visualization_13_0.png b/docs/_images/notebooks_Shortest-path-visualization_13_0.png
diff --git a/docs/_images/notebooks_Shortest-path-visualization_22_0.png b/docs/_images/notebooks_Shortest-path-visualization_22_0.png
diff --git a/docs/_images/notebooks_Shortest-path-visualization_24_0.png b/docs/_images/notebooks_Shortest-path-visualization_24_0.png
diff --git a/docs/_images/notebooks_Shortest-path-visualization_27_0.png b/docs/_images/notebooks_Shortest-path-visualization_27_0.png
diff --git a/docs/_images/notebooks_Shortest-path-visualization_31_0.png b/docs/_images/notebooks_Shortest-path-visualization_31_0.png
diff --git a/docs/_images/notebooks_Shortest-path-visualization_35_0.png b/docs/_images/notebooks_Shortest-path-visualization_35_0.png
diff --git a/docs/_images/notebooks_Shortest-path-visualization_37_0.png b/docs/_images/notebooks_Shortest-path-visualization_37_0.png
diff --git a/docs/_images/notebooks_Shortest-path-visualization_8_0.png b/docs/_images/notebooks_Shortest-path-visualization_8_0.png
diff --git a/docs/_images/notebooks_Use-case-facility-location_26_0.png b/docs/_images/notebooks_Use-case-facility-location_26_0.png
diff --git a/docs/_images/notebooks_Use-case-facility-location_31_0.png b/docs/_images/notebooks_Use-case-facility-location_31_0.png
diff --git a/docs/_images/notebooks_Use-case-facility-location_37_0.png b/docs/_images/notebooks_Use-case-facility-location_37_0.png
diff --git a/docs/_images/notebooks_Use-case-facility-location_45_0.png b/docs/_images/notebooks_Use-case-facility-location_45_0.png
diff --git a/docs/_images/notebooks_Use-case-facility-location_51_0.png b/docs/_images/notebooks_Use-case-facility-location_51_0.png
diff --git a/docs/_images/notebooks_Use-case-facility-location_55_0.png b/docs/_images/notebooks_Use-case-facility-location_55_0.png
diff --git a/docs/_images/notebooks_Use-case-facility-location_59_0.png b/docs/_images/notebooks_Use-case-facility-location_59_0.png
diff --git a/docs/_images/notebooks_Use-case-facility-location_63_0.png b/docs/_images/notebooks_Use-case-facility-location_63_0.png
diff --git a/docs/_images/notebooks_Use-case-facility-location_72_0.png b/docs/_images/notebooks_Use-case-facility-location_72_0.png
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -69,15 +69,16 @@
 </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/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/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>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../api.html">API</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../api.html#network-feature-instantiation">Network feature instantiation</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../api.html#network-feature-extraction">Network feature extraction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#network-feature-extraction-and-creation">Network feature extraction and creation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../api.html#save-and-load-a-network">Save and load a network</a></li>
 </ul>
 </li>

diff --git a/docs/_modules/spaghetti/network.html b/docs/_modules/spaghetti/network.html
diff --git a/docs/_sources/api.rst.txt b/docs/_sources/api.rst.txt
@@ -18,13 +18,14 @@ Network feature instantiation
     spaghetti.PointPattern
 
 
-Network feature extraction
---------------------------
+Network feature extraction and creation
+---------------------------------------
 
 .. autosummary::
    :toctree: generated/
 
     spaghetti.element_as_gdf
+    spaghetti.regular_lattice
 
 
 Save and load a network

diff --git a/docs/_sources/generated/spaghetti.Network.rst.txt b/docs/_sources/generated/spaghetti.Network.rst.txt
@@ -30,6 +30,7 @@ spaghetti.Network
       ~Network.loadnetwork
       ~Network.nearestneighbordistances
       ~Network.savenetwork
+      ~Network.shortest_paths
       ~Network.simulate_observations
       ~Network.snapobservations
       ~Network.split_arcs

diff --git a/docs/_sources/generated/spaghetti.regular_lattice.rst.txt b/docs/_sources/generated/spaghetti.regular_lattice.rst.txt
@@ -0,0 +1,6 @@
+spaghetti.regular\_lattice
+==========================
+
+.. currentmodule:: spaghetti
+
+.. autofunction:: regular_lattice
diff --git a/...oks/Advanced_spaghetti_tutorial.ipynb.txt → ...oks/Advanced-spaghetti-tutorial.ipynb.txt b/...oks/Advanced_spaghetti_tutorial.ipynb.txt → ...oks/Advanced-spaghetti-tutorial.ipynb.txt
diff --git a/notebooks/Basic_spaghetti_tutorial.ipynb → ...ebooks/Basic-spaghetti-tutorial.ipynb.txt b/notebooks/Basic_spaghetti_tutorial.ipynb → ...ebooks/Basic-spaghetti-tutorial.ipynb.txt
@@ -27,16 +27,16 @@
    "execution_count": 1,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:46.368444Z",
-     "start_time": "2020-01-17T01:56:45.899221Z"
+     "end_time": "2020-01-20T21:01:54.314165Z",
+     "start_time": "2020-01-20T21:01:53.954241Z"
     }
    },
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "2020-01-16T20:56:46-05:00\n",
+      "2020-01-20T16:01:54-05:00\n",
       "\n",
       "CPython 3.7.3\n",
       "IPython 7.10.2\n",
@@ -77,24 +77,27 @@
    "execution_count": 2,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:48.430556Z",
-     "start_time": "2020-01-17T01:56:46.372232Z"
+     "end_time": "2020-01-20T21:01:56.028170Z",
+     "start_time": "2020-01-20T21:01:54.324256Z"
     }
    },
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "spaghetti  1.4.0\n",
-      "libpysal   4.2.0\n",
+      "watermark 2.0.2\n",
       "matplotlib 3.1.2\n",
+      "libpysal   4.2.0\n",
+      "geopandas  0.6.2\n",
+      "spaghetti  1.4.0\n",
       "\n"
      ]
     }
    ],
    "source": [
     "import spaghetti\n",
+    "import geopandas\n",
     "import libpysal\n",
     "import matplotlib\n",
     "import matplotlib.pyplot as plt\n",
@@ -105,6 +108,7 @@
     "except ImportError:\n",
     "    pass\n",
     "%matplotlib inline\n",
+    "%watermark -w\n",
     "%watermark -iv"
    ]
   },
@@ -122,8 +126,8 @@
    "execution_count": 3,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:48.631941Z",
-     "start_time": "2020-01-17T01:56:48.439541Z"
+     "end_time": "2020-01-20T21:01:56.176925Z",
+     "start_time": "2020-01-20T21:01:56.035562Z"
     }
    },
    "outputs": [],
@@ -145,8 +149,8 @@
    "execution_count": 4,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:48.742811Z",
-     "start_time": "2020-01-17T01:56:48.637130Z"
+     "end_time": "2020-01-20T21:01:56.299463Z",
+     "start_time": "2020-01-20T21:01:56.180604Z"
     }
    },
    "outputs": [],
@@ -173,8 +177,8 @@
    "execution_count": 5,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:48.755458Z",
-     "start_time": "2020-01-17T01:56:48.745674Z"
+     "end_time": "2020-01-20T21:01:56.316411Z",
+     "start_time": "2020-01-20T21:01:56.302218Z"
     }
    },
    "outputs": [
@@ -207,8 +211,8 @@
    "execution_count": 6,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.051498Z",
-     "start_time": "2020-01-17T01:56:48.758790Z"
+     "end_time": "2020-01-20T21:01:56.570863Z",
+     "start_time": "2020-01-20T21:01:56.324019Z"
     }
    },
    "outputs": [],
@@ -230,8 +234,8 @@
    "execution_count": 7,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.069485Z",
-     "start_time": "2020-01-17T01:56:49.053808Z"
+     "end_time": "2020-01-20T21:01:56.586688Z",
+     "start_time": "2020-01-20T21:01:56.573341Z"
     }
    },
    "outputs": [
@@ -268,8 +272,8 @@
    "execution_count": 8,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.099769Z",
-     "start_time": "2020-01-17T01:56:49.081243Z"
+     "end_time": "2020-01-20T21:01:56.609831Z",
+     "start_time": "2020-01-20T21:01:56.596821Z"
     }
    },
    "outputs": [],
@@ -294,8 +298,8 @@
    "execution_count": 9,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.121441Z",
-     "start_time": "2020-01-17T01:56:49.108603Z"
+     "end_time": "2020-01-20T21:01:56.624656Z",
+     "start_time": "2020-01-20T21:01:56.615901Z"
     }
    },
    "outputs": [
@@ -329,8 +333,8 @@
    "execution_count": 10,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.173079Z",
-     "start_time": "2020-01-17T01:56:49.134111Z"
+     "end_time": "2020-01-20T21:01:56.651296Z",
+     "start_time": "2020-01-20T21:01:56.629590Z"
     }
    },
    "outputs": [],
@@ -355,8 +359,8 @@
    "execution_count": 11,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.190149Z",
-     "start_time": "2020-01-17T01:56:49.175804Z"
+     "end_time": "2020-01-20T21:01:56.663904Z",
+     "start_time": "2020-01-20T21:01:56.653837Z"
     }
    },
    "outputs": [
@@ -389,8 +393,8 @@
    "execution_count": 12,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.624133Z",
-     "start_time": "2020-01-17T01:56:49.200620Z"
+     "end_time": "2020-01-20T21:01:57.061996Z",
+     "start_time": "2020-01-20T21:01:56.672769Z"
     }
    },
    "outputs": [],
@@ -411,8 +415,8 @@
    "execution_count": 13,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.640252Z",
-     "start_time": "2020-01-17T01:56:49.626629Z"
+     "end_time": "2020-01-20T21:01:57.075285Z",
+     "start_time": "2020-01-20T21:01:57.065224Z"
     }
    },
    "outputs": [],
@@ -438,8 +442,8 @@
    "execution_count": 14,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.659822Z",
-     "start_time": "2020-01-17T01:56:49.642924Z"
+     "end_time": "2020-01-20T21:01:57.086338Z",
+     "start_time": "2020-01-20T21:01:57.078242Z"
     }
    },
    "outputs": [],
@@ -459,8 +463,8 @@
    "execution_count": 15,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.683937Z",
-     "start_time": "2020-01-17T01:56:49.667995Z"
+     "end_time": "2020-01-20T21:01:57.099798Z",
+     "start_time": "2020-01-20T21:01:57.091120Z"
     }
    },
    "outputs": [],
@@ -483,8 +487,8 @@
    "execution_count": 16,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:49.701462Z",
-     "start_time": "2020-01-17T01:56:49.687850Z"
+     "end_time": "2020-01-20T21:01:57.118352Z",
+     "start_time": "2020-01-20T21:01:57.104353Z"
     }
    },
    "outputs": [],
@@ -505,8 +509,8 @@
    "execution_count": 17,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2020-01-17T01:56:51.253004Z",
-     "start_time": "2020-01-17T01:56:49.706962Z"
+     "end_time": "2020-01-20T21:01:58.158025Z",
+     "start_time": "2020-01-20T21:01:57.121549Z"
     }
    },
    "outputs": [