tide.time_serie package

Submodules

tide.time_serie.exception_time_serie module

Module contenant les exceptions pour les séries temporelles de données de marée.

Ce module contient les exceptions sont utilisées pour gérer les erreurs lors de la récupération des données de marée.

exception tide.time_serie.exception_time_serie.InterpolationValueError(from_time, to_time, time_serie)[source]

Bases : Exception

Exception pour les valeurs impossibles à interpoler.

Paramètres:

  • from_time (pd.Timestamp) – Date de début.

  • to_time (pd.Timestamp) – Date de fin.

  • time_serie (TimeSeriesProtocol) – Série temporelle.

from_time: Timestamp

Date de début.

time_serie: TimeSeriesProtocol

Série temporelle.

to_time: Timestamp

Date de fin.

exception tide.time_serie.exception_time_serie.NoWaterLevelDataError(station_id, from_time, to_time)[source]

Bases : Exception

Exception pour les erreurs de données de marée manquantes.

Paramètres:

  • station_id (str) – Code de la station.

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

  • to_time (str) – Date de fin.

from_time: str

Date de début.

station_id: str

Code de la station.

to_time: str

Date de fin.

exception tide.time_serie.exception_time_serie.WaterLevelDataGapError(station_id, gaps, max_time_gap)[source]

Bases : Exception

Exception pour les périodes de données manquantes.

Paramètres:

  • station_id (str) – Code de la station.

  • gaps (pd.DataFrame) – Périodes de données manquantes.

  • max_time_gap (str) – Limite permise pour les données

gaps: DataFrame

Périodes de données manquantes.

max_time_gap: str

Limite permise pour les données.

station_id: str

Code de la station.

tide.time_serie.exception_time_serie.get_data_gap_periods(gaps)[source]

Récupère les périodes de données manquantes.

Paramètres:

gaps (pd.DataFrame) – DataFrame contenant les périodes de données manquantes.

Renvoie:

Périodes de données manquantes.

Type renvoyé:

list[DataGapPeriod]

tide.time_serie.exception_time_serie.get_data_gaps_message(gaps)[source]

Journalise les périodes de données manquantes.

Paramètres:

gaps (pd.DataFrame) – Périodes de données manquantes.

Renvoie:

Journalisation des périodes de données manquantes.

Type renvoyé:

str

tide.time_serie.time_serie_dataframe module

Module pour la gestion des données de séries temporelles de marée.

Ce module contient les fonctions pour gérer les données de séries temporelles de marée.

tide.time_serie.time_serie_dataframe.add_metadata_to_time_serie_dataframe(wl_dataframe, station_id, stations_handler)[source]

Ajoute les métadonnées aux données de la série temporelle.

Paramètres:
Renvoie:

Données de la série temporelle avec les métadonnées.

Type renvoyé:

pd.DataFrame[schema.WaterLevelSerieDataWithMetaDataSchema]

tide.time_serie.time_serie_dataframe.add_nan_date_row(wl_dataframe, time)[source]

Ajoute une ligne de données avec une valeur de NaN à partir d’une date.

Paramètres:
Renvoie:

DataFrame contenant la ligne ajouter aux autres données.

Type renvoyé:

pd.DataFrame[schema.TimeSerieDataSchema]

tide.time_serie.time_serie_dataframe.check_for_missing_values_for_interpolation(values, wl_resampled)[source]

Vérifie la présence de valeurs manquantes et lève une exception si nécessaire.

Paramètres:

  • values (pd.Series) – Série de valeurs à vérifier.

  • wl_resampled (pd.DataFrame) – DataFrame contenant les données rééchantillonnées.

Lève:

InterpolationValueError – Si des valeurs manquantes sont détectées.

Type renvoyé:

None

tide.time_serie.time_serie_dataframe.clean_time_series_data(wl_dataframe, from_time, to_time)[source]

Nettoie les données de la série temporelle.

