# ecmwf-api-client
# Installation
Install via pip with:
> $ pip install ecmwf-api-client
# Configure
## Anonymous access (default, not recommended)
Anonymous access is the default type of access, with no configuration needed.
However, anonymous access is only available for a limited set of datasets, and comes with a much lower quality of service. For access to all the available datasets, and an improved quality of service, please use registered access (see below).
## Registered access (recommended)
* Register with ECMWF at https://apps.ecmwf.int/registration/.
* Login at https://apps.ecmwf.int/auth/login/.
* Retrieve you API access key at https://api.ecmwf.int/v1/key/.
Note that the API access key expires in 1 year. You will receive an email to the registered email address 1 month before the expiration date with the renewal instructions. To check the expiry date of your current key, log into www.ecmwf.int, and go to https://api.ecmwf.int/v1/key/.
* Copy and paste the API access key into the file $HOME/.ecmwfapirc (Unix/Linux) or %USERPROFILE%\\.ecmwfapirc (Windows: usually in C:\\Users\\\<USERNAME\>\\.ecmwfapirc).
Your $HOME/.ecmwfapirc (Unix/Linux) or %USERPROFILE%\\.ecmwfapirc (Windows) should look something like this:
```
{
"url" : "https://api.ecmwf.int/v1",
"key" : "XXXXXXXXXXXXXXXXXXXXXX",
"email" : "john.smith@example.com"
}
```
* Alternatively, one can use a file of their own liking, and point to it using environment variable `ECMWF_API_RC_FILE`. `ECMWF_API_RC_FILE` should be set to the full path of the given file. This method takes priority of the previous method of using a .ecmwfapirc file.
* As yet another option, one can set the API access key values directly in the environment using variables `ECMWF_API_KEY` (key), `ECMWF_API_URL` (url), `ECMWF_API_EMAIL` (email). This method takes priority over the previous method of using environment variable `ECMWF_API_RC_FILE`.
# Example
You can test this small python script to retrieve TIGGE (https://apps.ecmwf.int/datasets/data/tigge) data. Note that access to TIGGE data requires registered access, and is subject to accepting a licence at https://apps.ecmwf.int/datasets/data/tigge/licence/.
```
#!/usr/bin/env python
from ecmwfapi import ECMWFDataServer
# To run this example, you need an API key
# available from https://api.ecmwf.int/v1/key/
server = ECMWFDataServer()
server.retrieve({
'origin' : "ecmf",
'levtype' : "sfc",
'number' : "1",
'expver' : "prod",
'dataset' : "tigge",
'step' : "0/6/12/18",
'area' : "70/-130/30/-60",
'grid' : "2/2",
'param' : "167",
'time' : "00/12",
'date' : "2014-11-01",
'type' : "pf",
'class' : "ti",
'target' : "tigge_2014-11-01_0012.grib"
})
```
# Logging
Logging messages by default are emitted to `stdout` using Python's `print` statement.
To change that behaviour, one can define their own logging function and use it like so:
```
import logging
from ecmwfapi import ECMWFDataServer
logging.basicConfig(level=logging.INFO)
def my_logging_function(msg):
logging.info(msg)
server = ECMWFDataServer(log=my_logging_function)
```
# License
Copyright 2019 European Centre for Medium-Range Weather Forecasts (ECMWF)
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
> http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
In applying this licence, ECMWF does not waive the privileges and immunities granted to it by virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.
Raw data
{
"_id": null,
"home_page": "https://github.com/ecmwf/ecmwf-api-client",
"name": "ecmwf-api-client",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "European Centre for Medium-Range Weather Forecasts (ECMWF)",
"author_email": "software.support@ecmwf.int",
"download_url": "https://files.pythonhosted.org/packages/5b/44/ddeb18174b1cce4fe2c714c1968cd0e4272c6869c5073a3b270f071e5549/ecmwf-api-client-1.6.3.tar.gz",
"platform": "",
"description": "# ecmwf-api-client\n\n# Installation\n\nInstall via pip with:\n\n> $ pip install ecmwf-api-client\n\n# Configure\n\n## Anonymous access (default, not recommended)\n\nAnonymous access is the default type of access, with no configuration needed.\n\nHowever, anonymous access is only available for a limited set of datasets, and comes with a much lower quality of service. For access to all the available datasets, and an improved quality of service, please use registered access (see below).\n\n## Registered access (recommended)\n\n* Register with ECMWF at https://apps.ecmwf.int/registration/.\n* Login at https://apps.ecmwf.int/auth/login/.\n* Retrieve you API access key at https://api.ecmwf.int/v1/key/.\n\n Note that the API access key expires in 1 year. You will receive an email to the registered email address 1 month before the expiration date with the renewal instructions. To check the expiry date of your current key, log into www.ecmwf.int, and go to https://api.ecmwf.int/v1/key/.\n\n* Copy and paste the API access key into the file $HOME/.ecmwfapirc (Unix/Linux) or %USERPROFILE%\\\\.ecmwfapirc (Windows: usually in C:\\\\Users\\\\\\<USERNAME\\>\\\\.ecmwfapirc).\n\n Your $HOME/.ecmwfapirc (Unix/Linux) or %USERPROFILE%\\\\.ecmwfapirc (Windows) should look something like this:\n ```\n {\n \"url\" : \"https://api.ecmwf.int/v1\",\n \"key\" : \"XXXXXXXXXXXXXXXXXXXXXX\",\n \"email\" : \"john.smith@example.com\"\n }\n ```\n* Alternatively, one can use a file of their own liking, and point to it using environment variable `ECMWF_API_RC_FILE`. `ECMWF_API_RC_FILE` should be set to the full path of the given file. This method takes priority of the previous method of using a .ecmwfapirc file.\n* As yet another option, one can set the API access key values directly in the environment using variables `ECMWF_API_KEY` (key), `ECMWF_API_URL` (url), `ECMWF_API_EMAIL` (email). This method takes priority over the previous method of using environment variable `ECMWF_API_RC_FILE`.\n \n# Example\n\nYou can test this small python script to retrieve TIGGE (https://apps.ecmwf.int/datasets/data/tigge) data. Note that access to TIGGE data requires registered access, and is subject to accepting a licence at https://apps.ecmwf.int/datasets/data/tigge/licence/.\n```\n#!/usr/bin/env python\nfrom ecmwfapi import ECMWFDataServer\n\n# To run this example, you need an API key\n# available from https://api.ecmwf.int/v1/key/\n\nserver = ECMWFDataServer()\nserver.retrieve({\n 'origin' : \"ecmf\",\n 'levtype' : \"sfc\",\n 'number' : \"1\",\n 'expver' : \"prod\",\n 'dataset' : \"tigge\",\n 'step' : \"0/6/12/18\",\n 'area' : \"70/-130/30/-60\",\n 'grid' : \"2/2\",\n 'param' : \"167\",\n 'time' : \"00/12\",\n 'date' : \"2014-11-01\",\n 'type' : \"pf\",\n 'class' : \"ti\",\n 'target' : \"tigge_2014-11-01_0012.grib\"\n})\n```\n\n# Logging\n\nLogging messages by default are emitted to `stdout` using Python's `print` statement.\n\nTo change that behaviour, one can define their own logging function and use it like so:\n\n```\nimport logging\nfrom ecmwfapi import ECMWFDataServer\n\nlogging.basicConfig(level=logging.INFO)\n\ndef my_logging_function(msg):\n logging.info(msg)\n\nserver = ECMWFDataServer(log=my_logging_function)\n```\n\n# License\n\nCopyright 2019 European Centre for Medium-Range Weather Forecasts (ECMWF)\nLicensed under the Apache License, Version 2.0 (the \u201cLicense\u201d); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\n> http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \u201cAS IS\u201d BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\nIn applying this licence, ECMWF does not waive the privileges and immunities granted to it by virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.",
"bugtrack_url": null,
"license": "Apache License Version 2.0",
"summary": "Python client for ECMWF web services API.",
"version": "1.6.3",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5b44ddeb18174b1cce4fe2c714c1968cd0e4272c6869c5073a3b270f071e5549",
"md5": "42b7cbe28a334fa243eccc6ad39c8dbe",
"sha256": "3a00bda34a72e2d5198c97399a4750b42a6633efdb5e1b3a5fd2b2bbaa5db0d6"
},
"downloads": -1,
"filename": "ecmwf-api-client-1.6.3.tar.gz",
"has_sig": false,
"md5_digest": "42b7cbe28a334fa243eccc6ad39c8dbe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12782,
"upload_time": "2022-01-31T11:36:46",
"upload_time_iso_8601": "2022-01-31T11:36:46.476890Z",
"url": "https://files.pythonhosted.org/packages/5b/44/ddeb18174b1cce4fe2c714c1968cd0e4272c6869c5073a3b270f071e5549/ecmwf-api-client-1.6.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-01-31 11:36:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ecmwf",
"github_project": "ecmwf-api-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ecmwf-api-client"
}
JSON
