`bucky.model.mc_instance`#

Provides a class that contains all the data/info needed to perform one full integration.

Module Contents#

Classes#

buckyMCInstance

Class that holds basic information and provides helper variables needed to perform an MC.

Functions#

norm_Cij(Cij)

Sum a stack of contact matrices to get the overall Cij thats symmetrized then normalized.

class bucky.model.mc_instance.buckyMCInstance(init_date, n_days, Nij, Cij)[source]#

Class that holds basic information and provides helper variables needed to perform an MC.

property Aij(self)#: Adj matrix property.

BETA_eff(self, t)[source]#: Return effective value of BETA after time dependent changes.

Cij(self, t)[source]#: Return the contact matrices after applying time dependent changes.

S_eff(self, t, y)[source]#: Return the effective of susceptable (S_ij) after applying time dependent modifications.

add_npi(self, npi_params)[source]#: Enable dynamic NPIs during the time integration.

add_vacc(self, vacc_data)[source]#: Enable vaccine simulation during the simulation.

property epi_params(self)#: Epi parameters property.

property integrator_args(self)#: Dict of standard arguments passed to solve_ivp.

set_tmax(self, t_max)[source]#: Set a new value for the max integration time.

property state(self)#: State variable property.

bucky.model.mc_instance.norm_Cij(Cij)[source]#: Sum a stack of contact matrices to get the overall Cij thats symmetrized then normalized.