WIP

CHANGELOG.rst

@@ -5,6 +5,8 @@ Development
 ***********
 
 - Add support for Python 3.13 and deprecate Python 3.9
+- [Breaking] Add new metadata model
+- Rename `parameter` to `parameters`
 
 0.97.0 (06.10.2024)
 *******************

README.rst

@@ -264,12 +264,13 @@ Library
     ...     ts_si_units=True  # convert values to SI units
     ... )
     >>> request = DwdObservationRequest(
-    ...    parameter="climate_summary",
-    ...    resolution="daily",
-    ...    start_date="1990-01-01",  # if not given timezone defaulted to UTC
-    ...    end_date="2020-01-01",  # if not given timezone defaulted to UTC
+    ...    parameters=[
+    ...       ("daily", "climate_summary", "precipitation_height"),
+    ...    ],
+    ...    start_date="2002-08-11",  # if not given timezone defaulted to UTC
+    ...    end_date="2002-08-13",  # if not given timezone defaulted to UTC
     ...    settings=settings
-    ... ).filter_by_station_id(station_id=(1048, 4411))
+    ... ).filter_by_station_id(station_id=(5779, ))
     >>> stations = request.df
     >>> stations.head()
     ┌────────────┬──────────────┬──────────────┬──────────┬───────────┬────────┬─────────────┬─────────┐
@@ -278,24 +279,20 @@ Library
     │ str        ┆ datetime[μs, ┆ datetime[μs, ┆ f64      ┆ f64       ┆ f64    ┆ str         ┆ str     │
     │            ┆ UTC]         ┆ UTC]         ┆          ┆           ┆        ┆             ┆         │
     ╞════════════╪══════════════╪══════════════╪══════════╪═══════════╪════════╪═════════════╪═════════╡
-    │ 01048      ┆ 1934-01-01   ┆ ...          ┆ 51.1278  ┆ 13.7543   ┆ 228.0  ┆ Dresden-Klo ┆ Sachsen │
-    │            ┆ 00:00:00 UTC ┆ 00:00:00 UTC ┆          ┆           ┆        ┆ tzsche      ┆         │
-    │ 04411      ┆ 1979-12-01   ┆ ...          ┆ 49.9195  ┆ 8.9672    ┆ 155.0  ┆ Schaafheim- ┆ Hessen  │
-    │            ┆ 00:00:00 UTC ┆ 00:00:00 UTC ┆          ┆           ┆        ┆ Schlierbach ┆         │
+    │ 05779      ┆ 1971-01-01   ┆ 2024-12-01   ┆ 50.7313  ┆ 13.7516   ┆ 877.0  ┆ Zinnwald-Ge ┆ Sachsen │
+    │            ┆ 00:00:00 UTC ┆ 00:00:00 UTC ┆          ┆           ┆        ┆ orgenfeld   ┆         │
     └────────────┴──────────────┴──────────────┴──────────┴───────────┴────────┴─────────────┴─────────┘
     >>> values = request.values.all().df
     >>> values.head()
-    ┌────────────┬─────────────────┬───────────────────┬─────────────────────────┬───────┬─────────┐
-    │ station_id ┆ dataset         ┆ parameter         ┆ date                    ┆ value ┆ quality │
-    │ ---        ┆ ---             ┆ ---               ┆ ---                     ┆ ---   ┆ ---     │
-    │ str        ┆ str             ┆ str               ┆ datetime[μs, UTC]       ┆ f64   ┆ f64     │
-    ╞════════════╪═════════════════╪═══════════════════╪═════════════════════════╪═══════╪═════════╡
-    │ 01048      ┆ climate_summary ┆ cloud_cover_total ┆ 1990-01-01 00:00:00 UTC ┆ 100.0 ┆ 10.0    │
-    │ 01048      ┆ climate_summary ┆ cloud_cover_total ┆ 1990-01-02 00:00:00 UTC ┆ 100.0 ┆ 10.0    │
-    │ 01048      ┆ climate_summary ┆ cloud_cover_total ┆ 1990-01-03 00:00:00 UTC ┆ 91.25 ┆ 10.0    │
-    │ 01048      ┆ climate_summary ┆ cloud_cover_total ┆ 1990-01-04 00:00:00 UTC ┆ 28.75 ┆ 10.0    │
-    │ 01048      ┆ climate_summary ┆ cloud_cover_total ┆ 1990-01-05 00:00:00 UTC ┆ 91.25 ┆ 10.0    │
-    └────────────┴─────────────────┴───────────────────┴─────────────────────────┴───────┴─────────┘
+    ┌────────────┬─────────────────┬──────────────────────┬─────────────────────────┬───────┬─────────┐
+    │ station_id ┆ dataset         ┆ parameter            ┆ date                    ┆ value ┆ quality │
+    │ ---        ┆ ---             ┆ ---                  ┆ ---                     ┆ ---   ┆ ---     │
+    │ str        ┆ str             ┆ str                  ┆ datetime[μs, UTC]       ┆ f64   ┆ f64     │
+    ╞════════════╪═════════════════╪══════════════════════╪═════════════════════════╪═══════╪═════════╡
+    │ 05779      ┆ climate_summary ┆ precipitation_height ┆ 2002-08-11 00:00:00 UTC ┆ 67.9  ┆ 10.0    │
+    │ 05779      ┆ climate_summary ┆ precipitation_height ┆ 2002-08-12 00:00:00 UTC ┆ 312.0 ┆ 10.0    │
+    │ 05779      ┆ climate_summary ┆ precipitation_height ┆ 2002-08-13 00:00:00 UTC ┆ 26.3  ┆ 10.0    │
+    └────────────┴─────────────────┴──────────────────────┴─────────────────────────┴───────┴─────────┘
 
 .. code-block:: python
 

