# SMEAR API Tools
This project contains functions that help interacting with the SmartSMEAR API.
## Installation
```shell
pip install smear-api-tools
```
## Documentation
See [here](https://jlpl.github.io/smear-api-tools/)
## Usage
### Example 1
Download DMPS data from Hyytiälä field station for each day in May, 2018
```python
import pandas as pd
from smear_api.tools import getDmpsData
may2018 = pd.date_range(start='2018-05-01',end='2018-05-31')
v = getDmpsData(station='HYY',dates=may2018)
```
### Example 2
List all variables that contain the term "SO2" in the database and write them to a file.
```python
import pandas as pd
from smear_api.tools import listAllData
listAllData("SO2").to_csv("all_so2_data.csv")
```
## Resources
Junninen, H., Lauri, A., Keronen, P., Aalto, P., Hiltunen, V., Hari, P., Kulmala, M. 2009. Smart-SMEAR: on-line data exploration and visualization tool for SMEAR stations. Boreal Environment Research 14, 447–457.
https://smear.avaa.csc.fi/
Raw data
{
"_id": null,
"home_page": "https://github.com/jlpl/smear-api-tools",
"name": "smear-api-tools",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Janne Lampilahti",
"author_email": "janne.lampilahti@helsinki.fi",
"download_url": "https://files.pythonhosted.org/packages/6f/2d/07ab0fc3fed91db4d5d176170abc882303a252f40d14d1e0db6b1faecda6/smear-api-tools-0.3.0.tar.gz",
"platform": null,
"description": "# SMEAR API Tools\n\nThis project contains functions that help interacting with the SmartSMEAR API.\n\n## Installation\n\n```shell\npip install smear-api-tools\n```\n\n## Documentation \nSee [here](https://jlpl.github.io/smear-api-tools/)\n\n## Usage\n\n### Example 1\nDownload DMPS data from Hyyti\u00e4l\u00e4 field station for each day in May, 2018\n\n```python\nimport pandas as pd\nfrom smear_api.tools import getDmpsData\n\nmay2018 = pd.date_range(start='2018-05-01',end='2018-05-31')\nv = getDmpsData(station='HYY',dates=may2018)\n```\n\n### Example 2\nList all variables that contain the term \"SO2\" in the database and write them to a file.\n\n```python\nimport pandas as pd\nfrom smear_api.tools import listAllData\n\nlistAllData(\"SO2\").to_csv(\"all_so2_data.csv\")\n```\n\n## Resources\n\nJunninen, H., Lauri, A., Keronen, P., Aalto, P., Hiltunen, V., Hari, P., Kulmala, M. 2009. Smart-SMEAR: on-line data exploration and visualization tool for SMEAR stations. Boreal Environment Research 14, 447\u2013457.\n\nhttps://smear.avaa.csc.fi/\n",
"bugtrack_url": null,
"license": "",
"summary": "Utility functions for using the SmartSMEAR API",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/jlpl/smear-api-tools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14c4ccfaefcdc8885407e1976f3653a5065a05bb0c669cb48fe245ff616c1ca8",
"md5": "6d235a0242ff0aff4be41718bdfe9707",
"sha256": "5714834072df78fd0ab4a935fa45a787011c001aeeddef1759c66f2ec5975b74"
},
"downloads": -1,
"filename": "smear_api_tools-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d235a0242ff0aff4be41718bdfe9707",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5893,
"upload_time": "2024-03-07T09:16:21",
"upload_time_iso_8601": "2024-03-07T09:16:21.276665Z",
"url": "https://files.pythonhosted.org/packages/14/c4/ccfaefcdc8885407e1976f3653a5065a05bb0c669cb48fe245ff616c1ca8/smear_api_tools-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6f2d07ab0fc3fed91db4d5d176170abc882303a252f40d14d1e0db6b1faecda6",
"md5": "28b395fea0d1326c18ebd50ae414f798",
"sha256": "33115448623c0434dae76edbc5966412cab6356e11f8f3b48e10197b5e870738"
},
"downloads": -1,
"filename": "smear-api-tools-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "28b395fea0d1326c18ebd50ae414f798",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34615,
"upload_time": "2024-03-07T09:16:23",
"upload_time_iso_8601": "2024-03-07T09:16:23.405507Z",
"url": "https://files.pythonhosted.org/packages/6f/2d/07ab0fc3fed91db4d5d176170abc882303a252f40d14d1e0db6b1faecda6/smear-api-tools-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-07 09:16:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jlpl",
"github_project": "smear-api-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "smear-api-tools"
}