Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: changed install key instructions


Note
This method is only supported to on UNIX/Linux and Windows platforms with Python. No assumption should be made regarding service availability and individual user support.


Panel
titleColorwhite
titleBGColor#000000
titleStep-by-step guide

This method allows users to download ECMWF public datasets in a programmatic way.

  1. Install ECMWF key
  2. Install client librariesPython
  3. Client libraries
  4. Check data availability
  5. Choose dataset
  6. Script examples
  7. Request syntax

    More clients

Anchor
key
key

Panel
titleColorwhite
titleBGColor#2B619E
titleInstall ECMWF KEY
  1. If you don't have an account, please self register at https://apps.ecmwf.int/registration/ and then go to the steps below.
  2. login https://apps.ecmwf.int/auth/login/

  3. retrieve you key at https://api.ecmwf.int/v1/key/

  4. Copy the information in this page and paste it in the file $HOME/.ecmwfapirc

Code Block
languagebash
title$HOME/.ecmwfapirc
{
    "url"   : "https://api.ecmwf.int/v1",
    "key"   : "XXXXXXXXXXXXXXXXXXXXXX",
    "email" : "john.smith@example.com"
}

Include Page
Install ECMWF API Key
Install ECMWF API Key

Anchor
clientlibraries
clientlibraries

Be aware that at the moment the ecmwfapi python library  requires Python 2.7.x. Support for Python 3 may come in the future.

Panel
titleColorwhite
titleBGColor#2B619E
titleInstall client libraries

Anchor
python
python

Include Page

Python

You can install the ecmwfapi python library by running:

Code Block
languagebash
sudo pip install https://software.ecmwf.int/wiki/download/attachments/47287906/ecmwf-api-client-python.tgz

If you cannot run the sudo or pip commands, just download the ecmwf-api-client-python.tgz. Extract its content and copy the module ecmwfapi to a directory pointed by the environment variable PYTHONPATH.

Warning
Install ECMWF Web API Python client library
Install ECMWF Web API Python client library
 

Anchor
availability
availability

...

Panel
titleColorwhite
titleBGColor#2B619E
titleRequest syntax

See Brief request syntax 

...

Client Libraries
Panel
titleColorwhite
titleBGColor#2B619E
title

We also have some API for several client languages. Note that PYTHON is the most tested and supported.

Attachments
previewfalse
uploadfalse
oldfalse
patterns*.tgz
sortByname
pageWhat is ECMWF WebAPI

Perl

You need to download the clien, extract its content and to a directory pointed by the environment variable  PERL5LIB . This code relies on the JSON perl module, as well as libwww-perl and Crypt::SSLeay.

Java

You need to download the client and you will also need the Java JSON package.

 

Content by Label
showLabelsfalse
max5
spaces~uscs
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel in ("perl","mars","web","script","python","api","batch","java") and type = "page" and space = "~uscs"
labelsmars web api python perl java script batch

Page properties
hiddentrue


Related issues
 

 

 

 

 

 

 

 

 

 

...