diff --git a/README.md b/README.md index 75a8852..626f4a4 100755 --- a/README.md +++ b/README.md @@ -9,7 +9,8 @@ bmi_era5 package is an implementation of the Basic Model Interface ([BMI](https: for the [ERA5](https://confluence.ecmwf.int/display/CKB/ERA5) dataset. This package uses the [CDS API](https://cds.climate.copernicus.eu/how-to-api) to download the ERA5 dataset and wraps the dataset with BMI for data control and query. -It currently supports 3-dimensional ERA5 datasets defined with dimensions as [valid_time, latitude, longitude]. +It currently supports 3-dimensional ERA5 +datasets defined with dimensions such as valid_time (or date), latitude, and longitude. This package is not implemented for people to use but is the key element to convert the ERA5 dataset into a data component ([pymt_era5](https://pymt-era5.readthedocs.io/)) for diff --git a/docs/source/index.md b/docs/source/index.md index 8af6ef1..9c7a64b 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -9,7 +9,7 @@ the [Basic Model Interface (BMI)][bmi-docs] for the [ERA5][ERA5] dataset. This package uses the [CDS API][cds-api] to download the ERA5 dataset and wraps the dataset with BMI for data control and query. It currently supports 3-dimensional ERA5 -datasets defined with dimensions as [valid_time, latitude, longitude]. +datasets defined with dimensions such as valid_time (or date), latitude, and longitude. This package is not implemented for people to use but is the key element to convert the ERA5 dataset into a data component ([pymt_era5][pymt_era5]) for the [PyMT][pymt-docs] diff --git a/notebooks/bmi_era5.ipynb b/notebooks/bmi_era5.ipynb index 6612e9b..64f48c9 100755 --- a/notebooks/bmi_era5.ipynb +++ b/notebooks/bmi_era5.ipynb @@ -49,7 +49,7 @@ "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](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)).\n", + "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/how-to-api) 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)).\n", "\n", " \n", "To install bmi_era5 package, please follow the instructions [here](https://github.com/gantian127/bmi_era5/#install-package)." @@ -59,7 +59,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "You can uncomment the code below to use install_cds( ) to install the CDS API Key file. This file is required for data download. 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)." + "You can uncomment the code below to use install_cds( ) to install the CDS API Key file. This file is required for data download. 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/how-to-api)." ] }, {