Metadata-Version: 2.1
Name: airqdata
Version: 0.2
Summary: A toolkit to retrieve, analyze and visualize data from a variety of air quality sensors.
Home-page: https://github.com/dr-1/airqdata
Author: Dominik Rubo
License: GNU GPLv3
Keywords: air quality pollution sensor data analysis particulate matter pm influencair irceline luftdaten
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: matplotlib (>=2)
Requires-Dist: pandas (>=0.22)
Requires-Dist: requests (>=2.10)

# Air quality data

A toolkit to retrieve, analyze and visualize data from a variety of air quality
sensors.

The scripts include tools to  
* wrap the APIs of various data providers, including Civic Lab Brussels'
[InfluencAir] project, the [luftdaten.info] project, [madavi.de] and
[irceline.be]  
* represent sensors of those different providers as objects with a unified
  interface to make it easy to interact with them  
* retrieve sensor measurement data through API calls  
* cache those data  
* clean and combine the data  
* describe measurements statistically - individual sensors or groups to
  compare  
* plot measurement time series  
* find sensors that are geographically close to a point of interest or to other
  sensors  

For usage examples, see the [demo] notebook.

## Installation
To install airqdata from PyPI, run  
`pip install airqdata`

A Python 3.5+ environment and several Python packages are required. When
installing airqdata with pip, those dependencies will be installed
automatically. Otherwise see requirements.txt and
install_requirements.sh in this repository.

## Legal
The scripts are licensed under the [GPLv3].

Data made available by the luftdaten.info project are [licensed][luftdaten
licensing] under the [Open Database License][ODbL].

Data published by the Belgian Interregional Environment Agency (IRCEL/CELINE)
are [licensed][irceline licensing] under the [Creative Commons Attribution 4.0
license][CC-BY 4.0].

[InfluencAir]: https://influencair.be
[luftdaten.info]: https://luftdaten.info
[madavi.de]: https://www.madavi.de/ok-lab-stuttgart
[irceline.be]: http://www.irceline.be/en
[demo]: https://nbviewer.jupyter.org/gist/dr-1/450c275b1ad2cbf88e9c4325c5d032bc
[GPLv3]: https://www.gnu.org/licenses/gpl-3.0.html
[luftdaten licensing]: https://archive.luftdaten.info/00disclamer.md
[ODbL]: https://opendatacommons.org/licenses/odbl/1.0/
[irceline licensing]: http://www.irceline.be/en/documentation/open-data
[CC-BY 4.0]: https://creativecommons.org/licenses/by/4.0