Paramètres:

  • wl_dataframe (pd.DataFrame[schema.WaterLevelSerieDataSchema]) – Données de la série temporelle.

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

  • to_time (str) – Date de fin.

Renvoie:

Données de la série temporelle nettoyées.

Type renvoyé:

pd.DataFrame[schema.TimeSerieDataSchema]

tide.time_serie.time_serie_dataframe.combine_water_level_data(wl_combined_dataframe, wl_data_dataframe, gaps_dataframe)[source]

Combine les données de niveau d’eau.

Paramètres:

  • wl_combined_dataframe (pd.DataFrame[schema.WaterLevelSerieDataSchema]) – DataFrame contenant les données de niveau d’eau combinées.

  • wl_data_dataframe (pd.DataFrame[schema.TimeSerieDataSchema]) – DataFrame contenant les données de niveau d’eau.

  • gaps_dataframe (pd.DataFrame[schema.TimeSerieDataSchema]) – DataFrame contenant les périodes de données manquantes.

Renvoie:

DataFrame contenant les données de niveau d’eau combinées.

Type renvoyé:

pd.DataFrame[schema.TimeSerieDataSchema]

tide.time_serie.time_serie_dataframe.create_nan_date_row(date_time)[source]

Crée une ligne de données avec une valeur de NaN pour une date donnée.

Paramètres:

date_time (str) – Date.

Renvoie:

Ligne de données.

Type renvoyé:

NanDateRow

tide.time_serie.time_serie_dataframe.cubic_spline_interpolation(index_time, values, wl_resampled)[source]

Interpole les données manquantes avec une spline cubique.

Paramètres:

  • index_time (pd.Index) – Index des données.

  • values (pd.Series) – Valeurs des données.

  • wl_resampled (pd.DataFrame) – DataFrame contenant les données rééchantillonnées.

Renvoie:

DataFrame contenant les données interpolées.

Type renvoyé:

pd.DataFrame

tide.time_serie.time_serie_dataframe.extend_non_nan_dataframe(non_nan_dataframe, first_row, last_row)[source]

Étend les lignes du DataFrame pour ajouter la première et la dernière date.

Paramètres:

  • non_nan_dataframe (pd.DataFrame) – DataFrame contenant les données non NaN.

  • first_row (pd.DataFrame) – Première ligne du DataFrame.

  • last_row (pd.DataFrame) – Dernière ligne du DataFrame.

Renvoie:

DataFrame contenant les données étendues.

Type renvoyé:

pd.DataFrame

tide.time_serie.time_serie_dataframe.extend_rows_to_deltatime(non_nan_dataframe, first_row, last_row)[source]

Étend les lignes du DataFrame pour ajouter la première et la dernière date.

Paramètres:

  • non_nan_dataframe (pd.DataFrame) – DataFrame contenant les données non NaN.

  • first_row (pd.DataFrame) – Première ligne du DataFrame.

  • last_row (pd.DataFrame) – Dernière ligne du DataFrame.

Renvoie:

DataFrame contenant les données étendues.

Type renvoyé:

pd.DataFrame

tide.time_serie.time_serie_dataframe.fill_data_gaps(gaps_dataframe, wl_dataframe, wl_combined_dataframe)[source]

Permet de remplir les périodes de données manquantes.

Paramètres:

  • gaps_dataframe (pd.DataFrame[schema.WaterLevelSerieDataSchema]) – DataFrame contenant les périodes de données manquantes.

  • wl_dataframe (pd.DataFrame[schema.TimeSerieDataSchema]) – DataFrame contenant les données à ajouter.

  • wl_combined_dataframe (pd.DataFrame[schema.TimeSerieDataSchema]) – DataFrame contenant les données combinées.

Renvoie:

DataFrame contenant les données ajoutées au données combinées.

Type renvoyé:

pd.DataFrame[schema.TimeSerieDataSchema]

tide.time_serie.time_serie_dataframe.finalize_time_serie_dataframe(wl_dataframe, station_id, stations_handler)[source]

