SoilGrids Data Component

1.0 hrs
Run online using:
  1. Jupyter
  2. Lab
     Jupyter logo.png

    Tian Gan at INSTAAR - University of Colorado Boulder.

Soilgrids logo.png
soilgrids package ( provides a set of functions that allow downloading of the global gridded soil information from SoilGrids, a system for global digital soil mapping to map the spatial distribution of soil properties across the globe. soilgrids package includes a Basic Model Interface (BMI), which converts the SoilGrids dataset into a reusable, plug-and-play data component for Community Surface Dynamics Modeling System (CSDMS) modeling framework.

Classroom organization
In this lab, you will learn how to use the soilgrids package to download the soil property datasets for data visualization. You will explore the SoilGrids map services and write your own code to download multiple soil datasets.

Learning objectives
  • Learn to use an application programming interface (API) to access SoilGrids data.
  • Learn to get the SoilGrids map service information.
  • Learn to use Basic Model Interface to access SoilGrids data and metadata.
Key concepts
  • CSDMS data component

Lab notes
This lab can be run on the lab (for educators) and jupyter (for general use) instances of the OpenEarthscape JupyterHub: just click one of the links under the Run online using heading at the top of this page, then run the notebook in the "CSDMS" kernel.

If you don't already have a JupyterHub account, follow the instructions to sign up at If you're an educator, you can get JupyterHub accounts for students--please contact us through the CSDMS Help Desk:

If run locally, see instructions at

This work is supported by the National Science Foundation under Award No. 2026951, EarthCube Capabilities: Cloud-Based Accessible and Reproducible Modeling for Water and Sediment Research.

  • Tucker, G. E., Hutton, E. W. H., Piper, M. D., Campforts, B., Gan, T., Barnhart, K. R., Kettner, A. J., Overeem, I., Peckham, S. D., McCready, L., and Syvitski, J., 2022: CSDMS: a community platform for numerical modeling of Earth surface processes, Geosci. Model Dev., 15, 1413–1439,