Skip to content

Commit cef9020

Browse files
gutzbenjgutzbenj
committed
Cleanup README.rst and docs
1 parent eff9b90 commit cef9020

File tree

2 files changed

+84
-100
lines changed

2 files changed

+84
-100
lines changed

‎README.rst‎

Lines changed: 18 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -25,56 +25,53 @@ Wetterdienst - Open weather data for humans
2525

2626
Breaking changes should be expected until a 1.0 release, so version pinning is recommended.
2727

28-
..
29-
30-
**NOTE**
28+
**Badges**
3129

32-
Wetterdienst 0.57.0 switched from pandas to Polars, which may cause breaking changes
33-
for certain user-space code heavily using pandas idioms, because Wetterdienst now
34-
returns a `Polars DataFrame`_. If you absolutely must use a pandas DataFrame, you can
35-
cast the Polars DataFrame to pandas by using the ``.to_pandas()`` method.
30+
**CI**
3631

3732
.. image:: https://github.com/earthobservations/wetterdienst/actions/workflows/tests.yml/badge.svg?branch=main
3833
:target: https://github.com/earthobservations/wetterdienst/actions?workflow=Tests
3934
:alt: CI: Overall outcome
35+
.. image:: https://readthedocs.org/projects/wetterdienst/badge/?version=latest
36+
:target: https://wetterdienst.readthedocs.io/en/latest/?badge=latest
37+
:alt: Documentation status
4038
.. image:: https://codecov.io/gh/earthobservations/wetterdienst/branch/main/graph/badge.svg
4139
:target: https://codecov.io/gh/earthobservations/wetterdienst
4240
:alt: CI: Code coverage
41+
42+
**Meta**
43+
4344
.. image:: https://img.shields.io/pypi/v/wetterdienst.svg
4445
:target: https://pypi.org/project/wetterdienst/
4546
:alt: PyPI version
4647
.. image:: https://img.shields.io/conda/vn/conda-forge/wetterdienst.svg
4748
:target: https://anaconda.org/conda-forge/wetterdienst
4849
:alt: Conda version
49-
50+
.. image:: https://img.shields.io/github/license/earthobservations/wetterdienst
51+
:target: https://github.com/earthobservations/wetterdienst/blob/main/LICENSE
52+
:alt: Project license
5053
.. image:: https://img.shields.io/pypi/status/wetterdienst.svg
5154
:target: https://pypi.python.org/pypi/wetterdienst/
5255
:alt: Project status (alpha, beta, stable)
56+
.. image:: https://img.shields.io/pypi/pyversions/wetterdienst.svg
57+
:target: https://pypi.python.org/pypi/wetterdienst/
58+
:alt: Python version compatibility
59+
60+
**Downloads**
61+
5362
.. image:: https://static.pepy.tech/personalized-badge/wetterdienst?period=month&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20downloads/month
5463
:target: https://pepy.tech/project/wetterdienst
5564
:alt: PyPI downloads
5665
.. image:: https://img.shields.io/conda/dn/conda-forge/wetterdienst.svg?label=Conda%20downloads
5766
:target: https://anaconda.org/conda-forge/wetterdienst
5867
:alt: Conda downloads
59-
.. image:: https://img.shields.io/github/license/earthobservations/wetterdienst
60-
:target: https://github.com/earthobservations/wetterdienst/blob/main/LICENSE
61-
:alt: Project license
62-
.. image:: https://img.shields.io/pypi/pyversions/wetterdienst.svg
63-
:target: https://pypi.python.org/pypi/wetterdienst/
64-
:alt: Python version compatibility
6568

66-
.. image:: https://readthedocs.org/projects/wetterdienst/badge/?version=latest
67-
:target: https://wetterdienst.readthedocs.io/en/latest/?badge=latest
68-
:alt: Documentation status
69-
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
70-
:target: https://github.com/psf/black
71-
:alt: Documentation: Black
69+
**Citation**
7270

7371
.. image:: https://zenodo.org/badge/160953150.svg
7472
:target: https://zenodo.org/badge/latestdoi/160953150
7573
:alt: Citation reference
7674

77-
7875
.. overview_start_marker
7976
8077
Introduction
@@ -117,82 +114,6 @@ on datasets and parameters is given at the coverage_ subsection. Licenses and
117114
usage requirements may differ for each provider so check this out before including
118115
the data in your project to be sure that you fulfill copyright requirements!
119116

