Skip to main content

Analysis of Network-constrained Spatial Data

Project description

pysal/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), 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.

An example of a network's minimum spanning tree:

PyPI version Conda Version tag GitHub issues open Binder
Downloads Conda Downloads Documentation GitHub issues closed Gitter
Pypi python versions Conda Recipe codecov Github pull requests open Code style: black
unittests :spaghetti: DOI Github pull requests closed License

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 section of the documentation. See the pysal/notebooks project for a jupyter-book version of this repository.

Installation

As of version 1.4.2, spaghetti officially supports Python 3.6, 3.7, and 3.8. Please make sure that you are operating in a Python >= 3.6 environment.

Installing with conda via conda-forge (highly recommended)

To install spaghetti and all its dependencies, we recommend using the conda manager, specifically with the conda-forge channel. This can be obtained by installing the Anaconda Distribution (a free Python distribution for data science), or through miniconda (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 to create a fresh environment for working with spatial data.

Installing with PyPI

$ 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

Soft Dependencies

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 on GitHub. To submit patches, please review PySAL: Getting Started, the PySAL development guidelines, the spaghetti contributing guidelines before opening a pull request. Once your changes get merged, you’ll automatically be added to the Contributors List.

Support

If you are having issues, please create an issue or talk to us in the gitter room.

Code of Conduct

As a PySAL-federated project, spaghetti follows the Code of Conduct under the PySAL governance model.

License

The project is licensed under the BSD 3-Clause license.

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:

Atlanta Research Data Center: A Polygon-Based Approach to Spatial Network Allocation

National Science Foundation Award #1825768: National Historical Geographic Information System

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spaghetti-1.5.0rc0.tar.gz (54.9 kB view details)

Uploaded Source

Built Distribution

spaghetti-1.5.0rc0-py3-none-any.whl (44.1 kB view details)

Uploaded Python 3

File details

Details for the file spaghetti-1.5.0rc0.tar.gz.

File metadata

  • Download URL: spaghetti-1.5.0rc0.tar.gz
  • Upload date:
  • Size: 54.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.3

File hashes

Hashes for spaghetti-1.5.0rc0.tar.gz
Algorithm Hash digest
SHA256 7b89a6a090f104e86b35bde77cd746df9f42d8d164863ccabeb93774aa92a9c0
MD5 f75415475bc7520108f000dcefc9d080
BLAKE2b-256 dcc2150075d5c7d1de4f4683e195603f2415ebf7deb7a80906e491d3ccfb3cbf

See more details on using hashes here.

File details

Details for the file spaghetti-1.5.0rc0-py3-none-any.whl.

File metadata

  • Download URL: spaghetti-1.5.0rc0-py3-none-any.whl
  • Upload date:
  • Size: 44.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.3

File hashes

Hashes for spaghetti-1.5.0rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 40e2e86b355ac8c0f785812d874b3f77ae4593143aa9f63a3a12eae442fa1696
MD5 730de452fca7cf23faa87eab879018b0
BLAKE2b-256 fd1b7da865d75c2a0126730610545c9e6a04edfae33f366fe51a3eaf8f9f83bc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page