Skip to content

How to Install UrbanMapper?

UrbanMapper is a Python package designed for urban spatial data analysis. Before you start, you’ll need to setup your environment and install the appropriate packages. UrbanMapper requires Python 3.10 or higher.

➡️ Via Virtual environment

We recommend you to install UrbanMapper in a virtual environment to keep things tidy and avoid dependency conflicts. You can set up your environment using uv (recommended), conda, or a virtual environment.

# Install the package from PyPI
uv add urban-mapper

# Launch Jupyter Lab to explore `UrbanMapper` (faster than running Jupyter without uv)
uv run --with jupyter jupyter lab
Optional: Get into your UV's venv despite not being necessary / recommended by UV

#Create and activate a virtual environment using the pinned Python version
uv venv
source .venv/bin/activate
jupyter lab

# To exit the environment
deactivate

# Create and activate a conda environment
conda create -n umenv python=3.10
conda activate umenv

# Install the package from PyPI
pip install urban-mapper

# Launch Jupyter Lab to explore `UrbanMapper`
jupyter lab

# To exit the environment
conda deactivate

➡️ Via Pip

The most straightforward way to install UrbanMapper is with pip (works in any environment): 

pip install urban-mapper
Launch Jupyter Lab to explore UrbanMapper: 
jupyter lab

➡️ From Source (Developer)

Building UrbanMapper from source lets you make changes to the code base. To install from the source, refer to the Project Setup Guide.

Provost Simon, sonia