A Python package for interactive mapping using Google Earth Engine and ipyleaflet
Project description
A Python package for interactive mapping with Google Earth Engine, ipyleaflet, and ipywidgets.
GitHub repo: https://github.com/gee-community/geemap
Documentation: https://geemap.org
Conda-forge: https://anaconda.org/conda-forge/geemap
360+ GEE notebook examples: https://github.com/giswqs/earthengine-py-notebooks
GEE Tutorials on YouTube: https://youtube.com/@giswqs
Free software: MIT license
Acknowledgment: This material is based upon work partially supported by the National Aeronautics and Space Administration (NASA) under Grant No. 80NSSC22K1742 issued through the Open Source Tools, Frameworks, and Libraries 2020 Program.
Contents
Introduction
Geemap is a Python package for interactive mapping with Google Earth Engine (GEE), which is a cloud computing platform with a multi-petabyte catalog of satellite imagery and geospatial datasets. During the past few years, GEE has become very popular in the geospatial community and it has empowered numerous environmental applications at local, regional, and global scales. GEE provides both JavaScript and Python APIs for making computational requests to the Earth Engine servers. Compared with the comprehensive documentation and interactive IDE (i.e., GEE JavaScript Code Editor) of the GEE JavaScript API, the GEE Python API has relatively little documentation and limited functionality for visualizing results interactively. The geemap Python package was created to fill this gap. It is built upon ipyleaflet and ipywidgets, and enables users to analyze and visualize Earth Engine datasets interactively within a Jupyter-based environment.
Geemap is intended for students and researchers, who would like to utilize the Python ecosystem of diverse libraries and tools to explore Google Earth Engine. It is also designed for existing GEE users who would like to transition from the GEE JavaScript API to Python API. The automated JavaScript-to-Python conversion module of the geemap package can greatly reduce the time needed to convert existing GEE JavaScripts to Python scripts and Jupyter notebooks.
For video tutorials and notebook examples, please visit https://geemap.org/tutorials. For complete documentation on geemap modules and methods, please visit https://geemap.org/geemap.
If you find geemap useful in your research, please consider citing the following papers to support my work. Thank you for your support.
Wu, Q., (2020). geemap: A Python package for interactive mapping with Google Earth Engine. The Journal of Open Source Software, 5(51), 2305. https://doi.org/10.21105/joss.02305
Wu, Q., Lane, C. R., Li, X., Zhao, K., Zhou, Y., Clinton, N., DeVries, B., Golden, H. E., & Lang, M. W. (2019). Integrating LiDAR data and multi-temporal aerial imagery to map wetland inundation dynamics using Google Earth Engine. Remote Sensing of Environment, 228, 1-13. https://doi.org/10.1016/j.rse.2019.04.015 (pdf | source code)
Check out the geemap workshop I presented at the GeoPython Conference 2021. This workshop gives a comprehensive introduction to the key features of geemap.
Features
Below is a partial list of features available for the geemap package. Please check the examples page for notebook examples, GIF animations, and video tutorials.
Convert Earth Engine JavaScripts to Python scripts and Jupyter notebooks.
Display Earth Engine data layers for interactive mapping.
Support Earth Engine JavaScript API-styled functions in Python, such as Map.addLayer(), Map.setCenter(), Map.centerObject(), Map.setOptions().
Create split-panel maps with Earth Engine data.
Retrieve Earth Engine data interactively using the Inspector Tool.
Interactive plotting of Earth Engine data by simply clicking on the map.
Convert data format between GeoJSON and Earth Engine.
Use drawing tools to interact with Earth Engine data.
Use shapefiles with Earth Engine without having to upload data to one’s GEE account.
Export Earth Engine FeatureCollection to other formats (i.e., shp, csv, json, kml, kmz).
Export Earth Engine Image and ImageCollection as GeoTIFF.
Extract pixels from an Earth Engine Image into a 3D numpy array.
Calculate zonal statistics by group.
Add a customized legend for Earth Engine data.
Convert Earth Engine JavaScripts to Python code directly within Jupyter notebook.
Add animated text to GIF images generated from Earth Engine data.
Add colorbar and images to GIF animations generated from Earth Engine data.
Create Landsat timelapse animations with animated text using Earth Engine.
Search places and datasets from Earth Engine Data Catalog.
Use timeseries inspector to visualize landscape changes over time.
Export Earth Engine maps as HTML files and PNG images.
Search Earth Engine API documentation within Jupyter notebooks.
Import Earth Engine assets from personal account.
Publish interactive GEE maps directly within Jupyter notebook.
Add local raster datasets (e.g., GeoTIFF) to the map.
Perform image classification and accuracy assessment.
Extract pixel values interactively and export as shapefile and csv.
Installation
To use geemap, you must first sign up for a Google Earth Engine account.
Geemap is available on PyPI. To install geemap, run this command in your terminal:
pip install geemapGeemap is also available on conda-forge. If you have Anaconda or Miniconda installed on your computer, you can create a conda Python environment to install geemap:
conda create -n gee python=3.10
conda activate gee
conda install -n base mamba -c conda-forge
mamba install geemap -c conda-forgeIf you have installed geemap before and want to upgrade to the latest version, you can run the following command in your terminal:
pip install -U geemapIf you use conda, you can update geemap to the latest version by running the following command in your terminal:
conda update -c conda-forge geemapTo install the development version from GitHub using Git, run the following command in your terminal:
pip install git+https://github.com/gee-community/geemapTo install the development version from GitHub directly within Jupyter notebook without using Git, run the following code:
import geemap
geemap.update_package()Citations
To support my work, please consider citing the following articles:
Wu, Q., (2020). geemap: A Python package for interactive mapping with Google Earth Engine. The Journal of Open Source Software, 5(51), 2305. https://doi.org/10.21105/joss.02305
Wu, Q., Lane, C. R., Li, X., Zhao, K., Zhou, Y., Clinton, N., DeVries, B., Golden, H. E., & Lang, M. W. (2019). Integrating LiDAR data and multi-temporal aerial imagery to map wetland inundation dynamics using Google Earth Engine. Remote Sensing of Environment, 228, 1-13. https://doi.org/10.1016/j.rse.2019.04.015 (pdf | source code)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file geemap-0.24.3.tar.gz.
File metadata
- Download URL: geemap-0.24.3.tar.gz
- Upload date:
- Size: 2.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 533fed2afbd23e3b2a5c443655d1d5f9d0e2220e15e7ee3be2eeb7fcf792e122 |
|
| MD5 | dd1f9f771c1222d2dbd94f09573b5f90 |
|
| BLAKE2b-256 | 524446d15e8498cd823aa109802f936ef1a28c1669fd23bc4dcb2f95eb8a5faf |
File details
Details for the file geemap-0.24.3-py2.py3-none-any.whl.
File metadata
- Download URL: geemap-0.24.3-py2.py3-none-any.whl
- Upload date:
- Size: 2.2 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 52b4adef93a4ab15eeced1a7a51a3c0c2b7b3c6aedea60781d708ff0e0a8cd54 |
|
| MD5 | c3bb5417be3c0dd6b3ccdd2cd898f00c |
|
| BLAKE2b-256 | fe93b537667f0e3c1b0bc9c4d1d4ee010fb21cdc01c153997d7a22fab06a88a3 |
