...
- You need to have a CDS or ADS account. If you don't have an account, please self register at the CDS registration page or the ADS registration, whichever is appropriate.
- You need a supported version of Python
use Python 3. You are recommended to follow instructions here using Homebrew.xcode-select --install
Expand title Install Python3 through Homebrew Code Block xcode-select --install /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" brew install python3
- Optional: you are recommended to set up a virtual environment.
Python 3 comes up with this feature. For Python 2, you may want to use Virtualenv. This is out of the scope of this knowledge base article.
Step-by-step guide
- Login to CDS (or Login to ADS)
- Copy a 2 line code, which shows a url and your own uid: API key details as follows:
- For CDS users, Go to this page and copy the 2 line code displayed in the black box in the the "Install Setup the CDS API keypersonal access token" section.
- For ADS users, Go to this page and copy the 2 line code displayed in the black box in the the "Install Setup the CDS API keypersonal access token" section.
Create your key file in your home directory in your Terminal window as follows:
Code Block touch ~/.cdsapirc
- Edit your key file and paste the two lines you copied in Step 2 above to your .cdsapirc key file.
Install the CDS API client using pip, by running the following command in your Terminal window:
Code Block pip install cdsapi
- Once the CDS API client is installed, it can be used to request data from the datasets listed in the CDS and ADS catalogues. It is necessary to agree to the Terms of Use of every datasets that you intend to download on the relevant webform. Attached to each dataset download form, the 'Show API request' button displays the python code to be used.
...