Finalise les données de la série temporelle en les nettoyant, en les triant et en ajoutant les métadonnées.

Paramètres:
Renvoie:

Données de la série temporelle finalisées.

Type renvoyé:

pd.DataFrame[schema.WaterLevelSerieDataWithMetaDataSchema]

tide.time_serie.time_serie_dataframe.get_buffered_time(time, buffer_time, operation)[source]

Calcul le temps avec un tampon à partir d’une date.

Paramètres:

  • time (str | datetime) – Date en format ISO 8601 ou objet datetime.

  • buffer_time (Optional[pd.Timedelta]) – Temps tampon à ajouter au début et à la fin de la période de données.

  • operation (Literal['-', '+']) – Opération à effectuer.

Renvoie:

Date avec le temps tampon.

Type renvoyé:

str

tide.time_serie.time_serie_dataframe.get_datetime_from_iso8601(date)[source]

Convertit une date ISO 8601 en objet datetime.

Paramètres:

date (str) – Date ISO 8601.

Renvoie:

Objet datetime.

Type renvoyé:

datetime

tide.time_serie.time_serie_dataframe.get_empty_dataframe()[source]

Crée un DataFrame vide.

Renvoie:

DataFrame vide.

Type renvoyé:

pd.DataFrame

tide.time_serie.time_serie_dataframe.get_first_and_last_rows(wl_dataframe)[source]

Récupère la première et la dernière ligne du DataFrame.

Paramètres:

wl_dataframe (pd.DataFrame) – DataFrame contenant les données.

Renvoie:

Première et dernière ligne du DataFrame.

Type renvoyé:

tuple[pd.DataFrame, pd.DataFrame]

tide.time_serie.time_serie_dataframe.get_gaps_dataframe_list(gaps_dataframe, wl_dataframe)[source]

Récupère les périodes de données manquantes.

Paramètres:

  • gaps_dataframe (pd.DataFrame) – DataFrame contenant les périodes de données manquantes.

  • wl_dataframe (pd.DataFrame) – DataFrame contenant les données.

Renvoie:

Une liste de DataFrame contenant les périodes de données manquantes.

Type renvoyé:

list[pd.DataFrame]

tide.time_serie.time_serie_dataframe.get_iso8601_from_datetime(date)[source]

Convertit un objet datetime en date ISO 8601.

Paramètres:

date (datetime) – Objet datetime.

Renvoie:

Date ISO 8601.

Type renvoyé:

str

tide.time_serie.time_serie_dataframe.get_row_by_index(wl_dataframe, index)[source]

Récupère une ligne du DataFrame par son index.

Paramètres:

  • wl_dataframe (pd.DataFrame) – DataFrame contenant les données.

  • index (int) – Index de la ligne à récupérer.

Renvoie:

Ligne du DataFrame.

Type renvoyé:

pd.DataFrame

tide.time_serie.time_serie_dataframe.get_station_position(station_id, stations_handler)[source]

Récupère la position de la station.

Paramètres:

  • station_id (str) – Identifiant de la station.

  • stations_handler (StationsHandlerProtocol) – Gestionnaire des stations.

Renvoie:

Position de la station.

Type renvoyé:

Optional[Point]

tide.time_serie.time_serie_dataframe.get_threshold_interpolation_filling_value(time_serie, threshold_interpolation_filling=None, time_series_excluded_from_interpolation=None)[source]

Fonction pour obtenir la valeur du seuil d’interpolation.

Paramètres:

  • time_serie (TimeSeriesProtocol) – Série temporelle.

  • threshold_interpolation_filling (Optional[str | None]) – Seuil de temps en dessous duquel les données manquantes sont interpolées ou remplies. Si None, les données manquantes sont seulement remplies par la time série suivante.

  • time_series_excluded_from_interpolation (Optional[Collection[TimeSeriesProtocol]]) – Liste des séries temporelles à exclure de l’interpolation.

