superblockify 1.0.0rc4

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

superblockify

Source code for blockifying existing street networks.

---

Installation

Create a new environment with conda or mamba and install the package from the conda-forge channel.

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

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

Development Setup

For development, 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). After cloning 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.

Logging

The logging is done using the logging module. The logging level can be set in the setup.cfg file. The logging level can be set to DEBUG, INFO, WARNING, ERROR or CRITICAL. It defaults to INFO and a rotating file handler is set up to log to results/logs/superblockify.log. The log file is rotated every megabyte, and the last three log files are kept.

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.