benchmarks/interpolation.py

@@ -55,7 +55,7 @@ def request_weather_data(
     end_date: dt.datetime,
 ):
     stations = DwdObservationRequest(
-        parameter=parameter,
+        parameters=parameter,
         resolution="hourly",
         start_date=start_date,
         end_date=end_date,

benchmarks/interpolation_over_time.py

@@ -20,7 +20,7 @@
 
 def get_interpolated_df(parameter: str, start_date: datetime, end_date: datetime) -> pl.DataFrame:
     stations = DwdObservationRequest(
-        parameter=parameter,
+        parameters=parameter,
         resolution=DwdObservationResolution.HOURLY,
         start_date=start_date,
         end_date=end_date,
@@ -30,7 +30,7 @@ def get_interpolated_df(parameter: str, start_date: datetime, end_date: datetime
 
 def get_regular_df(parameter: str, start_date: datetime, end_date: datetime, exclude_stations: list) -> pl.DataFrame:
     stations = DwdObservationRequest(
-        parameter=parameter,
+        parameters=parameter,
         resolution=DwdObservationResolution.HOURLY,
         start_date=start_date,
         end_date=end_date,

benchmarks/interpolation_precipitation_difference.py

@@ -15,7 +15,7 @@
 
 def get_interpolated_df(start_date: datetime, end_date: datetime) -> pl.DataFrame:
     stations = DwdObservationRequest(
-        parameter=Parameter.PRECIPITATION_HEIGHT,
+        parameters=Parameter.PRECIPITATION_HEIGHT,
         resolution=DwdObservationResolution.DAILY,
         start_date=start_date,
         end_date=end_date,
@@ -25,7 +25,7 @@ def get_interpolated_df(start_date: datetime, end_date: datetime) -> pl.DataFram
 
 def get_regular_df(start_date: datetime, end_date: datetime, exclude_stations: list) -> pl.DataFrame:
     stations = DwdObservationRequest(
-        parameter=Parameter.PRECIPITATION_HEIGHT.name,
+        parameters=Parameter.PRECIPITATION_HEIGHT.name,
         resolution=DwdObservationResolution.DAILY,
         start_date=start_date,
         end_date=end_date,

benchmarks/summary_over_time.py

@@ -15,7 +15,7 @@
 
 def get_summarized_df(start_date: datetime, end_date: datetime, lat, lon) -> pl.DataFrame:
     stations = DwdObservationRequest(
-        parameter=Parameter.TEMPERATURE_AIR_MEAN_2M,
+        parameters=Parameter.TEMPERATURE_AIR_MEAN_2M,
         resolution=DwdObservationResolution.DAILY,
         start_date=start_date,
         end_date=end_date,
@@ -25,7 +25,7 @@ def get_summarized_df(start_date: datetime, end_date: datetime, lat, lon) -> pl.
 
 def get_regular_df(start_date: datetime, end_date: datetime, station_id) -> pl.DataFrame:
     stations = DwdObservationRequest(
-        parameter=Parameter.TEMPERATURE_AIR_MEAN_2M,
+        parameters=Parameter.TEMPERATURE_AIR_MEAN_2M,
         resolution=DwdObservationResolution.DAILY,
         start_date=start_date,
         end_date=end_date,

docs/data/coverage/dwd/road/minute_15.rst

@@ -16,8 +16,8 @@ Metadata
 Datasets
 ********
 
-Road_weather
-============
+Data
+====
 
 Metadata
 --------

docs/data/coverage/ea/hydrology/daily.rst

@@ -20,8 +20,8 @@ Metadata
 Datasets
 ********
 
-Daily
-=====
+Data
+====
 
 Metadata
 --------

docs/data/coverage/ea/hydrology/hour_6.rst

@@ -20,8 +20,8 @@ Metadata
 Datasets
 ********
 
-Hour_6
-======
+Data
+====
 
 Metadata
 --------

docs/data/coverage/ea/hydrology/minute_15.rst

@@ -20,8 +20,8 @@ Metadata
 Datasets
 ********
 
-Minute_15
-=========
+Data
+====
 
 Metadata
 --------

docs/data/coverage/eaufrance/hubeau/dynamic.rst

@@ -16,8 +16,8 @@ Metadata
 Datasets
 ********
 
-Dynamic
-=======
+Data
+====
 
 Metadata
 --------

docs/data/coverage/eccc/observation/annual.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Annual
-======
+Data
+====
 
 Metadata
 --------

docs/data/coverage/eccc/observation/daily.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Daily
-=====
+Data
+====
 
 Metadata
 --------

docs/data/coverage/eccc/observation/hourly.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Hourly
-======
+Data
+====
 
 Metadata
 --------

docs/data/coverage/eccc/observation/monthly.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Monthly
-=======
+Data
+====
 
 Metadata
 --------

docs/data/coverage/geosphere/observation/daily.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Daily
-=====
+Data
+====
 
 Metadata
 --------

docs/data/coverage/geosphere/observation/hourly.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Hourly
-======
+Data
+====
 
 Metadata
 --------
@@ -37,8 +37,6 @@ Metadata
    * - description
      - Historical hourly station observations of 2m air temperature and humidity for Germany
 
-.. _hourly dataset description:
-
 Parameters
 ----------
 

docs/data/coverage/geosphere/observation/minute_10.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Minute_10
-=========
+Data
+====
 
 Metadata
 --------
@@ -37,8 +37,6 @@ Metadata
    * - description
      - historical 10 minute data
 
-.. _minute_10 dataset description:
-
 Parameters
 ----------
 

docs/data/coverage/geosphere/observation/monthly.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Monthly
-=======
+Data
+====
 
 Metadata
 --------

docs/data/coverage/imgw/meteorology/monthly.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Climate
-=======
+Data
+====
 
 Metadata
 --------

docs/data/coverage/noaa/ghcn/daily.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Daily
-=====
+Data
+====
 
 Metadata
 --------

docs/data/coverage/noaa/ghcn/hourly.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Hourly
-======
+Data
+====
 
 Metadata
 --------

docs/data/coverage/nws/observation/hourly.rst

@@ -18,8 +18,8 @@ Metadata
 Datasets
 ********
 
-Hourly
-======
+Data
+====
 
 Metadata
 --------

docs/data/coverage/wsv/pegel/dynamic.rst

@@ -16,8 +16,8 @@ Metadata
 Datasets
 ********
 
-Dynamic
-=======
+Data
+====
 
 Metadata
 --------

examples/notebooks/wetterdienst_notebook.ipynb

@@ -171,7 +171,7 @@
    },
    "source": [
     "request = DwdObservationRequest(\n",
-    "    parameter=DwdObservationDataset.PRECIPITATION_MORE,\n",
+    "    parameters=DwdObservationDataset.PRECIPITATION_MORE,\n",
     "    resolution=DwdObservationResolution.DAILY,\n",
     "    period=DwdObservationPeriod.HISTORICAL,\n",
     ").all()\n",
@@ -259,7 +259,7 @@
    "source": [
     "values = (\n",
     "    DwdObservationRequest(\n",
-    "        parameter=DwdObservationDataset.PRECIPITATION_MORE,\n",
+    "        parameters=DwdObservationDataset.PRECIPITATION_MORE,\n",
     "        resolution=DwdObservationResolution.DAILY,\n",
     "        period=DwdObservationPeriod.HISTORICAL,\n",
     "    )\n",
@@ -297,7 +297,7 @@
     "]\n",
     "values = (\n",
     "    DwdObservationRequest(\n",
-    "        parameter=parameters,\n",
+    "        parameters=parameters,\n",
     "        resolution=DwdObservationResolution.DAILY,\n",
     "        period=DwdObservationPeriod.HISTORICAL,\n",
     "    )\n",
@@ -422,7 +422,7 @@
    },
    "source": [
     "request = DwdObservationRequest(\n",
-    "    parameter=DwdObservationParameter.DAILY.CLIMATE_SUMMARY.TEMPERATURE_AIR_MEAN_2M,\n",
+    "    parameters=DwdObservationParameter.DAILY.CLIMATE_SUMMARY.TEMPERATURE_AIR_MEAN_2M,\n",
     "    resolution=DwdObservationResolution.DAILY,\n",
     "    period=DwdObservationPeriod.HISTORICAL,\n",
     "    start_date=\"1930-01-01\",\n",