Renvoie:

Seuil d’interpolation.

Type renvoyé:

str | None

tide.time_serie.time_serie_dataframe.get_water_level_data(stations_handler, station_id, from_time, to_time, time_series_priority, wlo_qc_flag_filter=None, buffer_time=None, max_time_gap=None, threshold_interpolation_filling=None, time_series_excluded_from_interpolation=None)[source]

Récupère et traite les séries temporelles de niveau d’eau pour une station donnée.

Paramètres:

  • stations_handler (StationsHandlerProtocol) – Gestionnaire des stations.

  • station_id (str) – Identifiant de la station.

  • from_time (str | datetime) – Date de début en format ISO 8601 ou objet datetime.

  • to_time (str | datetime) – Date de fin en format ISO 8601 ou objet datetime.

  • time_series_priority (Collection[TimeSeriesProtocol]) – Liste des séries temporelles à récupérer en ordre de priorité.

  • wlo_qc_flag_filter (Optional[Collection[str] | None]) – Filtre de qualité des données wlo.

  • buffer_time (Optional[pd.Timedelta | None]) – Temps tampon à ajouter au début et à la fin de la période de données.

  • max_time_gap (Optional[str | None]) – Intervalle de temps maximal permis. Si None, l’interpolation et le remplissage des données manquantes est désactivée.

  • threshold_interpolation_filling (Optional[str | None]) – Seuil de temps en dessous duquel les données manquantes sont interpolées ou remplies. Si None, les données manquantes sont seulement remplies par la time série suivante.

  • time_series_excluded_from_interpolation (Optional[Collection[TimeSeriesProtocol]]) – Liste des séries temporelles à exclure de l’interpolation. Si une

Renvoie:

Données de niveau d’eau combinées.

Type renvoyé:

pd.DataFrame[schema.WaterLevelSerieDataWithMetaDataSchema]

tide.time_serie.time_serie_dataframe.get_water_level_data_for_stations(stations_handler, tide_zone_info, wlo_qc_flag_filter=None, buffer_time=None, max_time_gap=None, threshold_interpolation_filling=None)[source]

Récupère les données de niveau d’eau pour plusieurs stations.

Paramètres:

  • stations_handler (StationsHandlerProtocol) – Gestionnaire des stations.

  • tide_zone_info (pd.DataFrame[shema.TideZondeInfoSchema]) – Informations sur les stations et les périodes de données à récupérer et leur priorité de séries temporelles.

  • wlo_qc_flag_filter (Optional[Collection[str] | None]) – Filtre de qualité des données wlo.

  • buffer_time (Optional[pd.Timedelta | None]) – Temps tampon à ajouter au début et à la fin de la période de données.

  • max_time_gap (Optional[str | None]) – Intervalle de temps maximal permis. Si None, l’interpolation et le remplissage des données manquantes est désactivée.

  • threshold_interpolation_filling (Optional[str | None]) – Seuil de temps en dessous duquel les données manquantes sont interpolées ou remplies. Si None, les données manquantes sont seulement remplies par la time série suivante.

Renvoie:

Données de niveau d’eau combinées et exceptions.

Type renvoyé:

tuple[dict[str, pd.DataFrame[schema.WaterLevelSerieDataWithMetaDataSchema]], defaultdict[str, list[Exception]]]

tide.time_serie.time_serie_dataframe.get_water_level_data_retrieval_message(station_id, from_time, to_time, time_series_priority)[source]

Récupère le message de log pour la récupération des données de niveau d’eau.

Paramètres:

  • station_id (str) – (str) L’identifiant de la station.

  • from_time (str) – (str) La date de début.

  • to_time (str) – (str) La date de fin.

  • time_series_priority (Collection[TimeSeriesProtocol]) – (Collection[TimeSeriesProtocol]) Les séries temporelles prioritaires.

Type renvoyé:

str

Renvoie:

(str) Le message de log.

