Skip to main content

A package which provides various functionalities on air pollution data.

Project description

airpyllution

codecov build deploy

airpyllution is a Python package for visualizing or obtaining future, historic and current air pollution data using the OpenWeather API. Our goal is to enable users the ability to explore air pollution levels in locations around the world by providing visual charts and graphs. We make the data accessible and easy to comprehend in just a few lines of code.

Although there is an abundance of python weather packages and APIs in the Python ecosystem (e.g. python-weather, weather-forecast), this particular package looks at specifically air pollution data and uses the Air Pollution API from OpenWeather. This is a unique package which provides simple and easy to use functions and allows users to quickly access and visualise data.

The data returned from the API includes the polluting gases such as Carbon monoxide (CO), Nitrogen monoxide (NO), Nitrogen dioxide (NO2), Ozone (O3), Sulphur dioxide (SO2), Ammonia (NH3), and particulates (PM2.5 and PM10).

Using the OpenWeatherMap API requires sign up to gain access to an API key.
For more information about API call limits and API care recommendations please visit the OpenWeather how to start page.

Functions

This package contains 3 functions:

  • get_air_pollution()
  • get_pollution_history()
  • get_pollution_forecast()

get_air_pollution()

Fetches the air pollution levels based on a location. Based on the values of the polluting gases, this package uses the Air Quality Index to determine the level of pollution for the location and produces a coloured map of the area displaying the varying regions of air quality.

get_pollution_history()

Requires a start and end date and fetches historic air pollution data for a specific location. The function returns a data frame with the values of the polluting gases over the specified date range.

get_pollution_forecast()

Fetches air pollution data for the next 5 days for a specific location. The function returns a time series plot of the predicted pollution levels.

Installation

$ pip install airpyllution

Usage and Example

readthedocs

  1. Create an OpenWeather API Key
  2. Install airpyllution
  3. Refer to ReadTheDocs for a usage guide and examples.

To use the package, import the package with the following commands:

from airpyllution.airpyllution import get_air_pollution
from airpyllution.airpyllution import get_pollution_history
from airpyllution.airpyllution import get_pollution_forecast

Retrieve historic pollution data with specified date range and location:

get_pollution_history(1606488670, 1606747870, 49.28, 123.12, api_key)

Generate an interactive map containing current pollution data by location:

get_air_pollution(49.28, 123.12, api_key, "Current Air Pollution")

Generate a time-series line chart of forecasted air pollution data:

import altair as alt
alt.renderers.enable("html");

get_pollution_forecast(49.28, 123.12, api_key)

Contributors

  • Christopher Alexander (@christopheralex)
  • Daniel King (@danfke)
  • Mel Liow (@mel-liow)

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

airpyllution was created by Christopher Alexander, Daniel King, Mel Liow. It is licensed under the terms of the Hippocratic License 3.0.

Credits

airpyllution was created with cookiecutter and the py-pkgs-cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airpyllution-2.0.1.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

airpyllution-2.0.1-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file airpyllution-2.0.1.tar.gz.

File metadata

  • Download URL: airpyllution-2.0.1.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for airpyllution-2.0.1.tar.gz
Algorithm Hash digest
SHA256 020e9503f71dbfb0a6cf15e193a2650119853097cb29e3197bbcf49324dd3d03
MD5 48b7d9bb13b99264d2d66080c3d38710
BLAKE2b-256 2c2f19d6120226b742732355f320b65fae8579197d6a59d3ef7b24ce8f0b0fcc

See more details on using hashes here.

File details

Details for the file airpyllution-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: airpyllution-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for airpyllution-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0da433c8cf834cbfafcf0bacd701c3c2bc5f11800248207dcddaa837d71ab1e7
MD5 14968b7c7525958439249cd78034537c
BLAKE2b-256 9a95dd1d64188a58b7e868ca51c2539acf35618ba090b3019760734295bc92be

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page