superblockify 1.0.0rc6

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

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.

Installation

We recommend using micromamba to create a virtual environment and installing the package in editable mode. Alternatively, one can use conda or mamba to create the environment (they can be used interchangeably).

micromamba create -n sb_env -c conda-forge python=3.12 osmnx
micromamba activate sb_env
pip install superblockify

This installs the package and its dependencies, ready for use when activating the environment. Learn more about superblockify by reading the documentation with the usage section or the minimal working example.

Development Setup

For development, clone the repository, navigate to the root folder and create the environment with the wished python version and the development dependencies.

micromamba create -n sb_env -c conda-forge python=3.12 --file=environment.yml
micromamba activate sb_env

Now it is possible to import the package relatively to the root folder. Optionally, register the package in editable mode with pip:

pip install --no-build-isolation --no-deps -e .

Usage

For a quick start there are example scripts in the examples/ folder and a minimal working example.

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.