Install
-------
Install via `pip` with::
$ pip install cdsapi
Configure
---------
Get your user ID (UID) and API key from the CDS portal at the address https://cds.climate.copernicus.eu/user
and write it into the configuration file, so it looks like::
$ cat ~/.cdsapirc
url: https://cds.climate.copernicus.eu/api/v2
key: <UID>:<API key>
Remember to agree to the Terms and Conditions of every dataset that you intend to download.
Test
----
Perform a small test retrieve of ERA5 data::
$ python
>>> import cdsapi
>>> cds = cdsapi.Client()
>>> cds.retrieve('reanalysis-era5-pressure-levels', {
"variable": "temperature",
"pressure_level": "1000",
"product_type": "reanalysis",
"date": "2017-12-01/2017-12-31",
"time": "12:00",
"format": "grib"
}, 'download.grib')
>>>
License
-------
Copyright 2018 - 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/cdsapi",
"name": "cdsapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "ECMWF",
"author_email": "software.support@ecmwf.int",
"download_url": "https://files.pythonhosted.org/packages/1b/17/1b6db64a83ca105fa9338f48b759507718615b64b8a787727d72efc0b4fc/cdsapi-0.7.4.tar.gz",
"platform": null,
"description": "\nInstall\n-------\n\nInstall via `pip` with::\n\n $ pip install cdsapi\n\n\nConfigure\n---------\n\nGet your user ID (UID) and API key from the CDS portal at the address https://cds.climate.copernicus.eu/user\nand write it into the configuration file, so it looks like::\n\n $ cat ~/.cdsapirc\n url: https://cds.climate.copernicus.eu/api/v2\n key: <UID>:<API key>\n\nRemember to agree to the Terms and Conditions of every dataset that you intend to download.\n\n\nTest\n----\n\nPerform a small test retrieve of ERA5 data::\n\n $ python\n >>> import cdsapi\n >>> cds = cdsapi.Client()\n >>> cds.retrieve('reanalysis-era5-pressure-levels', {\n \"variable\": \"temperature\",\n \"pressure_level\": \"1000\",\n \"product_type\": \"reanalysis\",\n \"date\": \"2017-12-01/2017-12-31\",\n \"time\": \"12:00\",\n \"format\": \"grib\"\n }, 'download.grib')\n >>>\n\n\nLicense\n-------\n\nCopyright 2018 - 2019 European Centre for Medium-Range Weather Forecasts (ECMWF)\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou 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\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\nIn applying this licence, ECMWF does not waive the privileges and immunities\ngranted to it by virtue of its status as an intergovernmental organisation nor\ndoes it submit to any jurisdiction.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Climate Data Store API",
"version": "0.7.4",
"project_urls": {
"Homepage": "https://github.com/ecmwf/cdsapi"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82e5e342d83c7cb3768c4563b02c3af157cf628e8a632fb9ae9605b145feb0ba",
"md5": "79a791afc299423b5d88b608d79dd5aa",
"sha256": "5f70b40e8e777ae956deb6a13d1a3c8d8f099bada91919228adb27c34464144a"
},
"downloads": -1,
"filename": "cdsapi-0.7.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "79a791afc299423b5d88b608d79dd5aa",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 12143,
"upload_time": "2024-10-24T13:41:53",
"upload_time_iso_8601": "2024-10-24T13:41:53.248523Z",
"url": "https://files.pythonhosted.org/packages/82/e5/e342d83c7cb3768c4563b02c3af157cf628e8a632fb9ae9605b145feb0ba/cdsapi-0.7.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1b171b6db64a83ca105fa9338f48b759507718615b64b8a787727d72efc0b4fc",
"md5": "4f20866bbff9ddb15ea4c638cd9f5330",
"sha256": "a32fedb6cf6c5683e488652fadbf5b956561f573e98d0ec474e2d8381fe24a34"
},
"downloads": -1,
"filename": "cdsapi-0.7.4.tar.gz",
"has_sig": false,
"md5_digest": "4f20866bbff9ddb15ea4c638cd9f5330",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13148,
"upload_time": "2024-10-24T13:41:54",
"upload_time_iso_8601": "2024-10-24T13:41:54.523280Z",
"url": "https://files.pythonhosted.org/packages/1b/17/1b6db64a83ca105fa9338f48b759507718615b64b8a787727d72efc0b4fc/cdsapi-0.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-24 13:41:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ecmwf",
"github_project": "cdsapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "cdsapi"
}
JSON