tide.time_serie.time_serie_dataframe.get_water_level_time_serie(stations_handler, station_id, from_time, to_time, time_serie_code, buffer_time=None, wlo_qc_flag_filter=None)[source]

Récupère les données de la série temporelle.

Paramètres:

  • stations_handler (StationsHandlerProtocol) – Gestionnaire des stations.

  • station_id (str) – Identifiant de la station.

  • from_time (str | datetime) – Date de début en format ISO 8601 ou objet datetime.

  • to_time (str | datetime) – Date de fin en format ISO 8601 ou objet datetime.

  • time_serie_code (TimeSeriesProtocol) – Série temporelle.

  • buffer_time (Optional[pd.Timedelta]) – Temps tampon à ajouter au début et à la fin de la période de données.

  • wlo_qc_flag_filter (Optional[Collection[str] | None]) – Filtre de qualité des données wlo.

Renvoie:

Données de la série temporelle.

Type renvoyé:

pd.DataFrame[schema.WaterLevelSerieDataSchema] | None

tide.time_serie.time_serie_dataframe.identify_data_gaps(wl_dataframe, max_time_gap, threshold_interpolation_filling=None)[source]

Identifie les périodes de données manquantes.

Paramètres:

  • wl_dataframe (pd.DataFrame[schema.WaterLevelSerieDataSchema]) – DataFrame contenant les données.

  • max_time_gap (str) – Intervalle de temps maximale permise avant de combler les données manquantes.

  • threshold_interpolation_filling (Optional[str | None]) – Seuil de temps en dessous duquel les données manquantes sont interpolées ou remplies. Si None, les données manquantes sont seulement remplies par la time série suivante.

Renvoie:

Un tuple contenant toutes les périodes de données manquantes, les périodes de données manquantes à interpoler et les périodes de données manquantes à remplir.

Type renvoyé:

tuple[pd.DataFrame[schema.TimeSerieDataSchema], pd.DataFrame[schema.TimeSerieDataSchema], pd.DataFrame[schema.TimeSerieDataSchema]]

tide.time_serie.time_serie_dataframe.identify_interpolation_and_fill_gaps(gaps_dataframe, threshold_interpolation_filling)[source]

Identifie les périodes de données manquantes à interpoler et à remplir.

Paramètres:

  • gaps_dataframe (pd.DataFrame[schema.WaterLevelSerieDataSchema]) – DataFrame contenant les périodes de données manquantes.

  • threshold_interpolation_filling (str) – Seuil de temps en dessous duquel les données manquantes sont interpolées ou remplies.

Renvoie:

Périodes de données manquantes à interpoler et à remplir.

Type renvoyé:

tuple[pd.DataFrame[schema.TimeSerieDataSchema], pd.DataFrame[schema.TimeSerieDataSchema]]

tide.time_serie.time_serie_dataframe.interpolate_data_gaps(wl_dataframe, gaps_dataframe, max_time_gap)[source]

Interpole les données manquantes.

Paramètres:

  • wl_dataframe (pd.DataFrame[schema.WaterLevelSerieDataSchema]) – DataFrame contenant les données.

  • gaps_dataframe (pd.DataFrame) – DataFrame contenant les périodes de données manquantes à interpoler.

  • max_time_gap (str) – Intervalle de temps maximale permise avant de combler les données manquantes.

Renvoie:

DataFrame contenant les données interpolées.

Type renvoyé:

pd.DataFrame[schema.TimeSerieDataSchema]

tide.time_serie.time_serie_dataframe.merge_dataframes(wl_combined_dataframe, wl_dataframe)[source]

Fusionne les DataFrames.

Paramètres:

  • wl_combined_dataframe (pd.DataFrame[schema.WaterLevelSerieDataSchema]) – DataFrame contenant les données combinées.

  • wl_dataframe (pd.DataFrame[schema.TimeSerieDataSchema]) – DataFrame contenant les données à ajouter

Renvoie:

DataFrame contenant les données à ajouter et celles combinées.

