leafmap

leafmap is a Python package designed for interactive mapping and geospatial analysis within Jupyter environments (such as Google Colab, Jupyter Notebook, JupyterLab, and marimo). It is a spin-off of the geemap package, specifically designed for users who do not require Google Earth Engine (GEE).

Key characteristics:

• Minimal Coding: Enables loading and visualizing geospatial datasets with very little code.
• Interactive GUI: Provides tools to load vector and raster data and perform advanced geospatial analysis (via WhiteboxTools) directly through a user interface.
• Bidirectional Communication: Leverages ipyleaflet to allow interaction between the map frontend and the Python backend.
• Extensive Analysis: Integrates with WhiteboxTools for over 500+ advanced geospatial analysis tools (e.g., hydrological, geomorphometric, and LiDAR analysis).

To install the latest development version directly from the GitHub repository, use the following command:

pip install git+https://github.com/opengeos/leafmap

To contribute to leafmap, follow these steps to set up a local development environment using conda and pip:

1. Fork the repository on GitHub.
2. Clone your fork locally.
3. Create and activate a new conda environment.
4. Install the package in editable mode (-e) so changes are reflected immediately.
5. Create a new branch for your work.

Ensure you have flake8 and tox installed in your environment to run linting and tests.

# 1. Clone your fork
git clone git@github.com:your_name_here/leafmap.git

# 2. Create and activate a conda environment
conda create -n leafmap-test python
conda activate leafmap-test

# 3. Install in editable mode
cd leafmap/
pip install -e .

# 4. Create a development branch
git checkout -b name-of-your-bugfix-or-feature

The heremap backend provides 3D mapping functionality but requires a HERE developer account and an API key.

Prerequisites:

1. Obtain an API key from the HERE Developer Portal.
2. Set the HEREMAPS_API_KEY environment variable or pass it directly to the Map constructor.

import os
import leafmap.heremap as leafmap

# Option 1: Set via environment variable
os.environ["HEREMAPS_API_KEY"] = "YOUR_HEREMAPS_API_KEY"
api_key = os.environ.get("HEREMAPS_API_KEY")

# Option 2: Pass directly to Map
m = leafmap.Map(api_key=api_key, center=(40, -100), zoom=4)
m

If you use Anaconda or Miniconda, you can install leafmap from the conda-forge channel.

Recommended Setup for Windows Users: Because some optional dependencies (like geopandas and localtileserver) can be difficult to install on Windows, it is highly recommended to create a fresh conda environment using mamba to ensure all dependencies are resolved correctly.