Skip to main content

Open weather data for humans

Project description

https://github.com/earthobservations/wetterdienst/workflows/Tests/badge.svg https://codecov.io/gh/earthobservations/wetterdienst/branch/master/graph/badge.svg Documentation Status https://img.shields.io/badge/code%20style-black-000000.svg https://img.shields.io/pypi/pyversions/wetterdienst.svg https://img.shields.io/pypi/v/wetterdienst.svg https://img.shields.io/pypi/status/wetterdienst.svg https://pepy.tech/badge/wetterdienst/month https://img.shields.io/github/license/earthobservations/wetterdienst https://zenodo.org/badge/160953150.svg

Introduction

Welcome to Wetterdienst, your friendly weather service library for Python.

We are a group of like-minded people trying to make access to weather data in Python feel like a warm summer breeze, similar to other projects like rdwd for the R language, which originally drew our interest in this project.

While our long-term goal is to provide access to multiple weather services, we are still stuck with the German Weather Service (DWD). Contributions are always welcome!

This program and its repository tries to use modern Python technologies all over the place. The library is based on Pandas across the board, uses Poetry for package administration and GitHub actions for all things CI.

Features

Coverage

The library currently covers

  • historical weather data from ground stations

  • RADOLAN fitted radar data for areal precipitation

  • MOSMIX statistical optimized scalar forecasts extracted from weather models

To get better insight on which data we have currently made available, with this library take a look at data coverage.

Details

  • Get metadata for a set of Parameter, PeriodType and TimeResolution.

  • Get station(s) nearby a selected location.

  • Store/recover collected data.

  • Command line interface.

  • Run SQL queries on the results.

  • Export results to databases and other data sinks.

  • Public Docker image on ghcr.io.

Setup

Run this to make wetterdienst available in your current environment:

pip install wetterdienst

Synopsis

Get historical data for specific stations, using Python:

from wetterdienst import DWDStationRequest, Parameter, PeriodType, TimeResolution

request = DWDStationRequest(
    station_ids=[1048,4411],
    parameter=[Parameter.CLIMATE_SUMMARY, Parameter.SOLAR],
    time_resolution=TimeResolution.DAILY,
    start_date="1990-01-01",
    end_date="2020-01-01",
    tidy_data=True,
    humanize_column_names=True,
    write_file=True,
    prefer_local=True
)

for df in request.collect_data():
    # analyse the station here

Get data for specific stations from the command line:

# Get list of all stations for daily climate summary data in JSON format
wetterdienst stations --parameter=kl --resolution=daily --period=recent

# Get daily climate summary data for specific stations
wetterdienst readings --station=1048,4411 --parameter=kl --resolution=daily --period=recent

Documentation

We strongly recommend reading the full documentation, which will be updated continuously as we make progress with this library:

For the whole functionality, check out the Wetterdienst API section of our documentation, which will be constantly updated. To stay up to date with the development, take a look at the changelog. Also, don’t miss out our examples.

Data license

Although the data is specified as being open, the DWD asks you to reference them as copyright owner. Please take a look at the Open Data Strategy at the DWD and the Official Copyright statements before using the data.

Release history Release notifications | RSS feed

Download files

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

Source Distribution

wetterdienst-0.8.0.tar.gz (51.9 kB view hashes)

Uploaded Source

Built Distribution

wetterdienst-0.8.0-py3-none-any.whl (64.3 kB view hashes)

Uploaded Python 3

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