You only need to go through this procedure once, before you can use the CDS API on Windows to programmatically download data from either the Climate Data Store (CDS) or the Atmosphere Data Store (ADS).
Prerequisites
- 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 to have Python (and pip) installed on your Windows environment.
Add the installation and Script folder path in PATH using set (temporary) or setx (permanent) in a Command Prompt window.
This is to make sure that your computer knows where to find the Python interpreter. To do this you will have to modify a setting called PATH, which is a list of directories where Windows will look for programs.
Further details and examples are available here.
You may choose also to set your environment variables into a batch file (e.g. set-env.bat which you will need to run from the Command Prompt.
If you have Anaconda installed you can install the CDS API by
/<install_path>/conda/anaconda2/bin/conda config --add channels conda-forge /<install_path>/conda/anaconda2/bin/conda install cdsapi
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 followed:
- Paste the 2 line code into a %USERPROFILE%\.cdsapirc file, where in your windows environment, %USERPROFILE% is usually located at C:\Users\Username folder). The CDS API expects to find the .cdsapirc file in your home directory.
For instructions on how to create a dot file on Windows, please see here or check the instructions provided by one of users on the User Forum.
Install the CDS API client by running the following command in a Command Prompt window:
pip3 install cdsapi # for Python 3
or try
pip3 install --user cdsapi # for Python 3
- 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. Attached to each dataset download form, the "Show API request" button displays the python code to be used.
If you are getting connection issues, we recommend that in the first instance you check your proxy settings with your local IT team.
For those using Ubuntu on Windows, installing pyopenssl might help.
pip3 install pyopenssl # for Python 3