Lab-0028: Difference between revisions
No edit summary |
No edit summary |
||
(3 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
|Labtitle=Topography Data Component | |Labtitle=Topography Data Component | ||
|LabCOModule=1 of 1 | |LabCOModule=1 of 1 | ||
|LabDateContributedOrUpdated= | |LabDateContributedOrUpdated=2022-04-19 | ||
|LabDescriptionShort=Learn how to download and access | |LabDescriptionShort=Learn how to download and access land elevation data from OpenTopography with the CSDMS Topography data component. | ||
|LabCODuration=1.0 hrs | |LabCODuration=1.0 hrs | ||
|LabModelDocumentation=Topography Data Component | |LabModelDocumentation=Topography Data Component | ||
|LabAssociatedLesson=Jupyter Notebook | |LabAssociatedLesson=Jupyter Notebook | ||
|LabURLDownloadNotebook=https://github.com/csdms/bmi-topography/tree/main/examples | |LabURLDownloadNotebook=https://github.com/csdms/bmi-topography/tree/main/examples | ||
|LabURLStartNotebook=https:// | |LabURLStartNotebook=https://jupyter.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fcsdms%2Fbmi-topography&urlpath=tree%2Fbmi-topography%2Fexamples&branch=main | ||
|LabURL2StartNotebook=https://lab.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fcsdms%2Fbmi-topography&urlpath=tree%2Fbmi-topography%2Fexamples&branch=main | |||
}} | }} | ||
{{LabContributorData | {{LabContributorData | ||
Line 16: | Line 17: | ||
}} | }} | ||
{{LabIntro | {{LabIntro | ||
|LabDescription=Topography is a Python library for fetching and caching | |LabDescription=Topography is a Python library for fetching and caching land elevation data using the OpenTopography REST API. Topography provides access to the following global raster datasets: | ||
* SRTM GL3 | * SRTMGL3 (SRTM GL3 90m) | ||
* SRTM GL1 | * SRTMGL1 (SRTM GL1 30m) | ||
* SRTM GL1 | * SRTMGL1_E (SRTM GL1 Ellipsoidal 30m) | ||
* ALOS World 3D | * AW3D30 (ALOS World 3D 30m) | ||
* ALOS World 3D (30m | * AW3D30_E (ALOS World 3D Ellipsoidal, 30m) | ||
* SRTM15Plus (Global Bathymetry SRTM15+ V2.1) | |||
* NASADEM (NASADEM Global DEM) | |||
* COP30 (Copernicus Global DSM 30m) | |||
* COP90 (Copernicus Global DSM 90m) | |||
The library includes an API, CLI, and BMI that accept the dataset type, a latitude-longitude bounding box, and the output file format. Data are downloaded from OpenTopography and cached locally. The cache is checked before downloading new data. Data from a cached file can optionally be loaded into an xarray DataArray using the experimental open_rasterio method. | The library includes an API, CLI, and BMI that accept the dataset type, a latitude-longitude bounding box, and the output file format. Data are downloaded from OpenTopography and cached locally. The cache is checked before downloading new data. Data from a cached file can optionally be loaded into an xarray DataArray using the experimental open_rasterio method. | ||
Line 49: | Line 54: | ||
}} | }} | ||
{{LabNotes | {{LabNotes | ||
|LabNotesInstructions=This lab can be run on the CSDMS | |LabNotesInstructions=<p>This lab can be run on the <em>lab</em> (for educators) and <em>jupyter</em> (for general use) instances of the OpenEarthscape JupyterHub: just click one of the links under the <strong>Run online using</strong> heading at the top of this page, then run the notebook in the "CSDMS" kernel.</p> | ||
<p>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.</p> | |||
|LabNotesRequirements=If run locally, see installation instructions in the bmi-topography repository: https://github.com/csdms/bmi-topography. | |LabNotesRequirements=If run locally, see installation instructions in the bmi-topography repository: https://github.com/csdms/bmi-topography. | ||
|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. | |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. | ||
Line 55: | Line 62: | ||
{{LabReferences | {{LabReferences | ||
|LabReferences=Piper, M. (2021). CSDMS Topography data component (Version 0.3.1) (Computer software). https://doi.org/10.5281/zenodo.4608653. | |LabReferences=Piper, M. (2021). CSDMS Topography data component (Version 0.3.1) (Computer software). https://doi.org/10.5281/zenodo.4608653. | ||
}} | |||
{{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. | |||
}} | }} |
Latest revision as of 14:56, 31 May 2022
Topography Data Component
Contributor(s)
- SRTMGL3 (SRTM GL3 90m)
- SRTMGL1 (SRTM GL1 30m)
- SRTMGL1_E (SRTM GL1 Ellipsoidal 30m)
- AW3D30 (ALOS World 3D 30m)
- AW3D30_E (ALOS World 3D Ellipsoidal, 30m)
- SRTM15Plus (Global Bathymetry SRTM15+ V2.1)
- NASADEM (NASADEM Global DEM)
- COP30 (Copernicus Global DSM 30m)
- COP90 (Copernicus Global DSM 90m)
The library includes an API, CLI, and BMI that accept the dataset type, a latitude-longitude bounding box, and the output file format. Data are downloaded from OpenTopography and cached locally. The cache is checked before downloading new data. Data from a cached file can optionally be loaded into an xarray DataArray using the experimental open_rasterio method.
More information on Topography can found in its documentation: https://bmi-topography.readthedocs.io.Classroom organization
This lab includes examples of using the Topography data component in a Jupyter Notebook, in a shell script, and in a Python program. Try editing these examples to get data from different locations around the globe.
Skills
- Use a command-line interface (CLI) for a Python library
- Use an application programming interface (API) for a Python library
- Use a Basic Model Interface (BMI)
- Access data through a data component
- Understand the difference between an API and a BMI, as well as their relative strengths
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 installation instructions in the bmi-topography repository: https://github.com/csdms/bmi-topography.
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
- Piper, M. (2021). CSDMS Topography data component (Version 0.3.1) (Computer software). https://doi.org/10.5281/zenodo.4608653.
- 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.