tide.stations package

Submodules

tide.stations.cache_wrapper module

Module permettant de gérer une cache pour les données des stations de marées.

Ce module contient les fonctions suivantes qui permettent de gérer une cache pour les données des stations de marées.

tide.stations.cache_wrapper.cache_result(ttl=86400)

Décorateur pour mettre en cache le résultat d’une fonction.

Paramètres:

ttl (int) – Durée de vie du cache en secondes.

Type renvoyé:

Callable

tide.stations.cache_wrapper.clear_cache()

Fonction pour vider le cache.

tide.stations.cache_wrapper.init_cache(cache_path)

Fonction pour initialiser le cache.

Paramètres:

cache_path (Path) – Chemin du cache.

Type renvoyé:

None

tide.stations.exception_stations module

Module pour les exceptions des stations.

Ce module contient la classe StationsError pour les erreurs des stations.

exception tide.stations.exception_stations.StationsError(message, error, status_code)

Bases : Exception

Classe pour les erreurs des stations.

Paramètres:

• message (str) – Message de l’erreur.

• error (str) – Erreur de l’erreur.

• status_code (int) – Code de statut de l’erreur.

error: str

Erreur de l’erreur.

message: str

Message de l’erreur.

status_code: int

Code de statut de l’erreur.

tide.stations.factory_stations module

Module de gestion de la factory de stations.

Ce module contient la fonction factory qui permet de récupérer la factory de stations en fonction du type d’endpoint.

tide.stations.factory_stations.get_stations_factory(enpoint_type)

Récupère la factory de stations en fonction du type d’endpoint.

Paramètres:

enpoint_type (EndpointTypeProtocol) – Type d’endpoint.

Renvoie:

Factory de stations

Type renvoyé:

type[StationsHandlerABC]

tide.stations.stations_abc module

Module ABC récupérer des données des stations de marée.

Ce module contient la classe abstraite StationsHandlerABC qui définit les méthodes pour récupérer les données stations de marée.

class tide.stations.stations_abc.StationsHandlerABC(api, ttl, cache_path)

Bases : ABC

Classe abstraite pour récupérer des données stations de marée.

static _create_geometry(stations)

Crée une liste de points à partir des données des stations.

Paramètres:

stations (Collection[dict]) – Liste des stations.

Renvoie:

Liste des points.

Type renvoyé:

list[Point]

static _create_index_map(filter_time_series)

Crée une carte d’index pour les séries temporelles.

Paramètres:

filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles en ordre de priorité.

Renvoie:

Carte d’index pour les séries temporelles.

Type renvoyé:

dict[TimeSeriesProtocol, int]

abstractmethod static _filter_stations(stations, filter_time_series, excluded_stations)

Filtre les stations en fonction des séries temporelles.

Paramètres:

• stations (Collection[dict]) – Liste des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

Renvoie:

Liste des stations filtrées.

Type renvoyé:

list[dict]

abstractmethod static _get_event_date(event)

Récupère la date de l’événement.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Date de l’événement.

Type renvoyé:

datetime

abstractmethod static _get_qc_flag(event)

Récupère le type du flag de qualité.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Type du flag de qualité.

Type renvoyé:

str

abstractmethod static _get_time_series(station, index_map)

Récupère les séries temporelles de la station.

Paramètres:

• station (dict) – Données de la station.

• index_map (dict[str, int] | None) – Carte d’index pour les séries temporelles.

Renvoie:

Liste des séries temporelles.

Type renvoyé:

list[str]

static filter_wlo_qc_flag(data_dataframe, time_serie_code, wlo_qc_flag_filter=None)

Filtre les données de la série temporelle WLO en fonction des flags de qualité.

Paramètres:

• data_dataframe (pd.DataFrame) – Données des séries temporelles sous forme de DataFrame.

• time_serie_code (TimeSeriesProtocol) – e code de la série temporelle des données.

• wlo_qc_flag_filter (Collection[str] | None) – Liste des flags de qualité à filtrer pour la série temporelle WLO.

Renvoie:

