| Name | aqipy-atmotech JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | |
| Summary | AQI calculation library |
| upload_time | 2020-11-12 21:02:02 |
| maintainer | |
| docs_url | None |
| author | Atmotech Inc. |
| requires_python | >=3.6 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AQI calculation library (python)
[](https://badge.fury.io/py/aqipy-atmotech)
[](https://pypi.python.org/pypi/aqipy-atmotech)
The library calculates the following indexes:
- AQI (US)
- AQHI (Canada)
- CAQI (Europe)
- DAQI (UK)
- AQI (Australia)
- CAI (South Korea)
- PSI (Singapore)
- AQHI (Hong Kong)
- AQI (Mainland China)
- AQI (India)
## Installation
From source:
```
git clone --recursive https://github.com/atmotube/aqipy.git
cd python
python setup.py install
```
From [PyPI](https://pypi.python.org/pypi/aqipy-atmotech/) directly:
```
pip3 install aqipy-atmotech
```
## Examples
calculate US AQI:
```python
from aqipy import aqi_us
aqi, aqi_data = aqi_us.get_aqi(o3_8h=0.07853333, co_8h=5)
print('AQI:', aqi)
print('AQI O3:', aqi_data['o3_8h'][0])
print('Effects O3:', aqi_data['o3_8h'][1])
print('Cautions O3:', aqi_data['o3_8h'][2])
print('AQI CO:', aqi_data['co_8h'][0])
print('Effects CO:', aqi_data['co_8h'][1])
print('Cautions CO:', aqi_data['co_8h'][2])
```
output will be:
```
AQI: 126
AQI O3: 126
Effects O3: Increasing likelihood of respiratory symptoms and breathing discomfort in people with lung disease (such as asthma), children, older adults, people who are active outdoors (including outdoor workers), people with certain genetic variants, and people with diets limited in certain nutrients.
Cautions O3: People with lung disease (such as asthma), children, older adults, people who are active outdoors (including outdoor workers), people with certain genetic variants, and people with diets limited in certain nutrients should reduce prolonged or heavy outdoor exertion.
AQI CO: 56
Effects CO:
Cautions CO:
```
## Units
| Pollutant | Units |
|--------------------|-----------------|
| CO |ppm |
| O<sub>3</sub> |ppm |
| NO<sub>2</sub> |ppm |
| SO<sub>2</sub> |ppm |
| NH<sub>3</sub> |ppm |
| Pb |ppm |
| PM<sub>2.5</sub> |μg/m<sup>3</sup> |
| PM<sub>10</sub> |μg/m<sup>3</sup> |
## Summary (averages)
| Index |PM<sub>2.5</sub> | PM<sub>10</sub> |O<sub>3</sub> |NO<sub>2</sub> |CO |SO<sub>2</sub> |NH<sub>3</sub> |Pb |
|---------------------|-----------------|-----------------|------------------|-----------------|-----------------|-----------------|-----------------|-----------------|
| AQI (US) |24h |24h |8h/1h |1h |8h |1h |- |- |
| AQHI (Canada) |3h |3h |3h |3h |- |- |- |- |
| CAQI (Europe) |1h/24h |1h/24h |max in 1h |max in 1h |8h |max in 1h |- |- |
| DAQI (UK) |24h |24h |8h |1h |- |15m |- |- |
| AQI (Australia) |24h |24h |1h/4h |1h |8h |1h |- |- |
| CAI (South Korea) |24h |24h |1h |1h |1h |1h |- |- |
| PSI (Singapore) |24h |24h |8h |1h |8h |24h |- |- |
| AQHI (Hong Kong) |3h |3h |3h |3h |3h |3h |- |- |
| AQI (Mainland China)|24h |24h |1h/8h |24h |24h |24h |- |- |
| AQI (India) |24h |24h |8h |24h |8h |24h |24h |24h |
Raw data
{
"_id": null,
"home_page": "",
"name": "aqipy-atmotech",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Atmotech Inc.",
"author_email": "info@atmotube.com",
"download_url": "https://files.pythonhosted.org/packages/6b/e7/178342669eea5f68d01c637afbce53a52fc1b6535683788ecc3d492194c1/aqipy-atmotech-0.1.5.tar.gz",
"platform": "",
"description": "# AQI calculation library (python)\n[](https://badge.fury.io/py/aqipy-atmotech)\n[](https://pypi.python.org/pypi/aqipy-atmotech)\n\nThe library calculates the following indexes:\n- AQI (US)\n- AQHI (Canada)\n- CAQI (Europe)\n- DAQI (UK)\n- AQI (Australia)\n- CAI (South Korea)\n- PSI (Singapore)\n- AQHI (Hong Kong)\n- AQI (Mainland China)\n- AQI (India)\n\n## Installation\n\nFrom source:\n\n```\ngit clone --recursive https://github.com/atmotube/aqipy.git\ncd python\npython setup.py install\n```\n\nFrom [PyPI](https://pypi.python.org/pypi/aqipy-atmotech/) directly:\n\n```\npip3 install aqipy-atmotech\n```\n\n## Examples\n\ncalculate US AQI:\n\n```python\nfrom aqipy import aqi_us\n\naqi, aqi_data = aqi_us.get_aqi(o3_8h=0.07853333, co_8h=5)\nprint('AQI:', aqi)\nprint('AQI O3:', aqi_data['o3_8h'][0])\nprint('Effects O3:', aqi_data['o3_8h'][1])\nprint('Cautions O3:', aqi_data['o3_8h'][2])\nprint('AQI CO:', aqi_data['co_8h'][0])\nprint('Effects CO:', aqi_data['co_8h'][1])\nprint('Cautions CO:', aqi_data['co_8h'][2])\n```\n\noutput will be:\n```\nAQI: 126\nAQI O3: 126\nEffects O3: Increasing likelihood of respiratory symptoms and breathing discomfort in people with lung disease (such as asthma), children, older adults, people who are active outdoors (including outdoor workers), people with certain genetic variants, and people with diets limited in certain nutrients.\nCautions O3: People with lung disease (such as asthma), children, older adults, people who are active outdoors (including outdoor workers), people with certain genetic variants, and people with diets limited in certain nutrients should reduce prolonged or heavy outdoor exertion.\nAQI CO: 56\nEffects CO:\nCautions CO:\n```\n\n## Units\n| Pollutant | Units |\n|--------------------|-----------------|\n| CO |ppm |\n| O<sub>3</sub> |ppm |\n| NO<sub>2</sub> |ppm |\n| SO<sub>2</sub> |ppm |\n| NH<sub>3</sub> |ppm |\n| Pb |ppm |\n| PM<sub>2.5</sub> |\u03bcg/m<sup>3</sup> |\n| PM<sub>10</sub> |\u03bcg/m<sup>3</sup> |\n\n## Summary (averages)\n| Index |PM<sub>2.5</sub> | PM<sub>10</sub> |O<sub>3</sub> |NO<sub>2</sub> |CO |SO<sub>2</sub> |NH<sub>3</sub> |Pb |\n|---------------------|-----------------|-----------------|------------------|-----------------|-----------------|-----------------|-----------------|-----------------|\n| AQI (US) |24h |24h |8h/1h\t |1h\t |8h |1h |- |- |\n| AQHI (Canada) |3h\t |3h\t |3h |3h |-\t |-\t |-\t |- |\n| CAQI (Europe) |1h/24h |1h/24h |max in 1h |max in 1h\t |8h\t |max in 1h |-\t |- |\n| DAQI (UK) |24h\t |24h\t |8h |1h\t |-\t |15m |-\t |- |\n| AQI (Australia) |24h\t |24h |1h/4h |1h\t |8h\t |1h\t |-\t |- |\n| CAI (South Korea) |24h\t |24h |1h\t |1h |1h\t |1h\t |- |- |\n| PSI (Singapore) |24h\t |24h |8h\t |1h\t |8h\t |24h |-\t |- |\n| AQHI (Hong Kong) |3h\t |3h\t |3h |3h\t |3h |3h |-\t |- |\n| AQI (Mainland China)|24h\t |24h |1h/8h |24h\t |24h\t |24h\t |-\t |- |\n| AQI (India) |24h |24h |8h |24h |8h |24h\t |24h\t |24h |\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "AQI calculation library",
"version": "0.1.5",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "d58b8ad30379a0853ec7e99c75e95bf6",
"sha256": "89e9b9f1fc3d843268579ee6f7c34ebd9e414c445345e630b70cc5399c60a69f"
},
"downloads": -1,
"filename": "aqipy_atmotech-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d58b8ad30379a0853ec7e99c75e95bf6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 25144,
"upload_time": "2020-11-12T21:02:01",
"upload_time_iso_8601": "2020-11-12T21:02:01.503380Z",
"url": "https://files.pythonhosted.org/packages/e8/95/d737207e9cb18ae15370a891b2e5832967ed02568133d5403e441bfc0de7/aqipy_atmotech-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "3bef069537e2275a679f47848d063c9d",
"sha256": "2f81b05e127b5cd5a8fbb9e99bc69d322038f8b2403b5e5bcb9af6d274a3f55f"
},
"downloads": -1,
"filename": "aqipy-atmotech-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "3bef069537e2275a679f47848d063c9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 14817,
"upload_time": "2020-11-12T21:02:02",
"upload_time_iso_8601": "2020-11-12T21:02:02.450108Z",
"url": "https://files.pythonhosted.org/packages/6b/e7/178342669eea5f68d01c637afbce53a52fc1b6535683788ecc3d492194c1/aqipy-atmotech-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-11-12 21:02:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "aqipy-atmotech"
}
