sid.vaccination

This module contains the code for vaccinating individuals.

Module Contents

Functions

vaccinate_individuals(date: pandas.Timestamp, vaccination_models: Optional[Dict[str, Dict[str, Any]]], states: pandas.DataFrame, params: pandas.DataFrame, seed: itertools.count) → pandas.Series

Vaccinate individuals.

vaccinate_individuals(date: pandas.Timestamp, vaccination_models: Optional[Dict[str, Dict[str, Any]]], states: pandas.DataFrame, params: pandas.DataFrame, seed: itertools.count) → pandas.Series

Vaccinate individuals.

Parameters

• date (pandas.Timestamp) – The current date.

• vaccination_models (Optional[Dict[str, Dict[str, Any]) – A dictionary of models which allow to vaccinate individuals. The "model" key holds a function with arguments states, params, and a seed which returns boolean indicators for individuals who received a vaccination.

• states (pandas.DataFrame) – The states.

• params (pandas.DataFrame) – The params.

• seed (itertools.count) – The seed counter.

Returns

1d boolean series indicating newly vaccinated

individuals.

Return type

newly_vaccinated (pandas.Series)