============
ecmwf_models
============
.. image:: https://github.com/TUW-GEO/ecmwf_models/workflows/Automated%20Tests/badge.svg?branch=master
:target: https://github.com/TUW-GEO/ecmwf_models/actions
.. image:: https://coveralls.io/repos/github/TUW-GEO/ecmwf_models/badge.svg?branch=master
:target: https://coveralls.io/github/TUW-GEO/ecmwf_models?branch=master
.. image:: https://badge.fury.io/py/ecmwf-models.svg
:target: https://badge.fury.io/py/ecmwf-models
.. image:: https://readthedocs.org/projects/ecmwf-models/badge/?version=latest
:target: https://ecmwf-models.readthedocs.io/en/latest/
Readers and converters for data from the `ECMWF reanalysis models
<http://apps.ecmwf.int/datasets/>`_. Written in Python.
Works great in combination with `pytesmo <https://github.com/TUW-GEO/pytesmo>`_.
Citation
========
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.593533.svg
:target: https://doi.org/10.5281/zenodo.593533
If you use the software in a publication then please cite it using the Zenodo DOI.
Be aware that this badge links to the latest package version.
Please select your specific version at https://doi.org/10.5281/zenodo.593533 to get the DOI of that version.
You should normally always use the DOI for the specific version of your record in citations.
This is to ensure that other researchers can access the exact research artefact you used for reproducibility.
You can find additional information regarding DOI versioning at http://help.zenodo.org/#versioning
Installation
============
Install required C-libraries via conda. For installation we recommend
`Miniconda <http://conda.pydata.org/miniconda.html>`_. So please install it according
to the official installation instructions. As soon as you have the ``conda``
command in your shell you can continue:
.. code::
conda install -c conda-forge pandas pygrib netcdf4 pyresample xarray
The following command will download and install all the needed pip packages as well
as the ecmwf-model package itself.
.. code::
pip install ecmwf_models
To create a full development environment with conda, the `yml` files inside
the folder `environment/` in this repository can be used. Both environements
should work. The file `latest` should install the newest version of most
dependencies. The file `pinned` is a fallback option and should always work.
.. code::
git clone --recursive git@github.com:TUW-GEO/ecmwf_models.git ecmwf_models
cd ecmwf_models
conda env create -f environment/latest.yml
source activate ecmwf_models
python setup.py develop
pytest
Supported Products
==================
At the moment this package supports
- **ERA Interim** (deprecated)
- **ERA5**
- **ERA5-Land**
reanalysis data in **grib** and **netcdf** format (download, reading, time series creation) with a default spatial
sampling of 0.75 degrees (ERA Interim), 0.25 degrees (ERA5), resp. 0.1 degrees (ERA5-Land).
It should be easy to extend the package to support other ECMWF reanalysis products.
This will be done as need arises.
Contribute
==========
We are happy if you want to contribute. Please raise an issue explaining what
is missing or if you find a bug.
Please take a look at the `developers guide <https://github.com/TUW-GEO/ecmwf_models/blob/master/CONTRIBUTING.rst>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/TUW-GEO/ecmwf_models/",
"name": "ecmwf-models",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "TU Wien",
"author_email": "remote.sensing@geo.tuwien.ac.at",
"download_url": "https://files.pythonhosted.org/packages/5b/46/57621cae26978965ef6b76b33265ab18b12edb3d34845b633b1459855c84/ecmwf_models-0.9.2.tar.gz",
"platform": "any",
"description": "============\r\necmwf_models\r\n============\r\n\r\n\r\n.. image:: https://github.com/TUW-GEO/ecmwf_models/workflows/Automated%20Tests/badge.svg?branch=master\r\n :target: https://github.com/TUW-GEO/ecmwf_models/actions\r\n\r\n.. image:: https://coveralls.io/repos/github/TUW-GEO/ecmwf_models/badge.svg?branch=master\r\n :target: https://coveralls.io/github/TUW-GEO/ecmwf_models?branch=master\r\n\r\n.. image:: https://badge.fury.io/py/ecmwf-models.svg\r\n :target: https://badge.fury.io/py/ecmwf-models\r\n\r\n.. image:: https://readthedocs.org/projects/ecmwf-models/badge/?version=latest\r\n :target: https://ecmwf-models.readthedocs.io/en/latest/\r\n\r\nReaders and converters for data from the `ECMWF reanalysis models\r\n<http://apps.ecmwf.int/datasets/>`_. Written in Python.\r\n\r\nWorks great in combination with `pytesmo <https://github.com/TUW-GEO/pytesmo>`_.\r\n\r\nCitation\r\n========\r\n\r\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.593533.svg\r\n :target: https://doi.org/10.5281/zenodo.593533\r\n\r\nIf you use the software in a publication then please cite it using the Zenodo DOI.\r\nBe aware that this badge links to the latest package version.\r\n\r\nPlease select your specific version at https://doi.org/10.5281/zenodo.593533 to get the DOI of that version.\r\nYou should normally always use the DOI for the specific version of your record in citations.\r\nThis is to ensure that other researchers can access the exact research artefact you used for reproducibility.\r\n\r\nYou can find additional information regarding DOI versioning at http://help.zenodo.org/#versioning\r\n\r\nInstallation\r\n============\r\n\r\nInstall required C-libraries via conda. For installation we recommend\r\n`Miniconda <http://conda.pydata.org/miniconda.html>`_. So please install it according\r\nto the official installation instructions. As soon as you have the ``conda``\r\ncommand in your shell you can continue:\r\n\r\n.. code::\r\n\r\n conda install -c conda-forge pandas pygrib netcdf4 pyresample xarray\r\n\r\nThe following command will download and install all the needed pip packages as well\r\nas the ecmwf-model package itself.\r\n\r\n.. code::\r\n\r\n pip install ecmwf_models\r\n\r\nTo create a full development environment with conda, the `yml` files inside\r\nthe folder `environment/` in this repository can be used. Both environements\r\nshould work. The file `latest` should install the newest version of most\r\ndependencies. The file `pinned` is a fallback option and should always work.\r\n\r\n.. code::\r\n\r\n git clone --recursive git@github.com:TUW-GEO/ecmwf_models.git ecmwf_models\r\n cd ecmwf_models\r\n conda env create -f environment/latest.yml\r\n source activate ecmwf_models\r\n python setup.py develop\r\n pytest\r\n\r\n\r\nSupported Products\r\n==================\r\n\r\nAt the moment this package supports\r\n\r\n- **ERA Interim** (deprecated)\r\n- **ERA5**\r\n- **ERA5-Land**\r\n\r\nreanalysis data in **grib** and **netcdf** format (download, reading, time series creation) with a default spatial\r\nsampling of 0.75 degrees (ERA Interim), 0.25 degrees (ERA5), resp. 0.1 degrees (ERA5-Land).\r\nIt should be easy to extend the package to support other ECMWF reanalysis products.\r\nThis will be done as need arises.\r\n\r\nContribute\r\n==========\r\n\r\nWe are happy if you want to contribute. Please raise an issue explaining what\r\nis missing or if you find a bug.\r\nPlease take a look at the `developers guide <https://github.com/TUW-GEO/ecmwf_models/blob/master/CONTRIBUTING.rst>`_.\r\n",
"bugtrack_url": null,
"license": "mit",
"summary": "Downloading, reading and TS conversion of ECMWF reanalysis data",
"version": "0.9.2",
"project_urls": {
"Documentation": "https://ecmwf-models.readthedocs.io/en/latest/",
"Homepage": "https://github.com/TUW-GEO/ecmwf_models/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e12892c6dd5bc382ff48a96a440842b16ef70215b2d06a24d8c1ff65ffc56767",
"md5": "33babdd669ce362afd67428417c63b78",
"sha256": "91fa1f9f2b1592a69ec6ac608d74b39d93ed7f395c20deada5a8f7627fa3ac11"
},
"downloads": -1,
"filename": "ecmwf_models-0.9.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "33babdd669ce362afd67428417c63b78",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 207519,
"upload_time": "2023-05-08T12:39:00",
"upload_time_iso_8601": "2023-05-08T12:39:00.413395Z",
"url": "https://files.pythonhosted.org/packages/e1/28/92c6dd5bc382ff48a96a440842b16ef70215b2d06a24d8c1ff65ffc56767/ecmwf_models-0.9.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b4657621cae26978965ef6b76b33265ab18b12edb3d34845b633b1459855c84",
"md5": "5500f3bbeb276423bc3c91af9bfe6570",
"sha256": "19c34eced7110c0c267fc64112ada302e79548f653f3a52ff5b673f09872ed78"
},
"downloads": -1,
"filename": "ecmwf_models-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "5500f3bbeb276423bc3c91af9bfe6570",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 986434,
"upload_time": "2023-05-08T12:39:02",
"upload_time_iso_8601": "2023-05-08T12:39:02.601392Z",
"url": "https://files.pythonhosted.org/packages/5b/46/57621cae26978965ef6b76b33265ab18b12edb3d34845b633b1459855c84/ecmwf_models-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-08 12:39:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TUW-GEO",
"github_project": "ecmwf_models",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ecmwf-models"
}
JSON
