sid.seasonality

This module contains the code related to seasonality.

Module Contents

Functions

prepare_seasonality_factor(seasonality_factor_model: Optional[Callable], params: pandas.DataFrame, dates: pandas.DatetimeIndex, seed: itertools.count, contact_models: Dict[str, Dict[str, Any]]) → numpy.ndarray

Prepare the seasonality factor.
prepare_seasonality_factor(seasonality_factor_model: Optional[Callable], params: pandas.DataFrame, dates: pandas.DatetimeIndex, seed: itertools.count, contact_models: Dict[str, Dict[str, Any]]) → numpy.ndarray[source]

Prepare the seasonality factor.

Parameters

  • seasonality_factor_model (Optional[Callable]) – The function which calculates the seasonality factor for each day.

  • params (pd.DataFrame) – The parameters.

  • dates (pd.DatetimeIndex) – All simulated days.

  • seed (itertools.count) – A seed counter

  • contact_models (Dict[str, Dict[str, Any]]) – See Contact Models.

Returns

Factors for the infection probabilities of each

day.

Return type

seasonality_factor (np.ndarray)