.. documentation master file

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.


.. raw:: html

    <div class="container-fluid">
      <div class="row equal-width">
        <div class="col-sm-.5 col-xs-hidden">
        </div>
        <div class="col-md-4 col-xs-15">
            <a href="http://nbviewer.jupyter.org/gist/jGaboardi/0d9ea5c966a4ad57123bef35b87c4607?flush_cache=true" class="thumbnail">
                <img src="_static/images/snapped.png" class="img-responsive center-block">
                <div class="caption text-center">
                <h6>Snapping Points to Segments</h6>
                </div>
            </a>
        </div>
        <div class="col-sm-4 col-xs-15">
            <a href="http://nbviewer.jupyter.org/gist/jGaboardi/2697ff11933bb0ea8b94c4326a540453?flush_cache=true" class="thumbnail">
                <img src="_static/images/network_k.png" class="img-responsive center-block">
                <div class="caption text-center">
                <h6>Spaghetti Network Functionality</h6>
                </div>
            </a>
        </div>
        <div class="col-sm-4 col-xs-15">
            <a href="http://nbviewer.jupyter.org/gist/jGaboardi/a671d31a796e06d9df669d018d5b66ba?flush_cache=true" class="thumbnail">
                <img src="_static/images/pmedian.png"
                class="img-responsive center-block">
                <div class="caption text-center">
                <h6>Optimal Facility Location: Integration with ortools
                </h6>
                </div>
            </a>
        </div>
        <div class="col-sm-.5 col-xs-hidden">
        </div>
      </div>
    </div>


Citing spaghetti
----------------

If you use PySAL-spaghetti in a scientific publication, we would appreciate using the following citation:

  Bibtex entry::

      @misc{Gaboardi2018,
        author = {Gaboardi, James D. and Laura, Jay and Rey, Sergio and Wolf, Levi John and Folch, David C. and Kang, Wei and Stephens, Philip and Schmidt, Charles},
        month = {oct},
        year = {2018},
        title = {pysal/spaghetti},
        url = {https://github.com/pysal/spaghetti},
        keywords = {graph-theory,network-analysis,python,spatial-networks,topology}
      }


.. toctree::
   :hidden:
   :maxdepth: 3
   :caption: Contents:

   Installation <installation>
   API <api>
   References <references>


.. _PySAL: https://github.com/pysal/pysal