Données des séries temporelles sous forme de DataFrame.

Type renvoyé:

pd.DataFrame

_create_attributes(stations, index_map, station_name_key)

Crée une liste d’attributs pour les stations.

Paramètres:

• stations (Collection[dict]) – Liste des stations.

• index_map (dict[str, int] | None) – Carte d’index pour les séries temporelles.

• station_name_key (str) – Clé du nom de la station.

Renvoie:

Liste des attributs.

Type renvoyé:

list[dict]

_fetch_is_tidal_station(sation_id, api, column_name)

Récupère l’information si la station est une station de marée.

Paramètres:

• sation_id (str) – dentifiant de la station.

• api (str) – Type de l’API.

• column_name (str) – Nom de la colonne.

Renvoie:

True si la station est une station de marée, False sinon.

Type renvoyé:

bool | None

_get_stations_geodataframe(stations, filter_time_series, excluded_stations, station_name_key)

Récupère les données des stations sous forme de GeoDataFrame.

Paramètres:

• stations (Collection[dict]) – Liste des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• station_name_key (str) – Clé du nom de la station.

Renvoie:

Données des stations sous forme de GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame[schema.StationsSchema]

_get_stations_tidal_info(stations, api, column_name)

Récupère les informations sur les stations de marée.

Paramètres:

• stations (list[dict]) – Liste des stations.

• api (str) – Type de l’API.

• column_name (str) – Nom de la colonne.

Renvoie:

Liste des informations sur les stations de marée.

Type renvoyé:

list[bool | None]

create_data_list(data, time_serie_code)

Crée une liste de données pour les séries temporelles.

Paramètres:

• data (Collection[dict]) – Données de la série temporelle.

• time_serie_code (TimeSeriesProtocol) – Le code de la série temporelle.

Renvoie:

Liste des données.

Type renvoyé:

list[dict]

get_station_id_by_code(station_code)

Récupère l’identifiant d’une station en fonction de son code.

Paramètres:

station_code (str) – Code de la station.

Renvoie:

Identifiant de la station.

Type renvoyé:

str | None

abstractmethod get_stations_geodataframe(filter_time_series, excluded_stations=None, station_name_key='officialName')

Récupère les données des stations sous forme de GeoDataFrame.

Paramètres:

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• station_name_key (str) – Clé du nom de la station.

Renvoie:

Données des stations sous forme de GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame[schema.StationsSchema]

get_stations_geodataframe_from_codes(station_codes, filter_time_series)

Récupère les données d’une station sous forme de GeoDataFrame.

Paramètres:

• station_codes (Collection[str]) – Liste des codes des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

Renvoie:

Données de la station sous forme de GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame[schema.StationsSchema]

get_time_series_dataframe(station, from_time, to_time, time_serie_code, time_delta=datetime.timedelta(days=7), datetime_sorted=True, wlo_qc_flag_filter=None, **kwargs)

Récupère les séries temporelles sous forme de DataFrame.

Paramètres:

• station (str) – Code de la station.

• from_time (str) – La date de début en format ISO 8601 (ex: 2019-11-13T19:18:00Z).

• to_time (str) – La date de fin en format ISO 8601 (ex: 2019-11-13T19:18:00Z).

• time_serie_code (TimeSeriesProtocol) – Le code de la série temporelle désirée.

• time_delta (timedelta) – L’intervalle de temps maximale pour chaque requête.

• datetime_sorted (bool) – Si les données doivent être triées par date.

• wlo_qc_flag_filter (Collection[str] | None) – Liste des flags de qualité à filtrer pour la série temporelle WLO.

Renvoie:

Données des séries temporelles sous forme de DataFrame.

Type renvoyé:

pd.DataFrame[schema.WaterLevelSerieDataSchema]

property stations: list[dict]

Récupère la liste des stations.

Renvoie:

Liste des stations.

Type renvoyé:

list[dict]

tide.stations.stations_models module

Moddule pour définir les types et les protocoles des modèles des stations.

Ce module contient les types et les protocoles nécessaires pour définir les modèles des stations.

