Metadata-Version: 2.1
Name: spaghetti
Version: 1.5.0rc12
Summary: Analysis of Network-constrained Spatial Data
Home-page: https://github.com/pysal/spaghetti
Maintainer: James D. Gaboardi
Maintainer-email: jgaboardi@gmail.com
License: 3-Clause BSD
Download-URL: https://pypi.org/project/spaghetti
Description: <p align="center">
        <img src="docs/_static/images/pysal_nav_logo_2line.svg" width="370" height="200" />
        <img src="docs/_static/images/spaghetti_nav_logo.svg" width="480" height="200" />
        </p>
        
        # [pysal/spaghetti](http://pysal.org/spaghetti/)
        
        # *SPA*tial *G*rap*H*s: n*ET*works, *T*opology, & *I*nference
        
        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. This package is part of a [refactoring of PySAL](https://github.com/pysal/pysal/wiki/PEP-13:-Refactor-PySAL-Using-Submodules).
        
        *An example of a network's [minimum spanning tree](https://pysal.org/spaghetti/generated/spaghetti.spanning_tree.html#spaghetti.spanning_tree):*<p align="center">
        <img src="docs/_static/images/mst_logo_pasta.png" width="600" height="225" />
        </p>
        
        |[![PyPI version](https://badge.fury.io/py/spaghetti.svg)](https://badge.fury.io/py/spaghetti)| [![Conda Version](https://img.shields.io/conda/vn/conda-forge/spaghetti.svg)](https://anaconda.org/conda-forge/spaghetti) | ![tag](https://img.shields.io/github/v/release/pysal/spaghetti?include_prereleases&sort=semver) | [![GitHub issues open](https://img.shields.io/github/issues/pysal/spaghetti.svg?maxAge=3600)](https://github.com/pysal/spaghetti/issues) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pysal/spaghetti/master)
        |:---:|:---:|:---:|:---:|:---:|
        |[![Downloads](https://pepy.tech/badge/spaghetti)](https://pepy.tech/project/spaghetti) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/spaghetti.svg)](https://anaconda.org/conda-forge/spaghetti) | [![Documentation](https://img.shields.io/static/v1.svg?label=docs&message=current&color=9cf)](http://pysal.org/spaghetti/) | [![GitHub issues closed](https://img.shields.io/github/issues-closed/pysal/spaghetti.svg?maxAge=3600)](https://github.com/pysal/spaghetti/issues) | [![Gitter](https://badges.gitter.im/pysal/Spaghetti.svg)](https://gitter.im/pysal/Spaghetti?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
        | ![Pypi python versions](https://img.shields.io/pypi/pyversions/spaghetti.svg) | [![Conda Recipe](https://img.shields.io/badge/recipe-spaghetti-red.svg)](https://github.com/conda-forge/spaghetti-feedstock) | [![codecov](https://codecov.io/gh/pysal/spaghetti/branch/master/graph/badge.svg)](https://codecov.io/gh/pysal/spaghetti) | ![Github pull requests open](https://img.shields.io/github/issues-pr/pysal/spaghetti.svg) | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        | [![unittests](https://github.com/pysal/spaghetti/workflows/.github/workflows/unittests.yml/badge.svg)](https://github.com/pysal/spaghetti/actions?query=workflow%3A.github%2Fworkflows%2Funittests.yml) | :spaghetti: | [![DOI](https://zenodo.org/badge/88305306.svg)](https://zenodo.org/badge/latestdoi/88305306) | ![Github pull requests closed](https://img.shields.io/github/issues-pr-closed/pysal/spaghetti.svg) | [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
        
        
        ## Examples
        
        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.
        * [Quickstart](https://pysal.org/spaghetti/notebooks/quickstart.html)
        * [Shortest Path Visualization](https://pysal.org/spaghetti/notebooks/shortest-path-visualization.html)
        * [Caveats](https://pysal.org/spaghetti/notebooks/caveats.html)
        
        
        ## Installation
        
        As of version 1.4.2, `spaghetti` officially supports Python [3.6](https://docs.python.org/3.6/), [3.7](https://docs.python.org/3.7/), and [3.8](https://docs.python.org/3.8/). Please make sure that you are operating in a Python >= 3.6 environment.
        
        **Installing with `conda` via [`conda-forge`](https://github.com/conda-forge/spaghetti-feedstock) (highly recommended)**
        
        To install `spaghetti` and all its dependencies, we recommend using the [`conda`](https://docs.conda.io/en/latest/)
        manager, specifically with the [`conda-forge`](https://conda-forge.org) channel. This can be obtained by installing the [`Anaconda Distribution`](https://docs.continuum.io/anaconda/) (a free Python distribution for data science), or through [`miniconda`](https://docs.conda.io/en/latest/miniconda.html) (minimal distribution only containing Python and the conda package manager). 
        
        Using `conda`, `spaghetti` can be installed as follows:
        ```
        $ conda config --set channel_priority strict
        $ conda install --channel conda-forge spaghetti
        ```
        Also, `geopandas` provides [a nice example](https://geopandas.org/install.html#creating-a-new-environment) to create a fresh environment for working with spatial data.
        
        **Installing with [`PyPI`](https://pypi.org/project/spaghetti/)**
        ```
        $ pip install spaghetti
        ```
        *or* download the source distribution (`.tar.gz`) and decompress it to your selected destination. Open a command shell and navigate to the decompressed folder.
        ```
        $ pip install .
        ```
        
        ***Warning***
        
        When installing via `pip`, you have to ensure that the required dependencies for `spaghetti` are installed on your operating system. Details on how to install these packages are linked below. Using `conda` (above) avoids having to install the dependencies separately.
        
        Install the most current development version of `spaghetti` by running:
        
        ```
        $ pip install git+https://github.com/pysal/spaghetti
        ```
        
        
        ## Requirements
        
        - [`esda`](https://esda.readthedocs.io/en/latest/)
        - [`libspatialindex`](https://libspatialindex.org/index.html)
        - [`numpy`](https://numpy.org/devdocs/)
        - [`rtree`](http://toblerity.org/rtree/install.html)
        - [`scipy`](http://scipy.github.io/devdocs/)
        
        ## Soft Dependencies
        
        - [`geopandas`](http://geopandas.org/install.html)
        - [`shapely`](https://shapely.readthedocs.io/en/latest/)
        
        ##  Contribute
        
        PySAL-spaghetti is under active development and contributors are welcome.
        
        If you have any suggestion, feature request, or bug report, please open a new [issue](https://github.com/pysal/spaghetti/issues) on GitHub. To submit patches, please review [PySAL: Getting Started](http://pysal.org/getting_started#for-developers), the PySAL [development guidelines](https://github.com/pysal/pysal/wiki), the `spaghetti` [contributing guidelines](https://github.com/pysal/spaghetti/blob/master/.github/CONTRIBUTING.md) before  opening a [pull request](https://github.com/pysal/spaghetti/pulls). Once your changes get merged, you’ll automatically be added to the [Contributors List](https://github.com/pysal/spaghetti/graphs/contributors).
        
        ## Support
        
        If you are having issues, please [create an issue](https://github.com/pysal/spaghetti/issues) or talk to us in the [gitter room](https://gitter.im/pysal/spaghetti).
        
        
        ## Code of Conduct
        
        As a PySAL-federated project, `spaghetti` follows the [Code of Conduct](https://github.com/pysal/governance/blob/master/conduct/code_of_conduct.rst) under the [PySAL governance model](https://github.com/pysal/governance).
        
        
        ## License
        
        The project is licensed under the [BSD 3-Clause license](https://github.com/pysal/spaghetti/blob/master/LICENSE.txt).
        
        ## BibTeX Citation
        
        If you use PySAL-spaghetti in a scientific publication, we would appreciate using the following citation:
        
        ```
        @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},
            doi       = {10.5281/zenodo.1343650},
            keywords  = {graph-theory,network-analysis,python,spatial-networks,topology}
        }
        ```
        
        
        ## Funding
        This project is/was partially funded through:
        
        [<img align="middle" src="docs/_static/images/ardc_logo.png" width="150">](https://atlantardc.wordpress.com) Atlanta Research Data Center: [A Polygon-Based Approach to Spatial Network Allocation](https://atlantardc.files.wordpress.com/2018/05/ardc-newsletter_2018_2.pdf)
        
        [<img align="middle" src="docs/_static/images/nsf_logo.png" width="100">](https://www.nsf.gov/index.jsp) National Science Foundation Award #1825768: [National Historical Geographic Information System](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1825768&HistoricalAwards=false)
        
        
Keywords: spatial statistics,networks,graphs
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >3.5
Description-Content-Type: text/markdown
Provides-Extra: nb_pypi
Provides-Extra: docs
Provides-Extra: plus
Provides-Extra: tests
Provides-Extra: nb_conda
Provides-Extra: dev
