Skip to main content

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

Project description

superblockify logo

Dev PyPI Version Python Version linting: pylint Code style: black PyPI License Master Thesis

status DOI Docs Lint Test codecov

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:

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:

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:

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

Funded by the European Union, EU Horizon grant JUST STREETS

More Information

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

superblockify-1.0.2.tar.gz (119.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

superblockify-1.0.2-py3-none-any.whl (122.9 kB view details)

Uploaded Python 3

File details

Details for the file superblockify-1.0.2.tar.gz.

File metadata

  • Download URL: superblockify-1.0.2.tar.gz
  • Upload date:
  • Size: 119.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for superblockify-1.0.2.tar.gz
Algorithm Hash digest
SHA256 418a9834b827a77ce5981603db1ddc1a2f612dee61a8cc7190964deb5109ce52
MD5 63b2cc3475f8648d4c33c4d73650720c
BLAKE2b-256 a8d59b636bc78505bc82a4dfaf607c35629c1906c147355073e7f4a64970e725

See more details on using hashes here.

Provenance

The following attestation bundles were made for superblockify-1.0.2.tar.gz:

Publisher: publish.yml on BikeNetKit/superblockify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file superblockify-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: superblockify-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 122.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for superblockify-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 14f0e159901205fad41a1e4108cd9dffc69b4ef95ae4d72dd736a56a1099ae1f
MD5 7cb856abe9c04d6bb7ce3d8870104ba4
BLAKE2b-256 d9c3c29f33669067c8fa7fbfe602ab2e8302eb3c8f0b6e6110ebfdeb3f95f99e

See more details on using hashes here.

Provenance

The following attestation bundles were made for superblockify-1.0.2-py3-none-any.whl:

Publisher: publish.yml on BikeNetKit/superblockify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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