=====
snkit
=====

a spatial networks toolkit


.. image:: https://img.shields.io/badge/github-snkit-brightgreen.svg
   :target: https://github.com/tomalrussell/snkit/
   :alt: snkit on github

.. image:: https://img.shields.io/pypi/l/snkit.svg
    :target: https://opensource.org/licenses/MIT
    :alt: License

.. image:: https://travis-ci.com/tomalrussell/snkit.png?branch=master
    :target: https://travis-ci.com/tomalrussell/snkit
    :alt: Build Status

.. image:: https://img.shields.io/pypi/v/snkit.svg
    :target: https://pypi.org/project/snkit/
    :alt: PyPI version


/ˈsnɪkɪt/ – sounds like `[snicket] <https://en.oxforddictionaries.com/definition/snicket>`_
(noun, Northern English) A narrow passage between houses; an alleyway. Alternatively, a python
package to help clean spatial networks data.


.. mdinclude:: ../../README.md
   :start-line: 17
   :end-line: 26

.. image:: _static/unconnected-network.png
   :alt: Unconnected network

.. mdinclude:: ../../README.md
   :start-line: 28
   :end-line: 39

.. image:: _static/connected-network.png
   :alt: Connected network

.. mdinclude:: ../../README.md
   :start-line: 41
   :end-line: 59

.. mdinclude:: ../../README.md
   :start-line: 78
   :end-line: 107


.. toctree::
   :maxdepth: 2
   :caption: Contents:


Contents
--------

.. toctree::
   :maxdepth: 2

   Getting Started <getting_started>

.. toctree::
   :maxdepth: 3

   Reference <api/modules>

.. toctree::
   :maxdepth: 1

   License <license>


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`