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

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

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.1.tar.gz (119.7 kB view details)

Uploaded Source

Built Distribution

superblockify-1.0.1-py3-none-any.whl (122.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: superblockify-1.0.1.tar.gz
  • Upload date:
  • Size: 119.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for superblockify-1.0.1.tar.gz
Algorithm Hash digest
SHA256 32ef497361502d3f57480512ee987a9463eb296e265aef9fc751fc4ebb1bd338
MD5 05a9da6510bfd1e85420a01588e330d3
BLAKE2b-256 ae3173d90f36e83eb34a5f055c1b763b375235db0408d1b26ae0ade483c97538

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for superblockify-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 88602e262ba263bae00bb5133799b2995e77a4bedc5cf2785829b0196a0b5ca5
MD5 3a3da63ec3e81b068c5d5845f9f9e75c
BLAKE2b-256 4ac4e6a7057c71a586c20500e064fd7034db96a45095613face8e4f905903694

See more details on using hashes here.

Supported by

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