| Name | rws-knmi-lib JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | |
| Summary | Library voor communicatie met KNMI weer data. |
| upload_time | 2024-01-29 15:16:05 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | |
| keywords |
rws-knmi-lib
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
############
RWS KNMI Lib
############
.. begin-inclusion-intro-marker-do-not-remove
Library to download KNMI weather data aggregated on a daily level or on an hourly level.
.. end-inclusion-intro-marker-do-not-remove
.. begin-inclusion-usage-marker-do-not-remove
How to use
----------
In order to download data on a daily level, use the following code below.
.. code:: python
from rws_knmi_lib.knmi_downloader import import_daily_data
# Returns dataframe containing information on all KNMI stations.
df_daily = import_daily_data(start="20220501", end="20220505")
# Returns dataframe containing only information from the nearest KNMI station.
df_daily_nearest = import_daily_data(start="20220501", end="20220505",
coord=(52.460770, 4.625110))
An example for obtaining hourly aggregated daily looks like this:
.. code:: python
from rws_knmi_lib.knmi_downloader import import_hourly_data
# Returns dataframe containing information on all KNMI stations.
df_hourly = import_hourly_data(start="20220501", end="20220505")
# Returns dataframe containing only information from the nearest KNMI station.
df_hourly_nearest = import_hourly_data(start="20220501", end="20220505",
coord=(52.460770, 4.625110))
.. end-inclusion-usage-marker-do-not-remove
.. begin-inclusion-installation-marker-do-not-remove
Installation
------------
To install rws-knmi-lib, do:
.. code-block:: console
git clone https://gitlab.com/rwsdatalab/public/codebase/tools/rws-knmi-lib
cd rws-knmi-lib
pip install .
Run tests (including coverage) with:
.. code-block:: console
pip install .[dev]
pytest
.. end-inclusion-installation-marker-do-not-remove
Documentation
-------------
Find the full documentation at https://rwsdatalab.gitlab.io/public/codebase/tools/rws-knmi-lib
.. begin-inclusion-license-marker-do-not-remove
License
-------
Copyright 2022-2024 Rijkswaterstaat
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.
.. end-inclusion-license-marker-do-not-remove
Raw data
{
"_id": null,
"home_page": "",
"name": "rws-knmi-lib",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "rws-knmi-lib",
"author": "",
"author_email": "RWS Datalab <datalab.codebase@rws.nl>",
"download_url": "https://files.pythonhosted.org/packages/c5/9d/727f74fe50dc77fd5dc096052164133a7f390c1d84efbab97ff639b848ea/rws-knmi-lib-1.0.1.tar.gz",
"platform": null,
"description": "############\nRWS KNMI Lib\n############\n\n.. begin-inclusion-intro-marker-do-not-remove\n\nLibrary to download KNMI weather data aggregated on a daily level or on an hourly level.\n\n.. end-inclusion-intro-marker-do-not-remove\n\n.. begin-inclusion-usage-marker-do-not-remove\n\nHow to use\n----------\n\nIn order to download data on a daily level, use the following code below.\n\n.. code:: python\n\n from rws_knmi_lib.knmi_downloader import import_daily_data\n\n # Returns dataframe containing information on all KNMI stations.\n df_daily = import_daily_data(start=\"20220501\", end=\"20220505\")\n\n # Returns dataframe containing only information from the nearest KNMI station.\n df_daily_nearest = import_daily_data(start=\"20220501\", end=\"20220505\",\n coord=(52.460770, 4.625110))\n\nAn example for obtaining hourly aggregated daily looks like this:\n\n.. code:: python\n\n from rws_knmi_lib.knmi_downloader import import_hourly_data\n\n # Returns dataframe containing information on all KNMI stations.\n df_hourly = import_hourly_data(start=\"20220501\", end=\"20220505\")\n\n # Returns dataframe containing only information from the nearest KNMI station.\n df_hourly_nearest = import_hourly_data(start=\"20220501\", end=\"20220505\",\n coord=(52.460770, 4.625110))\n\n.. end-inclusion-usage-marker-do-not-remove\n\n.. begin-inclusion-installation-marker-do-not-remove\n\nInstallation\n------------\n\nTo install rws-knmi-lib, do:\n\n.. code-block:: console\n\n git clone https://gitlab.com/rwsdatalab/public/codebase/tools/rws-knmi-lib\n cd rws-knmi-lib\n pip install .\n\nRun tests (including coverage) with:\n\n.. code-block:: console\n\n pip install .[dev]\n pytest\n\n.. end-inclusion-installation-marker-do-not-remove\n\n\nDocumentation\n-------------\n\nFind the full documentation at https://rwsdatalab.gitlab.io/public/codebase/tools/rws-knmi-lib\n\n.. begin-inclusion-license-marker-do-not-remove\n\nLicense\n-------\n\nCopyright 2022-2024 Rijkswaterstaat\n\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\nhttp://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.\n\n\n\n.. end-inclusion-license-marker-do-not-remove\n",
"bugtrack_url": null,
"license": "",
"summary": "Library voor communicatie met KNMI weer data.",
"version": "1.0.1",
"project_urls": {
"changelog": "https://gitlab.com/rwsdatalab/public/codebase/tools/rws-knmi-lib/blob/main/CHANGELOG.rst",
"homepage": "https://gitlab.com/rwsdatalab/public/codebase/tools/rws-knmi-lib",
"repository": "https://gitlab.com/rwsdatalab/public/codebase/tools/rws-knmi-lib"
},
"split_keywords": [
"rws-knmi-lib"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b364164adf086f8fe1b2f0150372b78912eb6f3a56ae6dffd6908e6806f0a176",
"md5": "0dc02ad376ef60fb8fcaeaba4f0d2cfb",
"sha256": "8e40f0aec8d2d4adcae87c16f6eeb0d3078e3b4e853cc797f9137da3f07e732d"
},
"downloads": -1,
"filename": "rws_knmi_lib-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0dc02ad376ef60fb8fcaeaba4f0d2cfb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9293,
"upload_time": "2024-01-29T15:16:03",
"upload_time_iso_8601": "2024-01-29T15:16:03.794277Z",
"url": "https://files.pythonhosted.org/packages/b3/64/164adf086f8fe1b2f0150372b78912eb6f3a56ae6dffd6908e6806f0a176/rws_knmi_lib-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c59d727f74fe50dc77fd5dc096052164133a7f390c1d84efbab97ff639b848ea",
"md5": "f47cdeec3a6667bdfb57b20d13699f9b",
"sha256": "7989ba2fc30179e7716e582c8f7f93b1e7c91044eb794f0d6badf5d145a3f33c"
},
"downloads": -1,
"filename": "rws-knmi-lib-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "f47cdeec3a6667bdfb57b20d13699f9b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 10249,
"upload_time": "2024-01-29T15:16:05",
"upload_time_iso_8601": "2024-01-29T15:16:05.861408Z",
"url": "https://files.pythonhosted.org/packages/c5/9d/727f74fe50dc77fd5dc096052164133a7f390c1d84efbab97ff639b848ea/rws-knmi-lib-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-29 15:16:05",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "rwsdatalab",
"gitlab_project": "public",
"lcname": "rws-knmi-lib"
}
