CDS-beta migration guide

[yuankailiu]

The old instance of the CDS will be decommissioned on 26 September 2024 and will no longer be accessible from this date onwards. The new CDS-beta will become the official new CDS for ERA5 data distribution. We have updated PyAPS to adapt to this change in version 0.3.5. Here is how to migrate to this new version:

1. Update your pyaps3 to version 0.3.5

via conda

conda update pyaps3

or via mamba

mamba update pyaps3

or via pip

pip install pyaps3 --upgrade

2. Register a new CDS-beta account

The old CDS account won't work, so you need to register a new CDS-beta account and accept the Term of Use of ERA5 data if you haven't, check README.

3. Update your local account credential config file

1) the ~/.cdsapirc file [recommended]:

from (for the old CDS)

url: https://cds.climate.copernicus.eu/api/v2
key = UID:THIS-IS-YOUR-API-KEY

to (for the new CDS-beta)

url: https://cds-beta.climate.copernicus.eu/api
key = YOUR-CDSBeta-PERSONAL-ACCESS-TOKEN

2) or the model.cfg file:

from (for the old CDS)

[CDS]
key = UID:THIS-IS-YOUR-API-KEY

to (for the new CDS-beta)

[CDS]
key = YOUR-CDSBeta-PERSONAL-ACCESS-TOKEN

4. Test the new setup

cd ~/tools/
python $YOUR_PYAPS_HOME/tests/test_dload.py

The output should be like below:

------------------------------------------------
import pyaps3 from /home/ykliu/apps/mambaforge/envs/insar/lib/python3.12/site-packages/pyaps3/__init__.py
------------------------------------------------
test ERA5 data download
NOTE: Account setup is required on the Copernicus Climate Data Store (CDS).
      More detailed info can be found on: https://retostauffer.org/code/Download-ERA5/
      Add your account info to ~/.cdsapirc file.
INFO: You are using the latest ECMWF platform for downloading datasets:  https://cds-beta.climate.copernicus.eu/api
Downloading 1 of 2: /home/ykliu/apps/PyAPS/tests/data/ERA5/ERA5_N30_N40_E120_E140_20200601_14.grb
{'product_type': 'reanalysis', 'format': 'grib', 'variable': ['geopotential', 'temperature', 'specific_humidity'], 'pressure_level': ['1', '2', '3', '5', '7', '10', '20', '30', '50', '70', '100', '125', '150', '175', '200', '225', '250', '300', '350', '400', '450', '500', '550', '600', '650', '700', '750', '775', '800', '825', '850', '875', '900', '925', '950', '975', '1000'], 'year': '2020', 'month': '06', 'day': '01', 'time': '14:00', 'area': '40.00/120.00/30.00/140.00'}
2024-09-16 15:44:43,153 INFO Request ID is c4bdbde8-f73c-4dfa-b92a-58006ab76355
2024-09-16 15:44:43,333 INFO status has been updated to accepted
2024-09-16 15:44:45,026 INFO status has been updated to running
2024-09-16 15:44:47,459 INFO status has been updated to successful
Downloading 2 of 2: /home/ykliu/apps/PyAPS/tests/data/ERA5/ERA5_N30_N40_E120_E140_20200901_14.grb
{'product_type': 'reanalysis', 'format': 'grib', 'variable': ['geopotential', 'temperature', 'specific_humidity'], 'pressure_level': ['1', '2', '3', '5', '7', '10', '20', '30', '50', '70', '100', '125', '150', '175', '200', '225', '250', '300', '350', '400', '450', '500', '550', '600', '650', '700', '750', '775', '800', '825', '850', '875', '900', '925', '950', '975', '1000'], 'year': '2020', 'month': '09', 'day': '01', 'time': '14:00', 'area': '40.00/120.00/30.00/140.00'}
2024-09-16 15:44:51,651 INFO Request ID is e6348440-f2c1-4e5b-9781-dfdf3d477c85
2024-09-16 15:44:51,816 INFO status has been updated to accepted
2024-09-16 15:44:53,493 INFO status has been updated to successful
------------------------------------------------
Downloads OK
------------------------------------------------