class tide.stations.stations_models.EndpointTypeProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les types des endpoints.

PRIVATE_DEV: str = 'EndpointPrivateDev'

Endpoint privé de développement.

PRIVATE_PROD: str = 'EndpointPrivateProd'

Endpoint privé de production.

PUBLIC: str = 'EndpointPublic'

Endpoint public.

_is_protocol = True

class tide.stations.stations_models.IWLSapiProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les méthode des différent types d’API.

get_all_stations(**kwargs)

Méthode pour récupérer toutes les stations.

Renvoie:

Réponse de la requête.

Type renvoyé:

ResponseProtocol

get_metadata_station(station)

Méthode pour récupérer les métadonnées d’une station.

Paramètres:

station (str) – Code de la station.

Renvoie:

Réponse de la requête.

Type renvoyé:

ResponseProtocol

get_time_serie_block_data(station, from_time, to_time, time_serie_code, time_delta=datetime.timedelta(days=7), datetime_sorted=True, **kwargs)

Méthode pour récupérer les données d’une série temporelle.

Paramètres:

• station (str) – Code de la station.

• from_time (str) – Date de début.

• to_time (str) – Date de fin.

• time_serie_code (Optional[TimeSeriesProtocol]) – Code de la série temporelle.

• time_delta (timedelta) – Intervalle de temps.

• datetime_sorted (bool) – Indique si les données sont triées par date.

Renvoie:

Réponse de la requête.

Type renvoyé:

ResponseProtocol

get_time_series_station(station)

Méthode pour récupérer les séries temporelles d’une station.

Paramètres:

station (str) – Code de la station.

Renvoie:

Réponse de la requête.

Type renvoyé:

ResponseProtocol

_is_protocol = True

class tide.stations.stations_models.ResponseProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les types des réponses des API.

_is_protocol = True

data: list[dict]

Données de la réponse.

error: str

Erreur de la réponse.

is_ok: bool

Indique si la réponse est valide.

message: str

Message de la réponse.

status_code: int

Code de statut de la réponse.

class tide.stations.stations_models.TimeSeriesProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les types des séries temporelles.

from_str(value)

Méthode pour convertir une chaîne de caractères en série temporelle.

Paramètres:

value (str) – Chaîne de caractères.

Renvoie:

Série temporelle.

Type renvoyé:

TimeSeriesProtocol

WLF: str = 'wlf'

Water Level Forecast.

WLF_SPINE: str = 'wlf-spine'

Water Level Forecast Spine.

WLF_VTG: str = 'wlf-vtg'

Water Level Forecast VTG.

WLO: str = 'wlo'

Water Level Observed.

WLP: str = 'wlp'

Water Level Prediction.

_is_protocol = True

tide.stations.stations_private module

Module pour récupérer des données des stations de l’API privé.

Ce module contient la classe StationsHandlerPrivate qui permet de récupérer les données des stations de l’API privé.

