Merge pull request #342 from jGaboardi/rahul799_bugfix

[ENH][WIP]extension of #339: Rahul799 docs/bugfix
pysal · Jan 1, 2020 · 0715292 · 0715292
2 parents 3421d64 + 496b302
commit 0715292
Show file tree

Hide file tree

Showing 151 changed files with 19,829 additions and 10,997 deletions.
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: 2ac6be91592b162199a125588015d026
+config: f5c4a77394b3c40018a06a45147226e8
 tags: 645f666f9bcd5a90fca523b33c5a78b7
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_44_0.png b/docs/_images/notebooks_Advanced_spaghetti_tutorial_44_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_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_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
@@ -12,6 +12,9 @@
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <script type="text/javascript" src="../_static/language_data.js"></script>
+    <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
+    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
+    <script type="text/x-mathjax-config">MathJax.Hub.Config({"TeX": {"equationNumbers": {"autoNumber": "AMS", "useLabelIds": true}}, "tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
     <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script>
     <script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-3.3.7/js/bootstrap.min.js"></script>
@@ -44,6 +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="../api.html">API</a></li>
                 <li><a href="../references.html">References</a></li>
 
@@ -64,11 +68,16 @@
 <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-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/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#spaghetti-network">spaghetti.Network</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti-pointpattern">spaghetti.PointPattern</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti-simulatedpointpattern">spaghetti.SimulatedPointPattern</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti">spaghetti</a></li>
+<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#save-and-load-a-network">Save and load a network</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../references.html">References</a></li>
@@ -131,7 +140,7 @@ <h1>All modules for which code is available</h1>
     </p>
     <p>
         &copy; Copyright 2018, pysal developers.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.<br/>
     </p>
   </div>
 </footer>

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
@@ -8,62 +8,30 @@ API reference
 .. _network_api:
 
 
-spaghetti.Network
------------------
+Network feature instantiation
+-----------------------------
 
 .. autosummary::
    :toctree: generated/
 
-    spaghetti.Network.extract_components
-    spaghetti.Network.extractgraph
-    spaghetti.Network.contiguityweights
-    spaghetti.Network.distancebandweights
-    spaghetti.Network.snapobservations
-    spaghetti.Network.compute_distance_to_vertices
-    spaghetti.Network.compute_snap_dist
-    spaghetti.Network.count_per_link
-    spaghetti.Network.simulate_observations
-    spaghetti.Network.enum_links_vertex
-    spaghetti.Network.full_distance_matrix
-    spaghetti.Network.allneighbordistances
-    spaghetti.Network.nearestneighbordistances
-    spaghetti.Network.split_arcs
-    spaghetti.Network.savenetwork
-    spaghetti.Network.loadnetwork
-    spaghetti.Network.NetworkF
-    spaghetti.Network.NetworkG
-    spaghetti.Network.NetworkK
-    spaghetti.Network._evaluate_napts
-    spaghetti.Network._extractnetwork
-    spaghetti.Network._newpoint_coords
-    spaghetti.Network._round_sig
-    spaghetti.Network._snap_to_link
-    spaghetti.Network._yield_napts
-    spaghetti.Network._yieldneighbor
-
-
-spaghetti.PointPattern
-----------------------
-
-.. autosummary::
-   :toctree: generated/
-
-   spaghetti.PointPattern
+    spaghetti.Network
+    spaghetti.PointPattern
 
 
-spaghetti.SimulatedPointPattern
--------------------------------
+Network feature extraction
+--------------------------
 
 .. autosummary::
    :toctree: generated/
-
-    spaghetti.SimulatedPointPattern
+    
+    spaghetti.element_as_gdf
 
 
-spaghetti
----------
+Save and load a network
+-----------------------
 
 .. autosummary::
    :toctree: generated/
-
-    spaghetti.element_as_gdf
+
+    spaghetti.Network.savenetwork
+    spaghetti.Network.loadnetwork
diff --git a/docs/_sources/generated/spaghetti.Network.NetworkF.rst.txt b/docs/_sources/generated/spaghetti.Network.NetworkF.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.NetworkG.rst.txt b/docs/_sources/generated/spaghetti.Network.NetworkG.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.NetworkK.rst.txt b/docs/_sources/generated/spaghetti.Network.NetworkK.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network._evaluate_napts.rst.txt b/docs/_sources/generated/spaghetti.Network._evaluate_napts.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network._extractnetwork.rst.txt b/docs/_sources/generated/spaghetti.Network._extractnetwork.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network._newpoint_coords.rst.txt b/docs/_sources/generated/spaghetti.Network._newpoint_coords.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network._round_sig.rst.txt b/docs/_sources/generated/spaghetti.Network._round_sig.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network._snap_to_link.rst.txt b/docs/_sources/generated/spaghetti.Network._snap_to_link.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network._yield_napts.rst.txt b/docs/_sources/generated/spaghetti.Network._yield_napts.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network._yieldneighbor.rst.txt b/docs/_sources/generated/spaghetti.Network._yieldneighbor.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.allneighbordistances.rst.txt b/docs/_sources/generated/spaghetti.Network.allneighbordistances.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.compute_distance_to_vertices.rst.txt b/docs/_sources/generated/spaghetti.Network.compute_distance_to_vertices.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.compute_snap_dist.rst.txt b/docs/_sources/generated/spaghetti.Network.compute_snap_dist.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.contiguityweights.rst.txt b/docs/_sources/generated/spaghetti.Network.contiguityweights.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.count_per_link.rst.txt b/docs/_sources/generated/spaghetti.Network.count_per_link.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.distancebandweights.rst.txt b/docs/_sources/generated/spaghetti.Network.distancebandweights.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.enum_links_vertex.rst.txt b/docs/_sources/generated/spaghetti.Network.enum_links_vertex.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.extract_components.rst.txt b/docs/_sources/generated/spaghetti.Network.extract_components.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.extractgraph.rst.txt b/docs/_sources/generated/spaghetti.Network.extractgraph.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.full_distance_matrix.rst.txt b/docs/_sources/generated/spaghetti.Network.full_distance_matrix.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.nearestneighbordistances.rst.txt b/docs/_sources/generated/spaghetti.Network.nearestneighbordistances.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.rst.txt b/docs/_sources/generated/spaghetti.Network.rst.txt
@@ -0,0 +1,41 @@
+spaghetti.Network
+=================
+
+.. currentmodule:: spaghetti
+
+.. autoclass:: Network
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Network.NetworkF
+      ~Network.NetworkG
+      ~Network.NetworkK
+      ~Network.__init__
+      ~Network.allneighbordistances
+      ~Network.compute_distance_to_vertices
+      ~Network.compute_snap_dist
+      ~Network.contiguityweights
+      ~Network.count_per_link
+      ~Network.distancebandweights
+      ~Network.enum_links_vertex
+      ~Network.extract_components
+      ~Network.extractgraph
+      ~Network.full_distance_matrix
+      ~Network.loadnetwork
+      ~Network.nearestneighbordistances
+      ~Network.savenetwork
+      ~Network.simulate_observations
+      ~Network.snapobservations
+      ~Network.split_arcs
+
+
+
+
+
+
diff --git a/docs/_sources/generated/spaghetti.Network.simulate_observations.rst.txt b/docs/_sources/generated/spaghetti.Network.simulate_observations.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.snapobservations.rst.txt b/docs/_sources/generated/spaghetti.Network.snapobservations.rst.txt
diff --git a/docs/_sources/generated/spaghetti.Network.split_arcs.rst.txt b/docs/_sources/generated/spaghetti.Network.split_arcs.rst.txt
diff --git a/docs/_sources/generated/spaghetti.SimulatedPointPattern.rst.txt b/docs/_sources/generated/spaghetti.SimulatedPointPattern.rst.txt