Skip to content

Commit

Permalink
Merge pull request #2 from gantian127/release-v0.1.2
Browse files Browse the repository at this point in the history
Release v0.1.2
  • Loading branch information
gantian127 committed Sep 10, 2021
2 parents df1deba + a5e8961 commit fa63241
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions notebooks/bmi_era5.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,14 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"bmi_era5 package is an implementation of the Basic Model Interface ([BMI](https://bmi.readthedocs.io/en/latest/)) for the [ERA5](https://confluence.ecmwf.int/display/CKB/ERA5) dataset. This package uses the [CDS API](https://cds.climate.copernicus.eu/api-how-to) to download the ERA5 dataset and wraps the dataset with BMI for data control and query (currently support 3 dimensional ERA5 dataset). This package is not implemented for people to use but is the key element to convert the ERA5 dataset into a data component for the PyMT modeling framework."
"bmi_era5 package is an implementation of the Basic Model Interface ([BMI](https://bmi.readthedocs.io/en/latest/)) for the [ERA5](https://confluence.ecmwf.int/display/CKB/ERA5) dataset. This package uses the [CDS API](https://cds.climate.copernicus.eu/api-how-to) to download the ERA5 dataset and wraps the dataset with BMI for data control and query (currently support 3 dimensional ERA5 dataset). This package is not implemented for people to use but is the key element to convert the ERA5 dataset into a data component for the [PyMT](https://pymt.readthedocs.io/en/latest/?badge=latest) modeling framework developed by Community Surface Dynamics Modeling System ([CSDMS](https://csdms.colorado.edu/wiki/Main_Page))."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Let's first use a helper function to install the CDS API and create the CDS API Key file. The \"install_cds( )\" function will ask you to enter your CDS API. So please make sure you have already created an account at the [CDS registration page](https://cds.climate.copernicus.eu/#!/home) and obtained your CDS API Key. For more details please check [here](https://cds.climate.copernicus.eu/api-how-to)."
"Let's first use a helper function to install the CDS API and create the CDS API Key file. The install_cds( ) function will ask for your CDS API Key. So please make sure you have already created an account at the [CDS registration page](https://cds.climate.copernicus.eu/#!/home) and obtained your CDS API Key. For more details please check [here](https://cds.climate.copernicus.eu/api-how-to)."
]
},
{
Expand All @@ -81,7 +81,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"After you sucessfully run the helper function above, use the following command to install the bmi_era5 package. "
"After you successfully run the helper function above, use the following command to install the bmi_era5 package. "
]
},
{
Expand All @@ -107,7 +107,7 @@
"source": [
"The CDS API (Climate Data Store Application Program Interface) is a service providing Python based programmatic access to CDS data. ERA5 is one of the CDS data products that can be accessed using the CDS API. \n",
"\n",
"In bmi_era5 package, BmiEra5 class is designed to download the ERA5 dataset and wrap the dataset with BMI (currently support 3 dimensional ERA5 data). The following examples demonstrate how to download the same dataset using the CDS API and BmiEra5 for data visualization. "
"In bmi_era5 package, BmiEra5 class is designed to download the ERA5 dataset and wrap the dataset with BMI (currently support 3 dimensional ERA5 dataset). The following examples demonstrate how to download the same dataset using the CDS API and BmiEra5 for data visualization. "
]
},
{
Expand All @@ -121,7 +121,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Import cdsapi module and create an object from the \"Client\" class. Use the \"retrieve( )\" method to make a request for data download. You can check the details of the parameter settings for a request from the [CDS web interface](https://confluence.ecmwf.int/display/CKB/How+to+download+ERA5#HowtodownloadERA5-3-DownloadingonlineERA5familydatathroughtheCDSwebinterface). \n",
"Import cdsapi module and create an object from the \"Client\" class. Use the retrieve( ) method to make a request for data download. You can check the details of the parameter settings for a request from the [CDS web interface](https://confluence.ecmwf.int/display/CKB/How+to+download+ERA5#HowtodownloadERA5-3-DownloadingonlineERA5familydatathroughtheCDSwebinterface). \n",
"\n",
"In this example, it downloads the ERA5 hourly reanalysis data on single level for 2 metre temperature and total precipitation in Colorado on Jan 1st, 2021. The grid resolution is 0.25 degree. The dataset is saved in a netCDF file."
]
Expand Down Expand Up @@ -202,7 +202,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The soil dataset is loaded as a DataArray object (xarray). You can directly plot the data using its plot( ) method."
"The temperature dataset is loaded as a DataArray object (xarray). You can directly plot the data using its plot( ) method."
]
},
{
Expand Down Expand Up @@ -250,7 +250,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Import BmiEra5 class and instantiate it. A configuration file (yaml file) is required to provide the parameter settings for data download. An example configure_file.yaml file is provided in the same folder with this Jupyter Notebook file. "
"Import BmiEra5 class and instantiate it. A configuration file (yaml file) is required to provide the parameter settings for data download. An example config_file.yaml file is provided in the same folder with this Jupyter Notebook. "
]
},
{
Expand Down Expand Up @@ -283,7 +283,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"If you check the contents in the config_file.yaml, you will find out that the parameters are the same as the parameters specified in the retreive( ) method from the CDS API."
"If you check the contents in the config_file.yaml, you will find out that the parameters are the same as the parameters specified in the retrieve( ) method from the CDS API."
]
},
{
Expand Down Expand Up @@ -541,7 +541,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.5"
"version": "3.9.7"
}
},
"nbformat": 4,
Expand Down

0 comments on commit fa63241

Please sign in to comment.