Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

We strongly suggest to construct CDS API requests by using the CDS web interface of the relevant dataset and using the 'Show API request' button to get the code.

Note

For the most common CDS API issues, please see Common Error Messages for CDS Requests.

Users can also set the PROXY within the CDS API script:

...

After sending a request, the user can track its state on the 'Your Requests' page of the CDS web interface. Users can also check the status of the CDS system at the live page. There are five different states of a request:

  1. Accepted: for requests that have been accepted and queued for execution
  2. Running: for requests that are being executed
  3. Successful: for requests that have been successfully executed and are ready to download
  4. Failed: for requests that have been executed but failed to produce an output (check error and show error details)

User can check the live status of the CDS system here https://cds.climate.copernicus.eu/live

...

  1. Where the data are actually  stored can make a significant difference in performance. CDS data hosted in 'MARS internal' is stored on CDS disks, and so is faster to retrieve. The  'MARS external' datasets are stored in the ECMWF MARS (tape) archive, and in this case it is important to request as much data as possible from the same tape file in your CDS request.
  2. Submit small requests over very large and heavy requests. This will ensure your requests are not penalised in the CDS request queue. In particular:
    1. For ERA5 data requests, please see: How to download ERA5 from the Climate Data Store (CDS). The first example in CDS API examples section below shows how to efficiently download a whole year of hourly data for 2m temperature (grib format, for an area subset) from the CDS, by asking for one month of data per request.

    2. For C3S seasonal forecast data requests, please see: Recommendations and efficiency tips for C3S seasonal forecast datasets.
    3. For UERRA data requests, please see: UERRA retrieval efficiency.
  3. When using the CDS API, it is advised that users take as an example the API request request script shown at the bottom of the CDS web  'Download data' page for the dataset of interest, and use this as the basis for your request.
  4. Some ERA5 datasets, such as reanalysis-era5-complete, do not appear in the CDS catalogue on the web interface, but users can still retrieve the data through the CDS API. In these cases, users can make use of a subset of  the  ECMWF MARS keywords in their CDS API request, and should also follow the MARS efficiency rule of thumb (the idea is to request as much data as possible from the same tape file or to reduce the number of tapes involved.).
  5. Users are strongly advised to check the allowed and not allowed keywords from the relevant dataset webform.

...