# CDSupdate
CDSupdate is a Python package that automates the process of retrieving, processing, and managing climate data from the Climate
Data Store (CDS) API. The tool generates daily climate data summaries, performs calculations to create custom variables such as
relative humidity and heat index which serve as risk assessments, and organizes the data into a user-friendly format.
## Installation
CDSupdate requires the following packages:
- `numpy`
- `pandas`
- `xarray`
- `netCDF4`
- `cftime`
- `cdsapi`
- `windows-curses` (only for Microsoft Windows users)
From pip:
~~~shell
pip3 install CDSupdate
~~~
Or from source:
~~~shell
git clone https://github.com/yrobink/CDSupdate.git
cd CDSupdaye
pip3 install .
~~~
This adds the `CDSupdate` package in your python installation, and the command
`cdsupdate`.
## How to use ?
Start by read the documentation with:
~~~shell
cdsupdate --help
~~~
As example, to download the daily mean temperature over the North Atlantic
(80W-50E,5N,72N) between 2019-11-09 and 2022-01-17 in the directory `odir`, just run:
~~~shell
cdsupdate --log info test.log --period 2019-11-09/2022-01-17 --cvar tas --area NorthAtlantic --odir odir
~~~
## How to cite it ?
You can use this [DOI:10.5281/zenodo.7991331](https://doi.org/10.5281/zenodo.7991331)
## License
Copyright(c) 2022 / 2024 Yoann Robin, Andreia Hisi
This file is part of CDSupdate.
CDSupdate is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
CDSupdate is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with CDSupdate. If not, see <https://www.gnu.org/licenses/>.
Raw data
{
"_id": null,
"home_page": "https://github.com/yrobink/CDSupdate",
"name": "CDSupdate",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Climate Data Store, Auto update",
"author": "Yoann Robin, Andreia Hisi",
"author_email": "yoann.robin.k@gmail.com, andreia.hisi@lsce.ipsl.fr",
"download_url": "https://files.pythonhosted.org/packages/fc/45/41d3de9b1266e6bc3fda5b098c9ceaf9ed7f95b940ba17d7a0f040b3dcfc/cdsupdate-2.0.0.tar.gz",
"platform": "linux",
"description": "# CDSupdate\n\nCDSupdate is a Python package that automates the process of retrieving, processing, and managing climate data from the Climate\nData Store (CDS) API. The tool generates daily climate data summaries, performs calculations to create custom variables such as\nrelative humidity and heat index which serve as risk assessments, and organizes the data into a user-friendly format. \n\n\n## Installation\n\nCDSupdate requires the following packages:\n\n- `numpy`\n- `pandas`\n- `xarray`\n- `netCDF4`\n- `cftime`\n- `cdsapi` \n- `windows-curses` (only for Microsoft Windows users)\n\nFrom pip:\n\n~~~shell\npip3 install CDSupdate\n~~~\n\nOr from source:\n\n~~~shell\ngit clone https://github.com/yrobink/CDSupdate.git\ncd CDSupdaye\npip3 install .\n~~~\n\nThis adds the `CDSupdate` package in your python installation, and the command\n`cdsupdate`.\n\n## How to use ?\n\nStart by read the documentation with:\n\n~~~shell\ncdsupdate --help\n~~~\n\nAs example, to download the daily mean temperature over the North Atlantic\n(80W-50E,5N,72N) between 2019-11-09 and 2022-01-17 in the directory `odir`, just run:\n\n~~~shell\ncdsupdate --log info test.log --period 2019-11-09/2022-01-17 --cvar tas --area NorthAtlantic --odir odir\n~~~\n\n## How to cite it ?\n\nYou can use this [DOI:10.5281/zenodo.7991331](https://doi.org/10.5281/zenodo.7991331)\n\n## License\n\nCopyright(c) 2022 / 2024 Yoann Robin, Andreia Hisi\n\nThis file is part of CDSupdate.\n\nCDSupdate is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nCDSupdate is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with CDSupdate. If not, see <https://www.gnu.org/licenses/>.\n\n",
"bugtrack_url": null,
"license": "GNU-GPL3",
"summary": "Auto-updater of data from the Climate Data Store",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/yrobink/CDSupdate"
},
"split_keywords": [
"climate data store",
" auto update"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b3e7016b71ce7d33177a67d6d1b01db3e142f1511e7efc3f6bee345aedaf8976",
"md5": "affff433a177ecbc6860332d61d0f6c1",
"sha256": "f126b6a35815ebeccc014a6e350cb585416828a3f95b0be619a3dc258be5c199"
},
"downloads": -1,
"filename": "CDSupdate-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "affff433a177ecbc6860332d61d0f6c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 43678,
"upload_time": "2024-09-13T13:25:38",
"upload_time_iso_8601": "2024-09-13T13:25:38.769623Z",
"url": "https://files.pythonhosted.org/packages/b3/e7/016b71ce7d33177a67d6d1b01db3e142f1511e7efc3f6bee345aedaf8976/CDSupdate-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc4541d3de9b1266e6bc3fda5b098c9ceaf9ed7f95b940ba17d7a0f040b3dcfc",
"md5": "1373c165eada04b88be48db1affbf895",
"sha256": "d87aede430f9cdc5495b8ec8cc57d88d73a536be1ae943b4e05805d6ca214692"
},
"downloads": -1,
"filename": "cdsupdate-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1373c165eada04b88be48db1affbf895",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34220,
"upload_time": "2024-09-13T13:25:40",
"upload_time_iso_8601": "2024-09-13T13:25:40.437039Z",
"url": "https://files.pythonhosted.org/packages/fc/45/41d3de9b1266e6bc3fda5b098c9ceaf9ed7f95b940ba17d7a0f040b3dcfc/cdsupdate-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-13 13:25:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yrobink",
"github_project": "CDSupdate",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cdsupdate"
}
JSON
