Implement ERA5 data ingestion (#11)

* add download function for era5 * check existence and overwrite * make mypy happy and add variables list * era5 data ingestion * update convention path and update demo notebook * update zampy variable names * update demo notebook * add tests for new utils * add tests for era5 dataset * fix tests for loading .cdsapirc * check size before downloading * add progress bar and message for downloading * silent too many arguments * fix unittest on windows using mktemp from pytest * update convention and variable units * update tests with all variables * compare units with pint unit registry * add all variables to tests * fix typo in convention * combine tests for similar variables * make linter happy * Apply suggestions from code review Co-authored-by: Bart Schilperoort <[email protected]> * update variable names accordingly * convert precipitation with pint --------- Co-authored-by: Bart Schilperoort <[email protected]>
EcoExtreML · Jul 31, 2023 · d0fec00 · d0fec00
1 parent d673d17
commit d0fec00
Show file tree

Hide file tree

Showing 22 changed files with 1,944 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -24,4 +24,17 @@ Tool for downloading Land Surface Model input data
    - Load recipes using Pydantic ([for example](https://github.com/phenology/springtime/blob/main/src/springtime/datasets/daymet.py)).
  - Support both a CLI & Python API.
 
-Note: items in *italic* will not be worked on for now/low priority, but we want to allow space for these in the future.
+Note: items in *italic* will not be worked on for now/low priority, but we want to allow space for these in the future.
+
+## Instructions for CDS datasets (e.g. ERA5)
+To download the following datasets, users need access to CDS via cdsapi:
+
+- ERA5
+- ERA5 land
+- LAI
+
+First, you need to be a registered user on CDS via the [registration page](https://cds.climate.copernicus.eu/user/register?destination=%2F%23!%2Fhome).
+
+Before submitting any request with `zampy`, please configure your `.cdsapirc` file following the instructions on https://cds.climate.copernicus.eu/api-how-to.
+
+When downloading a dataset for the first time, it is **necessary to agree to the Terms of Use of every datasets that you intend to download**. This can only be done via the CDS website. When you try to download these datasets, you will be prompted to go to the terms of use and accept them.