Ecoulement des cours d'eau

cl_hubeau/watercourses_flow/__init__.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+from .watercourses_flow_scraper import WatercoursesFlowSession
+from .utils import get_all_stations, get_all_observations
+
+
+__all__ = [
+    "get_all_stations",
+    "get_all_observations",
+    "WatercoursesFlowSession",
+]

cl_hubeau/watercourses_flow/utils.py

@@ -0,0 +1,189 @@
+import geopandas as gpd
+import pandas as pd
+from tqdm import tqdm
+from datetime import date, datetime
+from itertools import product
+
+from cl_hubeau.watercourses_flow.watercourses_flow_scraper import (
+    WatercoursesFlowSession,
+)
+from cl_hubeau import _config
+from cl_hubeau.utils import get_departements, prepare_kwargs_loops
+
+
+def get_all_stations(**kwargs) -> gpd.GeoDataFrame:
+    """
+    Retrieve all stations from France.
+
+    Parameters
+    ----------
+    **kwargs :
+        kwargs passed to WatercoursesFlowSession.get_stations (hence mostly intended
+        for hub'eau API's arguments). Do not use `format` or `code_departement`
+        as they are set by the current function.
+
+    Returns
+    -------
+    results : gpd.GeoDataFrame
+        GeoDataFrame of stations
+
+    """
+
+    with WatercoursesFlowSession() as session:
+
+        deps = get_departements()
+        results = [
+            session.get_stations(code_departement=dep, format="geojson", **kwargs)
+            for dep in tqdm(
+                deps,
+                desc="querying dep/dep",
+                leave=_config["TQDM_LEAVE"],
+                position=tqdm._get_free_pos(),
+            )
+        ]
+    results = [x.dropna(axis=1, how="all") for x in results if not x.empty]
+    results = gpd.pd.concat(results, ignore_index=True)
+    try:
+        results["code_station"]
+        results = results.drop_duplicates("code_station")
+    except KeyError:
+        pass
+    return results
+
+
+def get_all_observations(**kwargs) -> gpd.GeoDataFrame:
+    """
+    Retrieve all observsations from France.
+
+    Parameters
+    ----------
+    **kwargs :
+        kwargs passed to WatercoursesFlowSession.get_observations (hence mostly intended
+        for hub'eau API's arguments). Do not use `format` or `code_departement`
+        as they are set by the current function.
+
+    Returns
+    -------
+    results : gpd.GeoDataFrame
+        GeoDataFrame of observations
+    """
+
+    deps = get_departements()
+
+    # Set a loop for yearly querying as dataset are big
+    start_auto_determination = False
+    if "date_observation_min" not in kwargs:
+        start_auto_determination = True
+        kwargs["date_observation_min"] = "1960-01-01"
+    if "date_observation_max" not in kwargs:
+        kwargs["date_observation_max"] = date.today().strftime("%Y-%m-%d")
+
+    # ranges = pd.date_range(
+    #     start=datetime.strptime(kwargs.pop("date_observation_min"), "%Y-%m-%d").date(),
+    #     end=datetime.strptime(kwargs.pop("date_observation_max"), "%Y-%m-%d").date(),
+    # )
+    # dates = pd.Series(ranges).to_frame("date")
+    # dates["year"] = dates["date"].dt.year
+    # dates = dates.groupby("year")["date"].agg(["min", "max"])
+    # for d in "min", "max":
+    #     dates[d] = dates[d].dt.strftime("%Y-%m-%d")
+    # if start_auto_determination:
+    #     dates = pd.concat(
+    #         [
+    #             dates,
+    #             pd.DataFrame([{"min": "1900-01-01", "max": "2015-12-31"}]),
+    #         ],
+    #         ignore_index=False,
+    #     ).sort_index()
+
+    # args = list(product(deps, dates.values.tolist()))
+
+    # with WatercoursesFlowSession() as session:
+
+    #     results = [
+    #         session.get_observations(
+    #             format="geojson",
+    #             date_observation_min=date_min,
+    #             date_observation_max=date_max,
+    #             **{"code_departement": chunk},
+    #             **kwargs,
+    #         )
+    #         for chunk, (date_min, date_max) in tqdm(
+    #             args,
+    #             desc="querying station/station and year/year",
+    #             leave=_config["TQDM_LEAVE"],
+    #             position=tqdm._get_free_pos(),
+    #         )
+    #     ]
+
+    desc = "querying year/year" + (" & dep/dep" if "code_departement" in kwargs else "")
+
+    kwargs_loop = prepare_kwargs_loops(
+        "date_observation_min",
+        "date_observation_max",
+        kwargs,
+        start_auto_determination,
+    )
+
+    with WatercoursesFlowSession() as session:
+
+        results = [
+            session.get_observations(
+                format="geojson",
+                **kwargs,
+                **kw_loop,
+            )
+            for kw_loop in tqdm(
+                kwargs_loop,
+                desc=desc,
+                leave=_config["TQDM_LEAVE"],
+                position=tqdm._get_free_pos(),
+            )
+        ]
+
+    results = [x.dropna(axis=1, how="all") for x in results if not x.empty]
+    results = pd.concat(results, ignore_index=True)
+    return results
+
+
+def get_all_campagnes(**kwargs) -> gpd.GeoDataFrame:
+    """
+    Retrieve all campagnes from France.
+
+    Parameters
+    ----------
+    **kwargs :
+        kwargs passed to WatercoursesFlowSession.get_campagnes (hence mostly intended
+        for hub'eau API's arguments). Do not use `code_departement`
+        as they are set by the current function.
+
+    Returns
+    -------
+    results : gpd.GeoDataFrame
+        GeoDataFrame of campagnes
+    """
+
+    with WatercoursesFlowSession() as session:
+        try:
+            results = session.get_campagnes(**kwargs)
+        except ValueError:
+            # If request is too big
+            deps = get_departements()
+            results = [
+                session.get_campagnes(code_departement=dep, **kwargs)
+                for dep in tqdm(
+                    deps,
+                    desc="querying dep/dep",
+                    leave=_config["TQDM_LEAVE"],
+                    position=tqdm._get_free_pos(),
+                )
+            ]
+            results = [x.dropna(axis=1, how="all") for x in results if not x.empty]
+            results = gpd.pd.concat(results, ignore_index=True)
+        return results
+
+
+# if __name__ == "__main__":
+#     # print(get_all_stations())
+#     # print(get_all_observations())
+#     print(get_all_campagnes())