120-
Here is a short glimpse on the data that is included:
121-
122-
.. coverage_start_marker
123-
124-
DWD (Deutscher Wetterdienst / German Weather Service / Germany)
125-
- Historical Weather Observations
126-
- Historical (last ~300 years), recent (500 days to yesterday), now (yesterday up to last hour)
127-
- Every minute to yearly resolution
128-
- Time series of stations in Germany
129-
- see the rdwd pages for an interactive map_ and table_ of available datasets
130-
- Mosmix - statistical optimized scalar forecasts extracted from weather models
131-
- Point forecast
132-
- 5400 stations worldwide
133-
- Both MOSMIX-L and MOSMIX-S is supported
134-
- Up to 115 parameters
135-
- DMO - timeseries extracted from weather models
136-
- Point forecast
137-
- 5400 stations worldwide
138-
- Up to 115 parameters
139-
- Road Weather Observations
140-
- Historical weather observations of German highway stations
141-
- Radar
142-
- 16 locations in Germany
143-
- All of Composite, Radolan, Radvor, Sites and Radolan_CDC
144-
- Radolan: calibrated radar precipitation
145-
- Radvor: radar precipitation forecast
146-
147-
ECCC (Environnement et Changement Climatique Canada / Environment and Climate Change Canada / Canada)
148-
- Historical Weather Observations
149-
- Historical (last ~180 years)
150-
- Hourly, daily, monthly, (annual) resolution
151-
- Time series of stations in Canada
152-
153-
NOAA (National Oceanic And Atmospheric Administration / National Oceanic And Atmospheric Administration / United States Of America)
154-
- Global Historical Climatology Network
155-
- Historical, daily weather observations from around the globe
156-
- more then 100k stations
157-
- data for weather services which don't publish data themselves
158-
159-
WSV (Wasserstraßen- und Schifffahrtsverwaltung des Bundes / Federal Waterways and Shipping Administration)
160-
- Pegelonline
161-
- data of river network of Germany
162-
- coverage of last 30 days
163-
- parameters like stage, runoff and more related to rivers
164-
165-
EA (Environment Agency)
166-
- Hydrology
167-
- data of river network of UK
168-
- parameters flow and ground water stage
169-
170-
NWS (NOAA National Weather Service)
171-
- Observation
172-
- recent observations (last week) of US weather stations
173-
- currently the list of stations is not completely right as we use a diverging source!
174-
Eaufrance
175-
- Hubeau
176-
- data of river network of France (continental)
177-
- parameters flow and stage of rivers of last 30 days
178-
179-
Geosphere (Geosphere Austria, formerly Central Institution for Meteorology and Geodynamics)
180-
- Observation
181-
- historical meteorological data of Austrian stations
182-
183-
IMGW (Institute of Meteorology and Water Management)
184-
- Meteorology
185-
- meteorological data of polish weather stations
186-
- daily and monthly summaries
187-
- Hydrology
188-
- hydrological data of polish river stations
189-
- daily and monthly summaries
190-
191-
.. coverage_end_marker
192-
193-
To get better insight on which data we have currently made available and under which
194-
license those are published take a look at the data_ section.
195-
196117
Features
197118
********
198119

‎docs/data/introduction.rst‎

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,69 @@ your convenience. Please take a moment to review these resources to ensure that
99

1010
Here's a quick overview of the data sources currently supported by `wetterdienst`:
1111

12-
.. include:: ../../README.rst
13-
:start-after: .. coverage_start_marker
14-
:end-before: .. coverage_end_marker
12+
DWD (Deutscher Wetterdienst / German Weather Service / Germany)
13+
- Historical Weather Observations
14+
- Historical (last ~300 years), recent (500 days to yesterday), now (yesterday up to last hour)
15+
- Every minute to yearly resolution
16+
- Time series of stations in Germany
17+
- see the rdwd pages for an interactive map_ and table_ of available datasets
18+
- Mosmix - statistical optimized scalar forecasts extracted from weather models
19+
- Point forecast
20+
- 5400 stations worldwide
21+
- Both MOSMIX-L and MOSMIX-S is supported
22+
- Up to 115 parameters
23+
- DMO - timeseries extracted from weather models
24+
- Point forecast
25+
- 5400 stations worldwide
26+
- Up to 115 parameters
27+
- Road Weather Observations
28+
- Historical weather observations of German highway stations
29+
- Radar
30+
- 16 locations in Germany
31+
- All of Composite, Radolan, Radvor, Sites and Radolan_CDC
32+
- Radolan: calibrated radar precipitation
33+
- Radvor: radar precipitation forecast
34+
35+
ECCC (Environnement et Changement Climatique Canada / Environment and Climate Change Canada / Canada)
36+
- Historical Weather Observations
37+
- Historical (last ~180 years)
38+
- Hourly, daily, monthly, (annual) resolution
39+
- Time series of stations in Canada
40+
41+
NOAA (National Oceanic And Atmospheric Administration / National Oceanic And Atmospheric Administration / United States Of America)
42+
- Global Historical Climatology Network
43+
- Historical, daily weather observations from around the globe
44+
- more then 100k stations
45+
- data for weather services which don't publish data themselves
46+
47+
WSV (Wasserstraßen- und Schifffahrtsverwaltung des Bundes / Federal Waterways and Shipping Administration)
48+
- Pegelonline
49+
- data of river network of Germany
50+
- coverage of last 30 days
51+
- parameters like stage, runoff and more related to rivers
52+
53+
EA (Environment Agency)
54+
- Hydrology
55+
- data of river network of UK
56+
- parameters flow and ground water stage
57+
58+
NWS (NOAA National Weather Service)
59+
- Observation
60+
- recent observations (last week) of US weather stations
61+
- currently the list of stations is not completely right as we use a diverging source!
62+
Eaufrance
63+
- Hubeau
64+
- data of river network of France (continental)
65+
- parameters flow and stage of rivers of last 30 days
66+
67+
Geosphere (Geosphere Austria, formerly Central Institution for Meteorology and Geodynamics)
68+
- Observation
69+
- historical meteorological data of Austrian stations
70+
71+
IMGW (Institute of Meteorology and Water Management)
72+
- Meteorology
73+
- meteorological data of polish weather stations
74+
- daily and monthly summaries
75+
- Hydrology
76+
- hydrological data of polish river stations
77+
- daily and monthly summaries

0 commit comments

Comments
 (0)