atmolib 0.1.0

Description:

atmolib 0.1.0

*** Important Legal Disclaimer ***

atmolib is not affiliated, endorsed, or vetted by Open-Meteo. It's an open-source tool that uses Open-Meteo's publicly available APIs, and is intended for research and educational purposes only.

Package Description
atmolib is a weather package that offers its users an easy and flexible way to access and parse weather data in a pythonic way. The package uses the Open-Meteo Web APIs to fetch the weather data in its backend.
Installation
Install atmolib using pip:
$ python -m pip install -U atmolib --no-cache-dir

Required Dependencies
Quick Guide
atmolib offers its users an array of objects which can be used for meteorology data extraction from the Open-Meteo's Web APIs.
The names of the objects with their description are mentioned as follows:

Weather
Offers comprehensive extraction of current, hourly, and daily weather forecast data, encompassing temperature, dew point, weather code, soil temperature, visibility, and more, at specified coordinates.
WeatherArchive
Enables retrieval of historical weather data, spanning hourly and daily records from 1940 till the present day, at specified coordinates.
MarineWeather
Empowers users to access current, hourly, and daily marine weather forecast data, including wave height, wave direction, and wave period, at specified coordinates within a 5 kilometer(km) resolution.
AirQuality
Provides access to current and hourly air quality forecast data, encompassing AQI, atmospheric gas concentrations, UV index, and more, at specified coordinates.

The also provides users with some useful functions as a part of the package as mentioned below:


get_elevation
Extracts the elevation in meters(m) at the specified coordinates.


get_city_details
Extracts the city details such as coordinates, country, timezone, etc. based on the specified name.


Basic Usage
This guide provides the basic usage of the atmolib package and highlights some of the generally used methods.
All the methods in the package are designed to be used with minimal arguments with default
arguments already being specified in all of them.

Weather class usage:

import atmolib as atmo

# 'forecast_days' is an optional argument and specifies the number
# of days for which forecast data is desired to be extracted.
weather = atmo.Weather(lat=26.91, long=75.54, forecast_days=10)

# Extracts a summary of weather forecast data.
weather.get_current_summary()
weather.get_hourly_summary()
weather.get_daily_summary()

# Extracts the current weather conditions.
weather.get_current_temperature()
weather.get_current_weather_code()
weather.get_current_cloud_cover()
weather.get_current_wind_speed()
weather.get_current_pressure()
weather.get_current_precipitation()
weather.get_current_relative_humidity()

# Extracts the hourly weather forecast data.
weather.get_hourly_temperature()
weather.get_hourly_visibility()
weather.get_hourly_wind_speed()
weather.get_hourly_precipitation_probability()
weather.get_hourly_soil_temperature()

# Extracts the daily weather forecast data.
weather.get_daily_temperature()
weather.get_daily_max_precipitation_probability()
weather.get_daily_max_uv_index()
weather.get_daily_max_wind_speed()
weather.get_daily_total_precipitation()
weather.get_daily_sunshine_duration()



WeatherArchive provides the same methods as Weather class as a part of a data range with slight modifications in some methods.


MarineWeather class usage:


import atmolib as atmo

# 'forecast_days' is an optional argument and specifies the number
# of days for which forecast data is desired to be extracted.
# 'wave_type' refers to the type of waves for which marine
# weather data is desired to be extracted.
marine = atmo.MarineWeather(lat=0, long=0, wave_type='wind', forecast_days=7)

# Extracts a summary of marine weather forecast data.
marine.get_current_summary()
marine.get_hourly_summary()
marine.get_daily_summary()

# Extracts the current weather conditions.
marine.get_current_wave_height()
marine.get_current_wave_direction()
marine.get_current_wave_period()

# Extracts the hourly weather forecast data.
marine.get_hourly_wave_height()
marine.get_hourly_wave_direction()
marine.get_hourly_wave_period()

# Extracts the daily weather forecast data.
marine.get_daily_max_wave_height()
marine.get_daily_dominant_wave_direction()
marine.get_daily_max_wave_period()


AirQuality class usage:

import atmolib as atmo

air = atmo.AirQuality(lat=26.91, long=75.54, forecast_days=7)

# Extracts a summary of air quality forecast data.
air.get_current_summary()
air.get_hourly_summary()

# Extracts the current weather conditions.
air.get_current_aqi()
air.get_current_pm2_5_conc()
air.get_current_pm10_conc()
air.get_current_uv_index()
air.get_hourly_dust_conc()

# Extracts the hourly weather forecast data.
air.get_hourly_uv_index()
air.get_hourly_uv_index()
air.get_hourly_pm2_5_conc()
air.get_hourly_pm10_conc()
air.get_hourly_aerosol_optical_depth()

Legals
atmolib is distributed under the MIT License. Refer to the LICENSE for more details.
AGAIN: atmolib is not affiliated, endorsed, or vetted by Open-Meteo. It's an open-source tool that uses Open-Meteo's publicly available meteorology APIs, and is intended for research and educational purposes only.
Call for Contributions
The atmolib project always welcomes your precious expertise and enthusiasm!
The package relies on its community's wisdom and intelligence to investigate bugs and contribute code. We always appreciate improvements and contributions to this project.