Type renvoyé:

pd.DataFrame[schema.TimeSerieDataSchema]

tide.time_serie.time_serie_dataframe.process_gaps_to_fill(wl_combined_dataframe, gaps_dataframe, wl_dataframe)[source]

Identifie et comble les données manquantes.

Paramètres:

  • wl_combined_dataframe (pd.DataFrame[schema.WaterLevelSerieDataSchema]) – DataFrame contenant les données combinées.

  • gaps_dataframe (pd.DataFrame[schema.TimeSerieDataSchema]) – DataFrame contenant les périodes de données manquantes.

  • wl_dataframe (pd.DataFrame[schema.TimeSerieDataSchema]) – DataFrame contenant les données à ajouter aux données combinées.

Renvoie:

Données de niveau d’eau combinées.

Type renvoyé:

pd.DataFrame[schema.TimeSerieDataSchema]

tide.time_serie.time_serie_dataframe.process_gaps_to_interpolate(wl_dataframe, max_time_gap, threshold_interpolation_filling=None)[source]

Identifie et comble les données manquantes avec une interpolation.

Paramètres:

  • wl_dataframe (pd.DataFrame[schema.WaterLevelSerieDataSchema]) – DataFrame contenant les données.

  • max_time_gap (str) – Intervalle de temps maximale permise avant de combler les données manquantes.

  • threshold_interpolation_filling (Optional[str | None]) – Seuil de temps en dessous duquel les données manquantes sont interpolées ou remplies. Si None, les données manquantes sont seulement remplies par la time série suivante.

Type renvoyé:

DataFrame

Renvoie:

Données de niveau d’eau combinées.

Rtype:

pd.DataFrame[schema.TimeSerieDataSchema]

tide.time_serie.time_serie_dataframe.resample_data(wl_dataframe, time)[source]

Rééchantillonne les données.

Paramètres:
Renvoie:

DataFrame contenant les données rééchantillonnées.

Type renvoyé:

pd.DataFrame

tide.time_serie.time_serie_dataframe.reset_and_sort_index(wl_dataframe, drop, inplace=True)[source]

Réinitialise et trie l’index du DataFrame.

Paramètres:

  • drop (bool) – Si True, supprime l’ancien index.

  • inplace (bool) – Si True, modifie le DataFrame en place.

  • wl_dataframe (pd.DataFrame) – DataFrame contenant les données.

Type renvoyé:

None

tide.time_serie.time_serie_dataframe.NanDateRow

Dictionnaire pour une ligne de données avec une valeur de NaN.

alias de dict[str, Any]

tide.time_serie.time_serie_models module

Module contenant les modèles pour les séries temporelles de données de marée.

Ce module contient les modèles de données et les protocoles pour les séries temporelles de données de marée.

class tide.time_serie.time_serie_models.DataGapPeriod(start, end)[source]

Bases : object

Modèle pour les périodes de données manquantes.

Paramètres:

  • start (datetime) – Date de début.

  • end (datetime) – Date de fin.

  • duration (timedelta) – Durée de la période.

duration: timedelta

Durée de la période.

end: datetime

Date de fin.

start: datetime

Date de début.

class tide.time_serie.time_serie_models.StationsHandlerProtocol(*args, **kwargs)[source]

Bases : Protocol

Protocole pour les gestionnaires de stations.

get_time_series_dataframe(station, from_time, to_time, time_serie_code, wlo_qc_flag_filter)[source]

Méthode pour récupérer les données de marée d’une station.

Paramètres:

  • station (str) – Code de la station.

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

  • to_time (str) – Date de fin.

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

  • wlo_qc_flag_filter (list[str]) – Flag de qualité à filtrer.

Renvoie:

Données de marée.

Type renvoyé:

pd.DataFrame

_is_protocol = True
property stations: list[dict]

Propriété pour obtenir les stations.

Renvoie:

Stations.

Type renvoyé:

list[dict]

