superblockify

superblockify: A Python Package for Automated Generation, Visualization, and Analysis of Potential Superblocks in Cities - Published in JOSS (2024)

https://github.com/nerdsitu/superblockify

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 4 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org, zenodo.org
✓
Committers with academic emails
1 of 5 committers (20.0%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

geospatial gis network-analysis osmnx superblocks transportation-network urban-data-science urban-mobility urban-planning

Scientific Fields

Political Science Social Sciences - 90% confidence

Last synced: 4 months ago · JSON representation ·

Repository

Source code for superblockify

Basic Info

Host: GitHub
Owner: NERDSITU
License: agpl-3.0
Language: Python
Default Branch: main
Homepage: https://superblockify.city
Size: 189 MB

Statistics

Stars: 30
Watchers: 1
Forks: 4
Open Issues: 11
Releases: 7

Topics

geospatial gis network-analysis osmnx superblocks transportation-network urban-data-science urban-mobility urban-planning

Created about 3 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Code of conduct Citation

README.md

superblockify logo

Source code to superblockify an urban street network

superblockify is a Python package for partitioning an urban street network into Superblock-like neighborhoods and for visualizing and analyzing the partition results. A Superblock is a set of adjacent urban blocks where vehicular through traffic is prevented or pacified, giving priority to people walking and cycling.

superblockify concept

Installation

Set up environment

Use conda or mamba or micromamba to create the virtual environment sb_env:

bash conda create -n sb_env -c conda-forge superblockify conda activate sb_env

Note: While pip can install superblockify, it's not officially supported due to potential issues with C dependencies needed for OSMnx. If unsure, use conda as instructed above to avoid problems.

Alternatively, or if you run into issues, clone this repository and create the environment via the environment.yml file:

bash conda env create --file environment.yml conda activate sb_env pip install superblockify

Set up Jupyter kernel

If you want to use superblockify with its environment sb_env in Jupyter, run:

bash pip install --user ipykernel python -m ipykernel install --user --name=sb_env

This allows you to run Jupyter with the kernel sb_env (Kernel > Change Kernel > sb_env)

Usage

We provide a minimum working example in two formats:

For a guided start after installation, see the usage section in the documentation. See the examples/ folder for more example scripts.

Documentation

Read the documentation to learn more about superblockify.

Testing

The tests are specified using the pytest signature, see tests/ folder, and can be run using a test runner of choice. A pipeline is set up, see .github/workflows/test.yml.

Credits & Funding

Carlson M. Büth, @cbueth (Implementation)
Anastassia Vybornova, @anastassiavybornova (Supervision)
Michael Szell, @mszell (Concept)

Funded by the European Union, EU Horizon grant JUST STREETS

Owner

Name: NERDS
Login: NERDSITU
Kind: organization
Location: Denmark

Website: https://nerds.itu.dk/
Repositories: 1
Profile: https://github.com/NERDSITU

NEtworks, Data, and Society research group at ITU Copenhagen

JOSS Publication

superblockify: A Python Package for Automated Generation, Visualization, and Analysis of Potential Superblocks in Cities

Published

August 14, 2024

DOI

10.21105/joss.06798

Volume 9, Issue 100, Page 6798

Authors

Carlson M. Büth

NEtwoRks, Data, and Society (NERDS), Computer Science Department, IT University of Copenhagen, 2300 Copenhagen, Denmark, Institute for Cross-Disciplinary Physics and Complex Systems (IFISC), University of the Balearic Islands (UIB) and Spanish National Research Council (CSIC), 07122 Palma de Mallorca, Spain

Anastassia Vybornova

NEtwoRks, Data, and Society (NERDS), Computer Science Department, IT University of Copenhagen, 2300 Copenhagen, Denmark

Michael Szell

NEtwoRks, Data, and Society (NERDS), Computer Science Department, IT University of Copenhagen, 2300 Copenhagen, Denmark, ISI Foundation, 10126 Turin, Italy, Complexity Science Hub Vienna, 1080 Vienna, Austria

Editor

Chris Vernon

Citation (CITATION.cff)

cff-version: "1.2.0"
title: "superblockify: A Python Package for Automated Generation,
  Visualization, and Analysis of Potential Superblocks in Cities"
authors:
- family-names: Büth
  given-names: Carlson M.
  orcid: "https://orcid.org/0000-0003-2298-8438"
- family-names: Vybornova
  given-names: Anastassia
  orcid: "https://orcid.org/0000-0001-6915-2561"
- family-names: Szell
  given-names: Michael
  orcid: "https://orcid.org/0000-0003-3022-2483"
repository-code: 'https://github.com/NERDSITU/superblockify'
url: 'https://superblockify.city/'
keywords:
  - Python
  - urban planning
  - low traffic neighborhood
  - geospatial analysis
  - network analysis
  - urban mobility
  - urban data
license: AGPL-3.0-or-later
doi: 10.5281/zenodo.13300611
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Büth
    given-names: Carlson M.
    orcid: "https://orcid.org/0000-0003-2298-8438"
  - family-names: Vybornova
    given-names: Anastassia
    orcid: "https://orcid.org/0000-0001-6915-2561"
  - family-names: Szell
    given-names: Michael
    orcid: "https://orcid.org/0000-0003-3022-2483"
  date-published: 2024-08-14
  doi: 10.21105/joss.06798
  issn: 2475-9066
  issue: 100
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6798
  title: "superblockify: A Python Package for Automated Generation,
    Visualization, and Analysis of Potential Superblocks in Cities"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06798"
  volume: 9

GitHub Events

Total

Create event: 2
Release event: 1
Issues event: 3
Watch event: 5
Delete event: 1
Issue comment event: 5
Push event: 7
Pull request event: 1
Fork event: 1

Last Year

Create event: 2
Release event: 1
Issues event: 3
Watch event: 5
Delete event: 1
Issue comment event: 5
Push event: 7
Pull request event: 1
Fork event: 1

Committers

Last synced: 5 months ago

All Time

Total Commits: 763
Total Committers: 5
Avg Commits per committer: 152.6
Development Distribution Score (DDS): 0.356

Past Year

Commits: 20
Committers: 2
Avg Commits per committer: 10.0
Development Distribution Score (DDS): 0.1

Top Committers

Name	Email	Commits
Carlson Moses Büth	c**5@u**e	491
Carlson Moses Büth	4****h	249
Michael Szell	m**l@g**m	21
anvy	a**y@i**k	1
Lint Action	l**n@s**m	1

Committer Domains (Top 20 + Academic)

samuelmeuli.com: 1 itu.dk: 1 uni-muenster.de: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 68
Total pull requests: 32
Average time to close issues: about 1 month
Average time to close pull requests: 2 days
Total issue authors: 5
Total pull request authors: 2
Average comments per issue: 1.03
Average comments per pull request: 0.88
Merged pull requests: 32
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 8
Pull requests: 5
Average time to close issues: 2 days
Average time to close pull requests: 2 days
Issue authors: 4
Pull request authors: 1
Average comments per issue: 1.5
Average comments per pull request: 1.0
Merged pull requests: 5
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

cbueth (55)
caimeng2 (4)
erexer (3)
csebastiao (1)
SaraHishamBr (1)

Pull Request Authors

cbueth (35)
mszell (1)

Top Labels

Issue Labels

enhancement (29) low (11) new partitioner (8) high (5) later (4) bug (4) mid (3) active (1) documentation (1)

Pull Request Labels

enhancement (4) mid (4) high (2) bug (1) low (1) documentation (1)

Packages

Total packages: 1
Total downloads:
- pypi 35 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 13
Total maintainers: 1

pypi.org: superblockify

Automated Generation, Visualization, and Analysis of potential Superblocks in Cities

Documentation: https://superblockify.city/
License: APGL-3.0-or-later
Latest release: 1.0.1
published about 1 year ago

Versions: 13
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 35 Last month

Rankings

Dependent packages count: 9.6%

Average: 36.4%

Dependent repos count: 63.2%

Maintainers (1)

cbueth

Last synced: 4 months ago

Dependencies

.github/workflows/docs.yml actions

actions/cache v3 composite
actions/checkout v3 composite
actions/configure-pages v2 composite
actions/deploy-pages v1 composite
actions/upload-pages-artifact v1 composite
conda-incubator/setup-miniconda v2 composite

.github/workflows/lint.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
psf/black stable composite
stefanzweifel/git-auto-commit-action v4 composite

.github/workflows/test.yml actions

actions/cache v3 composite
actions/checkout v3 composite
actions/download-artifact v3 composite
actions/upload-artifact v3 composite
codecov/codecov-action v3 composite
conda-incubator/setup-miniconda v2 composite

pyproject.toml pypi

contextily *
geopandas *
numba *
osmnx *
psutil *
pyarrow *
rasterio *
ruamel.yaml *
seaborn *
shapely *
tqdm *
typing-extensions *

environment.yml pypi

superblockify

Science Score: 100.0%

Keywords

Scientific Fields

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Installation

Set up environment

Set up Jupyter kernel

Usage

Documentation

Testing

Credits & Funding

Owner

JOSS Publication

superblockify: A Python Package for Automated Generation, Visualization, and Analysis of Potential Superblocks in Cities

Authors

Editor

Tags

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: superblockify

Rankings

Maintainers (1)

Dependencies