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-community

# 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-community

# 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-community
Launch Jupyter Lab to explore UrbanMapper: 
jupyter lab

➡️ Optional extras (optional modules)

Install optional capabilities on demand:

Notebook tooling

pip install urban-mapper-community[notebook]
uv add urban-mapper-community --group notebook

Interactive table visualisations

pip install urban-mapper-community[interactive_table_vis]
uv add urban-mapper-community --group interactive_table_vis

Auctus mixins

pip install urban-mapper-community[auctus_mixins]
uv add urban-mapper-community --group auctus_mixins

Pipeline generators

pip install urban-mapper-community[pipeline_generators]
uv add urban-mapper-community --group pipeline_generators

JupyterGIS mixins

pip install urban-mapper-community[jupytergis_mixins]
uv add urban-mapper-community --group jupytergis_mixins

Everything at once

pip install urban-mapper-community[full]
uv add urban-mapper-community --group full

➡️ 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, Provost Simon