class tide.time_serie.time_serie_models.TimeSeriesProtocol(*args, **kwargs)[source]

Bases : Protocol

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

from_str(value)[source]

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
_is_runtime_protocol = True

tide.time_serie.time_serie_retry module

Module pour la gestion des tentatives d’interpolation de séries temporelles.

Ce module contient les fonctions pour gérer les tentatives d’interpolation de séries temporelles.

tide.time_serie.time_serie_retry.double_buffer_time(retry_state)[source]

Fonction pour doubler le temps tampon pour la prochaine tentative d’interpolation.

Paramètres:

retry_state (RetryCallState) – État de la tentative.

Type renvoyé:

None

tide.time_serie.time_serie_retry.exclude_time_serie_retry(retry_state)[source]

Fonction pour exclure les tentatives d’interpolation de séries temporelles.

Paramètres:

retry_state (RetryCallState) – État de la tentative.

Renvoie:

Données de niveau d’eau combinées.

Type renvoyé:

pd.DataFrame[schema.WaterLevelSerieDataWithMetaDataSchema]

Module contents

Ce package contient les fonctions et les classes nécessaires pour traiter les séries temporelles.

exception tide.time_serie.InterpolationValueError(from_time, to_time, time_serie)[source]

Bases : Exception

Exception pour les valeurs impossibles à interpoler.

Paramètres:

  • from_time (pd.Timestamp) – Date de début.

  • to_time (pd.Timestamp) – Date de fin.

  • time_serie (TimeSeriesProtocol) – Série temporelle.

from_time: Timestamp

Date de début.

time_serie: TimeSeriesProtocol

Série temporelle.

to_time: Timestamp

Date de fin.

exception tide.time_serie.NoWaterLevelDataError(station_id, from_time, to_time)[source]

Bases : Exception

Exception pour les erreurs de données de marée manquantes.

Paramètres:

  • station_id (str) – Code de la station.

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

  • to_time (str) – Date de fin.

from_time: str

Date de début.

station_id: str

Code de la station.

to_time: str

Date de fin.

exception tide.time_serie.WaterLevelDataGapError(station_id, gaps, max_time_gap)[source]

Bases : Exception

Exception pour les périodes de données manquantes.

Paramètres:

  • station_id (str) – Code de la station.

  • gaps (pd.DataFrame) – Périodes de données manquantes.

  • max_time_gap (str) – Limite permise pour les données

gaps: DataFrame

Périodes de données manquantes.

max_time_gap: str

Limite permise pour les données.

station_id: str

Code de la station.

tide.time_serie.get_water_level_data_for_stations(stations_handler, tide_zone_info, wlo_qc_flag_filter=None, buffer_time=None, max_time_gap=None, threshold_interpolation_filling=None)[source]

Récupère les données de niveau d’eau pour plusieurs stations.

Paramètres:

  • stations_handler (StationsHandlerProtocol) – Gestionnaire des stations.

  • tide_zone_info (pd.DataFrame[shema.TideZondeInfoSchema]) – Informations sur les stations et les périodes de données à récupérer et leur priorité de séries temporelles.

  • wlo_qc_flag_filter (Optional[Collection[str] | None]) – Filtre de qualité des données wlo.

  • buffer_time (Optional[pd.Timedelta | None]) – Temps tampon à ajouter au début et à la fin de la période de données.

  • max_time_gap (Optional[str | None]) – Intervalle de temps maximal permis. Si None, l’interpolation et le remplissage des données manquantes est désactivée.

  • threshold_interpolation_filling (Optional[str | None]) – Seuil de temps en dessous duquel les données manquantes sont interpolées ou remplies. Si None, les données manquantes sont seulement remplies par la time série suivante.

Renvoie:

Données de niveau d’eau combinées et exceptions.

Type renvoyé:

tuple[dict[str, pd.DataFrame[schema.WaterLevelSerieDataWithMetaDataSchema]], defaultdict[str, list[Exception]]]