Lab-0019: Difference between revisions

From CSDMS
No edit summary
No edit summary
 
(11 intermediate revisions by 2 users not shown)
Line 2: Line 2:
|Labtitle=SoilGrids Data Component
|Labtitle=SoilGrids Data Component
|LabCOModule=1 of 1
|LabCOModule=1 of 1
|LabDateContributedOrUpdated=2020-12-03
|LabDateContributedOrUpdated=2022-04-19
|LabDescriptionShort=A CSDMS data component used to download the soil property datasets from the SoilGrids system.
|LabDescriptionShort=A CSDMS data component used to download the soil property datasets from the SoilGrids system.
|LabCODuration=1.0 hrs
|LabCODuration=1.0 hrs
|LabModelDocumentation=None
|LabModelDocumentation=SoilGrids Data Component
|LabAssociatedLesson=Jupyter Notebook
|LabAssociatedLesson=Jupyter Notebook
|LabURLDownloadNotebook=https://github.com/gantian127/soilgrids/tree/master/notebooks
|LabURLDownloadNotebook=https://github.com/gantian127/soilgrids/tree/master/notebooks
|LabURLStartNotebook=https://mybinder.org/v2/gh/gantian127/soilgrids/master?filepath=notebooks%2Fsoilgrids.ipynb
|LabURLStartNotebook=https://jupyter.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fgantian127%2Fsoilgrids&urlpath=lab%2Ftree%2Fsoilgrids%2Fnotebooks%2Fsoilgrids.ipynb%3Fautodecode&branch=master
|LabURL2StartNotebook=https://lab.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fgantian127%2Fsoilgrids&urlpath=lab%2Ftree%2Fsoilgrids%2Fnotebooks%2Fsoilgrids.ipynb%3Fautodecode&branch=master
}}
}}
{{LabContributorData
{{LabContributorData
Line 15: Line 16:
}}
}}
{{LabIntro
{{LabIntro
|LabDescription=soilgrids package provides a set of functions that allow downloading of the global gridded soil information from SoilGrids https://www.isric.org/explore/soilgrids, a system for global digital soil mapping to map the spatial distribution of soil properties across the globe.
|LabDescription=soilgrids package (https://github.com/gantian127/soilgrids) provides a set of functions that allow downloading of the global gridded soil information from SoilGrids https://www.isric.org/explore/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.
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.
Line 25: Line 25:
}}
}}
{{LabLearningObjectivesSkills
{{LabLearningObjectivesSkills
|LabSkill=Learn to use two methods to download the soil property datasets with a given bounding box.
|LabSkill=Learn to use an application programming interface (API) to access SoilGrids data.
}}
}}
{{LabLearningObjectivesSkills
{{LabLearningObjectivesSkills
|LabSkill=Learn to get the SoilGrids map service detailed information.
|LabSkill=Learn to get the SoilGrids map service information.
}}
}}
{{LabLearningObjectivesSkills
{{LabLearningObjectivesSkills
|LabSkill=Learn to download soil datasets for variables such as silt content, clay content, sand content, etc.
|LabSkill=Learn to use Basic Model Interface to access SoilGrids data and metadata.
}}
}}
{{Headerplaceholder}}
{{Headerplaceholder}}
Line 38: Line 38:
}}
}}
{{LabNotes
{{LabNotes
|LabNotesInstructions=Instead of downloading the lab Notebook and running it locally, you can run it on Binder. To start the binder, click on "start" under the "Run online" item in the grey table at the top of this lab. It may take several minutes to launch the Binder.
|LabNotesInstructions=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.
|LabNotesRequirements=If run locally, this lab requires the installation of soilgrids package. Please see details at https://github.com/gantian127/soilgrids/
 
 
If you don't already have a JupyterHub account, follow the instructions to sign up at https://csdms.colorado.edu/wiki/JupyterHub. If you're an educator, you can get JupyterHub accounts for students--please contact us through the CSDMS Help Desk: https://csdms.github.io/help-desk.
|LabNotesRequirements=If run locally, see instructions at https://github.com/gantian127/soilgrids/
|LabAcknowledgements=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.
}}
{{LabReferences
|LabReferences=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, https://doi.org/10.5194/gmd-15-1413-2022.
}}
{{LabReferences
|LabReferences=Gan, T., Tucker, G.E., Hutton, E.W.H., Piper, M.D., Overeem, I., Kettner, A.J., Campforts, B., Moriarty, J.M., Undzis, B., Pierce, E., McCready, L., 2024: CSDMS Data Components: data–model integration tools for Earth surface processes modeling. Geosci. Model Dev., 17, 2165–2185. https://doi.org/10.5194/gmd-17-2165-2024
}}
}}

Latest revision as of 14:41, 16 April 2024

SoilGrids Data Component

Duration
1.0 hrs
Updated
2022-04-19
Download
download
Run online using:
  1. Jupyter
  2. Lab
     Jupyter logo.png

Contributor(s)
    Tian Gan at INSTAAR - University of Colorado Boulder.

Introduction
Soilgrids logo.png
soilgrids package (https://github.com/gantian127/soilgrids) provides a set of functions that allow downloading of the global gridded soil information from SoilGrids https://www.isric.org/explore/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
Skills
  • 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 https://csdms.colorado.edu/wiki/JupyterHub. If you're an educator, you can get JupyterHub accounts for students--please contact us through the CSDMS Help Desk: https://csdms.github.io/help-desk.

Requirements
If run locally, see instructions at https://github.com/gantian127/soilgrids/

Acknowledgements
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.

References
  • 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, https://doi.org/10.5194/gmd-15-1413-2022.
  • Gan, T., Tucker, G.E., Hutton, E.W.H., Piper, M.D., Overeem, I., Kettner, A.J., Campforts, B., Moriarty, J.M., Undzis, B., Pierce, E., McCready, L., 2024: CSDMS Data Components: data–model integration tools for Earth surface processes modeling. Geosci. Model Dev., 17, 2165–2185. https://doi.org/10.5194/gmd-17-2165-2024