Lab-0018: Difference between revisions

From CSDMS
No edit summary
No edit summary
 
Line 2: Line 2:
|Labtitle=ERA5 Data Component
|Labtitle=ERA5 Data Component
|LabCOModule=1 of 1
|LabCOModule=1 of 1
|LabDateContributedOrUpdated=2023-06-12
|LabDateContributedOrUpdated=2025-07-10
|LabDescriptionShort=A CSDMS Data Component used to access the ECMWF Reanalysis v5 (ERA5) climate datasets.
|LabDescriptionShort=A CSDMS Data Component used to access the ECMWF Reanalysis v5 (ERA5) climate datasets.
|LabCODuration=1.0 hrs
|LabCODuration=1.0 hrs
Line 8: Line 8:
|LabAssociatedLesson=Jupyter Notebook
|LabAssociatedLesson=Jupyter Notebook
|LabURLDownloadNotebook=https://github.com/gantian127/bmi_era5/blob/master/notebooks/bmi_era5.ipynb
|LabURLDownloadNotebook=https://github.com/gantian127/bmi_era5/blob/master/notebooks/bmi_era5.ipynb
|LabURLStartNotebook=https://jupyter.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fgantian127%2Fbmi_era5&urlpath=lab%2Ftree%2Fbmi_era5%2Fnotebooks%2Fbmi_era5.ipynb%3Fautodecode&branch=master
|LabURL2StartNotebook=https://explore.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fgantian127%2Fbmi_era5&urlpath=lab%2Ftree%2Fbmi_era5%2Fnotebooks%2Fbmi_era5.ipynb%3Fautodecode&branch=master
}}
}}
{{LabContributorData
{{LabContributorData
Line 31: Line 33:
}}
}}
{{LabNotes
{{LabNotes
|LabNotesInstructions=This notebook is temporarily not functional on the OpenEarthscape JupyterHub due to a required package update. In the meantime, you can run it locally by accessing the notebook from Github: https://github.com/gantian127/bmi_era5.
|LabNotesInstructions=<p>This lab can be run on the <em>explore</em> (for educators) and <em>jupyter</em> (for general use) instances of EarthscapeHub: 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 an EarthscapeHub account, follow the instructions to sign up at https://csdms.colorado.edu/wiki/JupyterHub. If you're an educator, you can get EarthscapeHub accounts for you and your students--please contact us through the CSDMS Help Desk: https://csdms.github.io/help-desk.</p>
|LabNotesRequirements=If run locally, see instructions at https://github.com/gantian127/bmi_era5
|LabNotesRequirements=If run locally, see instructions at https://github.com/gantian127/bmi_era5
|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.

Latest revision as of 15:14, 10 July 2025

ERA5 Data Component

Duration
1.0 hrs
Updated
2025-07-10
Download
download
Run online using:
  1. Jupyter
  2. Lab
     

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

Introduction
bmi_era5 package (https://github.com/gantian127/bmi_era5) is an implementation of the Basic Model Interface (BMI) for the ERA5 dataset (https://confluence.ecmwf.int/display/CKB/ERA5). This package uses the CDS API (https://cds.climate.copernicus.eu/how-to-api) to download the ERA5 dataset and wraps the dataset with Basic Model Interface (BMI) for data control and query.

Classroom organization
In this lab, you will learn how to use the bmi_era5 package to download the ERA5 hourly reanalysis data on single level for 2 meter temperature and total precipitation in Colorado.

Learning objectives
Skills
  • Learn to use CDS API to access ERA5 data
  • Learn to use Basic Model Interface to access ERA5 data and metadata
Key concepts
  • CSDMS Data Component

Lab notes

This lab can be run on the explore (for educators) and jupyter (for general use) instances of EarthscapeHub: 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 an EarthscapeHub account, follow the instructions to sign up at https://csdms.colorado.edu/wiki/JupyterHub. If you're an educator, you can get EarthscapeHub accounts for you and your 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/bmi_era5

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