diff --git a/README.rst b/README.rst index db43e383d..d2c3f5bb9 100644 --- a/README.rst +++ b/README.rst @@ -25,56 +25,53 @@ Wetterdienst - Open weather data for humans Breaking changes should be expected until a 1.0 release, so version pinning is recommended. -.. - - **NOTE** +**Badges** - Wetterdienst 0.57.0 switched from pandas to Polars, which may cause breaking changes - for certain user-space code heavily using pandas idioms, because Wetterdienst now - returns a `Polars DataFrame`_. If you absolutely must use a pandas DataFrame, you can - cast the Polars DataFrame to pandas by using the ``.to_pandas()`` method. +**CI** .. image:: https://github.com/earthobservations/wetterdienst/actions/workflows/tests.yml/badge.svg?branch=main :target: https://github.com/earthobservations/wetterdienst/actions?workflow=Tests :alt: CI: Overall outcome +.. image:: https://readthedocs.org/projects/wetterdienst/badge/?version=latest + :target: https://wetterdienst.readthedocs.io/en/latest/?badge=latest + :alt: Documentation status .. image:: https://codecov.io/gh/earthobservations/wetterdienst/branch/main/graph/badge.svg :target: https://codecov.io/gh/earthobservations/wetterdienst :alt: CI: Code coverage + +**Meta** + .. image:: https://img.shields.io/pypi/v/wetterdienst.svg :target: https://pypi.org/project/wetterdienst/ :alt: PyPI version .. image:: https://img.shields.io/conda/vn/conda-forge/wetterdienst.svg :target: https://anaconda.org/conda-forge/wetterdienst :alt: Conda version - +.. image:: https://img.shields.io/github/license/earthobservations/wetterdienst + :target: https://github.com/earthobservations/wetterdienst/blob/main/LICENSE + :alt: Project license .. image:: https://img.shields.io/pypi/status/wetterdienst.svg :target: https://pypi.python.org/pypi/wetterdienst/ :alt: Project status (alpha, beta, stable) +.. image:: https://img.shields.io/pypi/pyversions/wetterdienst.svg + :target: https://pypi.python.org/pypi/wetterdienst/ + :alt: Python version compatibility + +**Downloads** + .. image:: https://static.pepy.tech/personalized-badge/wetterdienst?period=month&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20downloads/month :target: https://pepy.tech/project/wetterdienst :alt: PyPI downloads .. image:: https://img.shields.io/conda/dn/conda-forge/wetterdienst.svg?label=Conda%20downloads :target: https://anaconda.org/conda-forge/wetterdienst :alt: Conda downloads -.. image:: https://img.shields.io/github/license/earthobservations/wetterdienst - :target: https://github.com/earthobservations/wetterdienst/blob/main/LICENSE - :alt: Project license -.. image:: https://img.shields.io/pypi/pyversions/wetterdienst.svg - :target: https://pypi.python.org/pypi/wetterdienst/ - :alt: Python version compatibility -.. image:: https://readthedocs.org/projects/wetterdienst/badge/?version=latest - :target: https://wetterdienst.readthedocs.io/en/latest/?badge=latest - :alt: Documentation status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Documentation: Black +**Citation** .. image:: https://zenodo.org/badge/160953150.svg :target: https://zenodo.org/badge/latestdoi/160953150 :alt: Citation reference - .. overview_start_marker Introduction @@ -117,82 +114,6 @@ on datasets and parameters is given at the coverage_ subsection. Licenses and usage requirements may differ for each provider so check this out before including the data in your project to be sure that you fulfill copyright requirements! -Here is a short glimpse on the data that is included: - -.. coverage_start_marker - -DWD (Deutscher Wetterdienst / German Weather Service / Germany) - - Historical Weather Observations - - Historical (last ~300 years), recent (500 days to yesterday), now (yesterday up to last hour) - - Every minute to yearly resolution - - Time series of stations in Germany - - see the rdwd pages for an interactive map_ and table_ of available datasets - - Mosmix - statistical optimized scalar forecasts extracted from weather models - - Point forecast - - 5400 stations worldwide - - Both MOSMIX-L and MOSMIX-S is supported - - Up to 115 parameters - - DMO - timeseries extracted from weather models - - Point forecast - - 5400 stations worldwide - - Up to 115 parameters - - Road Weather Observations - - Historical weather observations of German highway stations - - Radar - - 16 locations in Germany - - All of Composite, Radolan, Radvor, Sites and Radolan_CDC - - Radolan: calibrated radar precipitation - - Radvor: radar precipitation forecast - -ECCC (Environnement et Changement Climatique Canada / Environment and Climate Change Canada / Canada) - - Historical Weather Observations - - Historical (last ~180 years) - - Hourly, daily, monthly, (annual) resolution - - Time series of stations in Canada - -NOAA (National Oceanic And Atmospheric Administration / National Oceanic And Atmospheric Administration / United States Of America) - - Global Historical Climatology Network - - Historical, daily weather observations from around the globe - - more then 100k stations - - data for weather services which don't publish data themselves - -WSV (Wasserstraßen- und Schifffahrtsverwaltung des Bundes / Federal Waterways and Shipping Administration) - - Pegelonline - - data of river network of Germany - - coverage of last 30 days - - parameters like stage, runoff and more related to rivers - -EA (Environment Agency) - - Hydrology - - data of river network of UK - - parameters flow and ground water stage - -NWS (NOAA National Weather Service) - - Observation - - recent observations (last week) of US weather stations - - currently the list of stations is not completely right as we use a diverging source! -Eaufrance - - Hubeau - - data of river network of France (continental) - - parameters flow and stage of rivers of last 30 days - -Geosphere (Geosphere Austria, formerly Central Institution for Meteorology and Geodynamics) - - Observation - - historical meteorological data of Austrian stations - -IMGW (Institute of Meteorology and Water Management) - - Meteorology - - meteorological data of polish weather stations - - daily and monthly summaries - - Hydrology - - hydrological data of polish river stations - - daily and monthly summaries - -.. coverage_end_marker - -To get better insight on which data we have currently made available and under which -license those are published take a look at the data_ section. - Features ******** diff --git a/docs/data/introduction.rst b/docs/data/introduction.rst index cfc18d08b..2097c73cf 100644 --- a/docs/data/introduction.rst +++ b/docs/data/introduction.rst @@ -9,6 +9,69 @@ your convenience. Please take a moment to review these resources to ensure that Here's a quick overview of the data sources currently supported by `wetterdienst`: -.. include:: ../../README.rst - :start-after: .. coverage_start_marker - :end-before: .. coverage_end_marker +DWD (Deutscher Wetterdienst / German Weather Service / Germany) + - Historical Weather Observations + - Historical (last ~300 years), recent (500 days to yesterday), now (yesterday up to last hour) + - Every minute to yearly resolution + - Time series of stations in Germany + - see the rdwd pages for an interactive map_ and table_ of available datasets + - Mosmix - statistical optimized scalar forecasts extracted from weather models + - Point forecast + - 5400 stations worldwide + - Both MOSMIX-L and MOSMIX-S is supported + - Up to 115 parameters + - DMO - timeseries extracted from weather models + - Point forecast + - 5400 stations worldwide + - Up to 115 parameters + - Road Weather Observations + - Historical weather observations of German highway stations + - Radar + - 16 locations in Germany + - All of Composite, Radolan, Radvor, Sites and Radolan_CDC + - Radolan: calibrated radar precipitation + - Radvor: radar precipitation forecast + +ECCC (Environnement et Changement Climatique Canada / Environment and Climate Change Canada / Canada) + - Historical Weather Observations + - Historical (last ~180 years) + - Hourly, daily, monthly, (annual) resolution + - Time series of stations in Canada + +NOAA (National Oceanic And Atmospheric Administration / National Oceanic And Atmospheric Administration / United States Of America) + - Global Historical Climatology Network + - Historical, daily weather observations from around the globe + - more then 100k stations + - data for weather services which don't publish data themselves + +WSV (Wasserstraßen- und Schifffahrtsverwaltung des Bundes / Federal Waterways and Shipping Administration) + - Pegelonline + - data of river network of Germany + - coverage of last 30 days + - parameters like stage, runoff and more related to rivers + +EA (Environment Agency) + - Hydrology + - data of river network of UK + - parameters flow and ground water stage + +NWS (NOAA National Weather Service) + - Observation + - recent observations (last week) of US weather stations + - currently the list of stations is not completely right as we use a diverging source! +Eaufrance + - Hubeau + - data of river network of France (continental) + - parameters flow and stage of rivers of last 30 days + +Geosphere (Geosphere Austria, formerly Central Institution for Meteorology and Geodynamics) + - Observation + - historical meteorological data of Austrian stations + +IMGW (Institute of Meteorology and Water Management) + - Meteorology + - meteorological data of polish weather stations + - daily and monthly summaries + - Hydrology + - hydrological data of polish river stations + - daily and monthly summaries