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 python=3.12 osmnx=1.9.2

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

Install package#

Next, activate the environment and install the package:

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)

For a guided start after installation, see the following Usage section.