class tide.stations.stations_private.StationsHandlerPrivate(api, ttl=86400, cache_path=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/chs-csb-processing/checkouts/latest/src/tide/stations/cache'))

Bases : StationsHandlerABC

Classe récupérer des données stations de l’API privé.

static _filter_stations(stations, filter_time_series, excluded_stations)

Filtre les stations en fonction des séries temporelles.

Paramètres:

• stations (Collection[dict]) – Liste des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

Renvoie:

Liste des stations filtrées.

Type renvoyé:

list[dict]

static _get_event_date(event)

Récupère la date de l’événement.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Date de l’événement.

Type renvoyé:

datetime

static _get_qc_flag(event)

Récupère le type du flag de qualité.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Type du flag de qualité.

Type renvoyé:

str

static _get_time_series(station, index_map)

Récupère les séries temporelles de la station.

Paramètres:

• station (dict) – Données de la station.

• index_map (dict[TimeSeriesProtocol, int] | None) – Carte d’index pour les séries temporelles.

Renvoie:

Liste des séries temporelles.

Type renvoyé:

list[str]

_fetch_time_series(station_id, api)

Récupère les séries temporelles de la station.

Paramètres:

• station_id (str) – Identifiant de la station.

• api (str) – Type d’API.

Renvoie:

Données de la station avec les séries temporelles.

Type renvoyé:

dict

_get_stations_time_series(stations, api)

Récupère les séries temporelles des stations.

Paramètres:

• stations (list[dict]) – Liste des stations.

• api (str) – ype d’API.

Renvoie:

Liste des stations avec les séries temporelles.

Type renvoyé:

list[dict]

_get_stations_with_metadata(api='private', column_name_tidal='tidal')

Récupère les données des stations avec les séries temporelles.

Paramètres:

• api (str) – Nom de l’API.

• column_name_tidal (str) – Nom de la colonne pour les informations de marée.

Renvoie:

Données des stations avec les séries temporelles.

Type renvoyé:

list[dict]

get_stations_geodataframe(filter_time_series, excluded_stations=None, station_name_key='name')

Récupère les données des stations sous forme de GeoDataFrame.

Paramètres:

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• station_name_key (str) – Clé du nom de la station.

Renvoie:

Données des stations sous forme de GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame

tide.stations.stations_public module

Module pour récupérer des données des stations de l’API public.

Ce module contient la classe StationsHandlerPublic qui permet de récupérer des données des stations de l’API public.

class tide.stations.stations_public.StationsHandlerPublic(api, ttl=86400, cache_path=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/chs-csb-processing/checkouts/latest/src/tide/stations/cache'))

Bases : StationsHandlerABC

Classe récupérer des données des stations de l’API public.

static _filter_stations(stations, filter_time_series, excluded_stations)

Filtre les stations en fonction des séries temporelles.

Paramètres:

• stations (Collection[dict]) – Liste des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

Renvoie:

Liste des stations filtrées.

Type renvoyé:

list[dict]

static _get_event_date(event)

Récupère la date de l’événement.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Date de l’événement.

Type renvoyé:

datetime

static _get_qc_flag(event)

Récupère le type du flag de qualité.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Type du flag de qualité.

Type renvoyé:

str

static _get_time_series(station, index_map)

Récupère les séries temporelles de la station.

Paramètres:

• station (dict) – Données de la station.

• index_map (dict[TimeSeriesProtocol, int] | None) – Carte d’index pour les séries temporelles.

Renvoie:

Liste des séries temporelles.

Type renvoyé:

list[str]

_get_stations_with_metadata(api='public', column_name_tidal='isTidal')

Récupère les données des stations avec les séries temporelles.

Paramètres:

• api (str) – Nom de l’API.

• column_name_tidal (str) – Nom de la colonne pour les informations sur les marées.

Renvoie:

Données des stations avec les séries temporelles.

Type renvoyé:

list[dict]

get_stations_geodataframe(filter_time_series, excluded_stations=None, station_name_key='officialName')

Récupère les données des stations sous forme de GeoDataFrame.

Paramètres:

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• station_name_key (Optional[str]) – Clé du nom de la station.

Renvoie:

Données des stations sous forme de GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame

Module contents

Ce package contient les classes et fonctions permettant de gérer les stations marégraphiques.

exception tide.stations.StationsError(message, error, status_code)

Bases : Exception

Classe pour les erreurs des stations.

Paramètres:

• message (str) – Message de l’erreur.

• error (str) – Erreur de l’erreur.

• status_code (int) – Code de statut de l’erreur.

error: str

Erreur de l’erreur.

message: str

Message de l’erreur.

status_code: int

Code de statut de l’erreur.

class tide.stations.EndpointTypeProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les types des endpoints.

PRIVATE_DEV: str = 'EndpointPrivateDev'

Endpoint privé de développement.

PRIVATE_PROD: str = 'EndpointPrivateProd'

Endpoint privé de production.

PUBLIC: str = 'EndpointPublic'

Endpoint public.

_is_protocol = True

class tide.stations.IWLSapiProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les méthode des différent types d’API.

get_all_stations(**kwargs)

Méthode pour récupérer toutes les stations.

Renvoie:

Réponse de la requête.

Type renvoyé:

ResponseProtocol

get_metadata_station(station)

Méthode pour récupérer les métadonnées d’une station.

Paramètres:

station (str) – Code de la station.

Renvoie:

Réponse de la requête.

Type renvoyé:

ResponseProtocol

get_time_serie_block_data(station, from_time, to_time, time_serie_code, time_delta=datetime.timedelta(days=7), datetime_sorted=True, **kwargs)

Méthode pour récupérer les données d’une série temporelle.

Paramètres:

• station (str) – Code de la station.

• from_time (str) – Date de début.

• to_time (str) – Date de fin.

• time_serie_code (Optional[TimeSeriesProtocol]) – Code de la série temporelle.

• time_delta (timedelta) – Intervalle de temps.

• datetime_sorted (bool) – Indique si les données sont triées par date.

Renvoie:

Réponse de la requête.

Type renvoyé:

ResponseProtocol

get_time_series_station(station)

Méthode pour récupérer les séries temporelles d’une station.

Paramètres:

station (str) – Code de la station.

Renvoie:

Réponse de la requête.

Type renvoyé:

ResponseProtocol

_is_protocol = True

class tide.stations.StationsHandlerABC(api, ttl, cache_path)

Bases : ABC

Classe abstraite pour récupérer des données stations de marée.

static _create_geometry(stations)

Crée une liste de points à partir des données des stations.

Paramètres:

stations (Collection[dict]) – Liste des stations.

Renvoie:

Liste des points.

Type renvoyé:

list[Point]

static _create_index_map(filter_time_series)

Crée une carte d’index pour les séries temporelles.

Paramètres:

filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles en ordre de priorité.

Renvoie:

Carte d’index pour les séries temporelles.

Type renvoyé:

dict[TimeSeriesProtocol, int]

abstractmethod static _filter_stations(stations, filter_time_series, excluded_stations)

Filtre les stations en fonction des séries temporelles.

Paramètres:

• stations (Collection[dict]) – Liste des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

Renvoie:

Liste des stations filtrées.

Type renvoyé:

list[dict]

abstractmethod static _get_event_date(event)

Récupère la date de l’événement.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Date de l’événement.

Type renvoyé:

datetime

abstractmethod static _get_qc_flag(event)

Récupère le type du flag de qualité.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Type du flag de qualité.

Type renvoyé:

str

abstractmethod static _get_time_series(station, index_map)

Récupère les séries temporelles de la station.

Paramètres:

• station (dict) – Données de la station.

• index_map (dict[str, int] | None) – Carte d’index pour les séries temporelles.

Renvoie:

Liste des séries temporelles.

Type renvoyé:

list[str]

static filter_wlo_qc_flag(data_dataframe, time_serie_code, wlo_qc_flag_filter=None)

Filtre les données de la série temporelle WLO en fonction des flags de qualité.

Paramètres:

• data_dataframe (pd.DataFrame) – Données des séries temporelles sous forme de DataFrame.

• time_serie_code (TimeSeriesProtocol) – e code de la série temporelle des données.

• wlo_qc_flag_filter (Collection[str] | None) – Liste des flags de qualité à filtrer pour la série temporelle WLO.

Renvoie:

Données des séries temporelles sous forme de DataFrame.

Type renvoyé:

pd.DataFrame

_create_attributes(stations, index_map, station_name_key)

Crée une liste d’attributs pour les stations.

Paramètres:

• stations (Collection[dict]) – Liste des stations.

• index_map (dict[str, int] | None) – Carte d’index pour les séries temporelles.

• station_name_key (str) – Clé du nom de la station.

Renvoie:

Liste des attributs.

Type renvoyé:

list[dict]

_fetch_is_tidal_station(sation_id, api, column_name)

Récupère l’information si la station est une station de marée.

Paramètres:

• sation_id (str) – dentifiant de la station.

• api (str) – Type de l’API.

• column_name (str) – Nom de la colonne.

Renvoie:

True si la station est une station de marée, False sinon.

Type renvoyé:

bool | None

_get_stations_geodataframe(stations, filter_time_series, excluded_stations, station_name_key)

Récupère les données des stations sous forme de GeoDataFrame.

Paramètres:

• stations (Collection[dict]) – Liste des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• station_name_key (str) – Clé du nom de la station.

Renvoie:

Données des stations sous forme de GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame[schema.StationsSchema]

_get_stations_tidal_info(stations, api, column_name)

Récupère les informations sur les stations de marée.

Paramètres:

• stations (list[dict]) – Liste des stations.

• api (str) – Type de l’API.

• column_name (str) – Nom de la colonne.

Renvoie:

Liste des informations sur les stations de marée.

Type renvoyé:

list[bool | None]

create_data_list(data, time_serie_code)

Crée une liste de données pour les séries temporelles.

Paramètres:

• data (Collection[dict]) – Données de la série temporelle.

• time_serie_code (TimeSeriesProtocol) – Le code de la série temporelle.

Renvoie:

Liste des données.

Type renvoyé:

list[dict]

get_station_id_by_code(station_code)

Récupère l’identifiant d’une station en fonction de son code.

Paramètres:

station_code (str) – Code de la station.

Renvoie:

Identifiant de la station.

Type renvoyé:

str | None

abstractmethod get_stations_geodataframe(filter_time_series, excluded_stations=None, station_name_key='officialName')

Récupère les données des stations sous forme de GeoDataFrame.

Paramètres:

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• station_name_key (str) – Clé du nom de la station.

Renvoie:

Données des stations sous forme de GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame[schema.StationsSchema]

get_stations_geodataframe_from_codes(station_codes, filter_time_series)

Récupère les données d’une station sous forme de GeoDataFrame.

Paramètres:

• station_codes (Collection[str]) – Liste des codes des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

Renvoie:

Données de la station sous forme de GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame[schema.StationsSchema]

get_time_series_dataframe(station, from_time, to_time, time_serie_code, time_delta=datetime.timedelta(days=7), datetime_sorted=True, wlo_qc_flag_filter=None, **kwargs)

Récupère les séries temporelles sous forme de DataFrame.

Paramètres:

• station (str) – Code de la station.

• from_time (str) – La date de début en format ISO 8601 (ex: 2019-11-13T19:18:00Z).

• to_time (str) – La date de fin en format ISO 8601 (ex: 2019-11-13T19:18:00Z).

• time_serie_code (TimeSeriesProtocol) – Le code de la série temporelle désirée.

• time_delta (timedelta) – L’intervalle de temps maximale pour chaque requête.

• datetime_sorted (bool) – Si les données doivent être triées par date.

• wlo_qc_flag_filter (Collection[str] | None) – Liste des flags de qualité à filtrer pour la série temporelle WLO.

Renvoie:

Données des séries temporelles sous forme de DataFrame.

Type renvoyé:

pd.DataFrame[schema.WaterLevelSerieDataSchema]

property stations: list[dict]

Récupère la liste des stations.

Renvoie:

Liste des stations.

Type renvoyé:

list[dict]

class tide.stations.StationsHandlerPrivate(api, ttl=86400, cache_path=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/chs-csb-processing/checkouts/latest/src/tide/stations/cache'))

Bases : StationsHandlerABC

Classe récupérer des données stations de l’API privé.

static _filter_stations(stations, filter_time_series, excluded_stations)

Filtre les stations en fonction des séries temporelles.

Paramètres:

• stations (Collection[dict]) – Liste des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

Renvoie:

Liste des stations filtrées.

Type renvoyé:

list[dict]

static _get_event_date(event)

Récupère la date de l’événement.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Date de l’événement.

Type renvoyé:

datetime

static _get_qc_flag(event)

Récupère le type du flag de qualité.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Type du flag de qualité.

Type renvoyé:

str

static _get_time_series(station, index_map)

Récupère les séries temporelles de la station.

Paramètres:

• station (dict) – Données de la station.

• index_map (dict[TimeSeriesProtocol, int] | None) – Carte d’index pour les séries temporelles.

Renvoie:

Liste des séries temporelles.

Type renvoyé:

list[str]

_fetch_time_series(station_id, api)

Récupère les séries temporelles de la station.

Paramètres:

• station_id (str) – Identifiant de la station.

• api (str) – Type d’API.

Renvoie:

Données de la station avec les séries temporelles.

Type renvoyé:

dict

_get_stations_time_series(stations, api)

Récupère les séries temporelles des stations.

Paramètres:

• stations (list[dict]) – Liste des stations.

• api (str) – ype d’API.

Renvoie:

Liste des stations avec les séries temporelles.

Type renvoyé:

list[dict]

_get_stations_with_metadata(api='private', column_name_tidal='tidal')

Récupère les données des stations avec les séries temporelles.

Paramètres:

• api (str) – Nom de l’API.

• column_name_tidal (str) – Nom de la colonne pour les informations de marée.

Renvoie:

Données des stations avec les séries temporelles.

Type renvoyé:

list[dict]

get_stations_geodataframe(filter_time_series, excluded_stations=None, station_name_key='name')

Récupère les données des stations sous forme de GeoDataFrame.

Paramètres:

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• station_name_key (str) – Clé du nom de la station.

Renvoie:

Données des stations sous forme de GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame

class tide.stations.StationsHandlerPublic(api, ttl=86400, cache_path=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/chs-csb-processing/checkouts/latest/src/tide/stations/cache'))

Bases : StationsHandlerABC

Classe récupérer des données des stations de l’API public.

static _filter_stations(stations, filter_time_series, excluded_stations)

Filtre les stations en fonction des séries temporelles.

Paramètres:

• stations (Collection[dict]) – Liste des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

Renvoie:

Liste des stations filtrées.

Type renvoyé:

list[dict]

static _get_event_date(event)

Récupère la date de l’événement.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Date de l’événement.

Type renvoyé:

datetime

static _get_qc_flag(event)

Récupère le type du flag de qualité.

Paramètres:

event (dict) – Données de l’événement.

Renvoie:

Type du flag de qualité.

Type renvoyé:

str

static _get_time_series(station, index_map)

Récupère les séries temporelles de la station.

Paramètres:

• station (dict) – Données de la station.

• index_map (dict[TimeSeriesProtocol, int] | None) – Carte d’index pour les séries temporelles.

Renvoie:

Liste des séries temporelles.

Type renvoyé:

list[str]

_get_stations_with_metadata(api='public', column_name_tidal='isTidal')

Récupère les données des stations avec les séries temporelles.

Paramètres:

• api (str) – Nom de l’API.

• column_name_tidal (str) – Nom de la colonne pour les informations sur les marées.

Renvoie:

Données des stations avec les séries temporelles.

Type renvoyé:

list[dict]

get_stations_geodataframe(filter_time_series, excluded_stations=None, station_name_key='officialName')

Récupère les données des stations sous forme de GeoDataFrame.

Paramètres:

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• station_name_key (Optional[str]) – Clé du nom de la station.

Renvoie:

Données des stations sous forme de GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame

class tide.stations.TimeSeriesProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les types des séries temporelles.

from_str(value)

Méthode pour convertir une chaîne de caractères en série temporelle.

Paramètres:

value (str) – Chaîne de caractères.

Renvoie:

Série temporelle.

Type renvoyé:

TimeSeriesProtocol

WLF: str = 'wlf'

Water Level Forecast.

WLF_SPINE: str = 'wlf-spine'

Water Level Forecast Spine.

WLF_VTG: str = 'wlf-vtg'

Water Level Forecast VTG.

WLO: str = 'wlo'

Water Level Observed.

WLP: str = 'wlp'

Water Level Prediction.

_is_protocol = True

tide.stations.get_stations_factory(enpoint_type)

Récupère la factory de stations en fonction du type d’endpoint.

Paramètres:

enpoint_type (EndpointTypeProtocol) – Type d’endpoint.

Renvoie:

Factory de stations

Type renvoyé:

type[StationsHandlerABC]