environmentaltools.temporal.simulation

environmentaltools.temporal.simulation(param: dict, tidalConstituents: dict = None, dur_storm_calms: DataFrame = None, seed: int = 283426, include: bool = False)[source]

Simulates time series with the probability model given in param and the temporal dependency given in df_dt.

Parameters:

  • param (dict) – The probability models of every variable

  • tidalConstituents (dict, optional) – Tidal constituents required to compute the tidal elevation and the mean sea level (Códiga, 2011). Defaults to None.

  • dur_storm_calms (pd.DataFrame, optional) – Time series of storm events

  • seed (int, optional) – A value to create a non-random simulation (mainly for debugging actions). Default is a random integer.

  • include (bool, optional) – Include some deterministic time series given by the user. Default is False.

Returns:

Saves files with simulated time series

Return type:

None

Examples

>>> params = {"Hs": {... see environmentaltools.temporal.analysis.fit_marginal_distribution},
...           "TD": {... environmentaltools.temporal.see analysis.dependency},
...           "TS": {}}