spaghetti
spaghetti: spatial network analysis in PySAL - Published in JOSS (2021)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
✓Committers with academic emails
5 of 24 committers (20.8%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Keywords from Contributors
Scientific Fields
Repository
SPAtial GrapHs: nETworks, Topology, & Inference
Basic Info
- Host: GitHub
- Owner: pysal
- License: bsd-3-clause
- Language: Python
- Default Branch: main
- Homepage: http://pysal.org/spaghetti/
- Size: 185 MB
Statistics
- Stars: 278
- Watchers: 26
- Forks: 73
- Open Issues: 3
- Releases: 49
Topics
Metadata Files
README.md
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.
An example of a network's minimum spanning tree:
||
|
|
|:---:|:---:|:---:|:---:|
|
|
|
|
|
|
|
|
|
|
|
|
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.
* Quickstart
* Shortest Path Visualization
* Caveats
Installation
Python >= 3.10 is tested for support by spaghetti. Please make sure that you are operating in a Python >= 3.10 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
History
spaghetti was
created and has evolved in line with the Python Spatial Analysis Library ecosystem for
the specific purpose of utilizing the functionality of spatial weights in
libpysal for generating network segment contiguity objects.
The PySAL project was started in the mid-2000s when installation was difficult to maintain.
Due to the non-triviality of relying on dependencies to secondary packages, a conscious
decision was made to limit dependencies and build native PySAL data structures in cases
where at all possible. Therefore, the original pysal.network submodule was developed to
address the need for integrating support for network data structures with PySAL weights
data structures, with the target audience being spatial data scientists and anyone
interested in investigating network-centric phenomena within PySAL. Owing to the
co-development of network functionality found within spaghetti and the evolution of
the wider PySAL ecosystem, today, the package provides specialized network functionality
that easily integrates with the rest of PySAL. This allows users of spaghetti’s network
functionality to access spatial analysis functionality that complements network analysis,
such as spatial statistical tools with esda and integration with core components of
libpysal: libpysal.weights (mentioned above),
libpysal.cg (computational geometry and data structures),
libpysal.io (input-output), and libpysal.examples (built-in example data).
Contribute
PySAL-spaghetti is under active development and contributors are welcome.
If you have any suggestions, feature requests, or bug reports, please open new issues on GitHub. To submit patches, please review PySAL's documentation for developers, 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, start a discussion, or talk to us in PySAL's Discord channel. All questions, comments, & discussions should happen in a public forum, where possible. Private messages and emails will not be answered in a substantive manner.
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 citations:
``` @article{Gaboardi2021, doi = {10.21105/joss.02826}, url = {https://doi.org/10.21105/joss.02826}, year = {2021}, publisher = {The Open Journal}, volume = {6}, number = {62}, pages = {2826}, author = {James D. Gaboardi and Sergio Rey and Stefanie Lumnitz}, title = {spaghetti: spatial network analysis in PySAL}, journal = {Journal of Open Source Software} }
@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
Owner
- Name: Python Spatial Analysis Library
- Login: pysal
- Kind: organization
- Repositories: 37
- Profile: https://github.com/pysal
JOSS Publication
spaghetti: spatial network analysis in PySAL
Authors
Tags
PySAL spatial networks network analysisGitHub Events
Total
- Issues event: 25
- Watch event: 8
- Delete event: 3
- Issue comment event: 24
- Push event: 4
- Pull request review event: 2
- Pull request event: 7
- Fork event: 3
- Create event: 4
Last Year
- Issues event: 25
- Watch event: 8
- Delete event: 3
- Issue comment event: 24
- Push event: 4
- Pull request review event: 2
- Pull request event: 7
- Fork event: 3
- Create event: 4
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| James Gaboardi | j****i@g****m | 1,723 |
| Serge Rey | s****y@g****m | 122 |
| Jay | j****a@a****u | 73 |
| dependabot[bot] | 4****] | 38 |
| Wei Kang | w****9@g****m | 22 |
| James Gaboardi | j****i@f****u | 21 |
| pre-commit-ci[bot] | 6****] | 18 |
| ljwolf | l****f@g****m | 5 |
| github-actions[bot] | 4****] | 5 |
| David Folch | d****h@g****m | 4 |
| David Folch | d****h@t****l | 4 |
| Philip Stephens | p****s@g****m | 3 |
| rahul799 | r****0@g****m | 2 |
| Stefanie Lumnitz | s****z@g****m | 2 |
| Omar | s****d@z****g | 2 |
| Sergio Rey | s****e@b****l | 2 |
| ljwolf | l****2@a****u | 2 |
| ggarzonie | 7****e | 1 |
| Serge | s****e@x****h | 1 |
| Sergio Rey | s****e@l****n | 1 |
| Martin Fleischmann | m****n@m****t | 1 |
| Charles Schimdt | s****c@g****m | 1 |
| Arfon Smith | a****n | 1 |
| @tomgertin | t****n@v****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 69
- Total pull requests: 105
- Average time to close issues: almost 2 years
- Average time to close pull requests: 1 day
- Total issue authors: 8
- Total pull request authors: 6
- Average comments per issue: 2.19
- Average comments per pull request: 0.62
- Merged pull requests: 102
- Bot issues: 0
- Bot pull requests: 41
Past Year
- Issues: 1
- Pull requests: 8
- Average time to close issues: N/A
- Average time to close pull requests: about 2 hours
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 8
Top Authors
Issue Authors
- jGaboardi (56)
- iboates (3)
- adhamenaya (2)
- anitagraser (2)
- bright1993ff66 (1)
- Nilsonfsilva (1)
- samueltoro7 (1)
- ResidentMario (1)
Pull Request Authors
- jGaboardi (69)
- pre-commit-ci[bot] (26)
- dependabot[bot] (17)
- github-actions[bot] (5)
- martinfleis (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 28,156 last-month
- Total docker downloads: 218
-
Total dependent packages: 6
(may contain duplicates) -
Total dependent repositories: 67
(may contain duplicates) - Total versions: 81
- Total maintainers: 5
pypi.org: spaghetti
Analysis of Network-constrained Spatial Data
- Homepage: https://pysal.org/spaghetti/
- Documentation: https://spaghetti.readthedocs.io/
- License: BSD 3-Clause
-
Latest release: 1.7.6
published over 1 year ago
Rankings
Maintainers (5)
conda-forge.org: spaghetti
Spaghetti is an open-source Python library for the analysis of network-based spatial data. Originating from the network module in [PySAL](http://pysal.org) (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.
- Homepage: http://pysal.org/
- License: BSD-3-Clause
-
Latest release: 1.6.10
published about 3 years ago
Rankings
anaconda.org: spaghetti
Spaghetti is an open-source Python library for the analysis of network-based spatial data. Originating from the network module in [PySAL](https://pysal.org) (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.
- Homepage: https://pysal.org/spaghetti
- License: BSD-3-Clause
-
Latest release: 1.7.6
published 5 months ago
Rankings
Dependencies
- actions/checkout v3 composite
- ad-m/github-push-action master composite
- mamba-org/provision-with-micromamba main composite
- actions/checkout v3 composite
- actions/github-script v6 composite
- actions/setup-python v4 composite
- pypa/gh-action-pypi-publish release/v1 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- codecov/codecov-action v3 composite
- mamba-org/provision-with-micromamba main composite
- pre-commit/action v3.0.0 composite
- esda
- geopandas >=0.12.0
- libspatialindex
- matplotlib
- matplotlib-scalebar
- numpy
- pandas >=1.0
- pip
- pulp
- python 3.11.*
- rtree
- scipy >=1.0
- seaborn
- shapely >=2
- splot
- watermark
- esda *
- libpysal *
- numpy *
- pandas >=1.0
- rtree *
- scipy >=1.0
