Add Fetcher for Norway (#70)

* Add fetcher for Norway

* Declare more columns as numeric

* Formatting

* Add unit tests

* Add Norwary fetcher to docs

* Change class init to accept api_token. Helps fixing test.

* Fix data loading in test

* Added support for more variables

* Add hourly/instant resolution

* Formatting

Author: kratzert

docs/api.rst

@@ -15,6 +15,7 @@ API Reference
    fetchers/czech
    fetchers/france
    fetchers/japan
+   fetchers/norway
    fetchers/poland
    fetchers/portugal
    fetchers/slovenia

docs/fetchers/norway.rst

@@ -0,0 +1,5 @@
+Norway Fetcher
+==============
+
+.. automodule:: rivretrieve.norway
+   :members:

examples/test_norway_fetcher.py

@@ -0,0 +1,57 @@
+import logging
+
+import matplotlib.pyplot as plt
+
+from rivretrieve import NorwayFetcher, constants
+
+logging.basicConfig(level=logging.INFO)
+
+# Replace with a valid Norwegian gauge ID, e.g., "12.210.0"
+gauge_ids = [
+    "1.200.0",
+]
+variables = [
+    constants.DISCHARGE_INSTANT,
+    constants.STAGE_INSTANT,
+    constants.WATER_TEMPERATURE_INSTANT,
+]
+
+fetcher = NorwayFetcher()
+
+for variable in variables:
+    plt.figure(figsize=(12, 6))
+    has_data = False
+    for gauge_id in gauge_ids:
+        print(f"Fetching {variable} for {gauge_id}...")
+        # Fetching last 5 years for testing
+        data = fetcher.get_data(gauge_id=gauge_id, variable=variable, start_date="2020-01-01", end_date="2021-12-31")
+        if not data.empty:
+            print(f"Data for {gauge_id} ({variable}):")
+            print(data.head())
+            print(f"Time series from {data.index.min()} to {data.index.max()}")
+            plt.plot(
+                data.index,
+                data[variable],
+                label=f"{gauge_id} - {variable}",
+                marker=".",
+                linestyle="-",
+            )
+            plt.xlim(data.index.min(), data.index.max())
+            has_data = True
+        else:
+            print(f"No data found for {gauge_id} ({variable})")
+
+    if has_data:
+        plt.xlabel(constants.TIME_INDEX)
+        plt.ylabel(variable)
+        plt.title(f"Norway River Data ({gauge_ids[0]})")
+        plt.legend()
+        plt.grid(True)
+        plt.tight_layout()
+        plot_path = f"norway_{variable}_plot.png"
+        plt.savefig(plot_path)
+        print(f"Plot saved to {plot_path}")
+    else:
+        print(f"No data to plot for {variable}.")
+
+print("Test finished.")

rivretrieve/__init__.py

@@ -8,6 +8,7 @@
 from .czech import CzechFetcher
 from .france import FranceFetcher
 from .japan import JapanFetcher
+from .norway import NorwayFetcher
 from .poland import PolandFetcher
 from .portugal import PortugalFetcher
 from .slovenia import SloveniaFetcher

rivretrieve/cached_site_data/norway_sites.csv

@@ -22,6 +22,7 @@
 
 # List of temporal resolutions.
 DAILY = "daily"
+HOURLY = "hourly"
 INSTANTANEOUS = "instantaneous"
 
 # List of temporal aggregrations.
@@ -36,16 +37,20 @@
 DISCHARGE_DAILY_MEAN = f"{DISCHARGE}_{DAILY}_{_MEAN}"
 DISCHARGE_DAILY_MAX = f"{DISCHARGE}_{DAILY}_{_MAX}"
 DISCHARGE_DAILY_MIN = f"{DISCHARGE}_{DAILY}_{_MIN}"
+DISCHARGE_HOURLY_MEAN = f"{DISCHARGE}_{HOURLY}_{_MEAN}"
 DISCHARGE_INSTANT = f"{DISCHARGE}_{INSTANTANEOUS}"
 
 # Stage.
 STAGE_DAILY_MEAN = f"{STAGE}_{DAILY}_{_MEAN}"
 STAGE_DAILY_MAX = f"{STAGE}_{DAILY}_{_MAX}"
 STAGE_DAILY_MIN = f"{STAGE}_{DAILY}_{_MIN}"
+STAGE_HOURLY_MEAN = f"{STAGE}_{HOURLY}_{_MEAN}"
 STAGE_INSTANT = f"{STAGE}_{INSTANTANEOUS}"
 
 # Water temperature.
 WATER_TEMPERATURE_DAILY_MEAN = f"{_WATER_TEMPERATURE}_{DAILY}_{_MEAN}"
+WATER_TEMPERATURE_HOURLY_MEAN = f"{_WATER_TEMPERATURE}_{HOURLY}_{_MEAN}"
+WATER_TEMPERATURE_INSTANT = f"{_WATER_TEMPERATURE}_{INSTANTANEOUS}"
 
 # Precipitation
 CATCHMENT_PRECIPITATION_DAILY_SUM = f"{_CATCHMENT_PRECIPITATION}_{DAILY}_{_SUM}"