Intervention Models

This module contains tools for modeling interventions in multi-state lifetable simulations.

class vivarium_public_health.mslt.intervention.ModifyAllCauseMortality(intervention)[source]

Interventions that modify the all-cause mortality rate.

Parameters:: intervention (str) –

property configuration_defaults: Dict[str, Any]

Provides a dictionary containing the defaults for any configurations managed by this component.

These default values will be stored at the component_configs layer of the simulation’s ConfigTree.

Returns:: A dictionary containing the defaults for any configurations managed by this component.
Return type:: Dict[str, Any]

setup(builder)[source]

Defines custom actions this component needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the component. By default, it does nothing.

Parameters:: builder (Builder) – The builder object used to set up the component.
Return type:: None

mortality_adjustment(index, rates)[source]

class vivarium_public_health.mslt.intervention.ModifyDiseaseRate(intervention, disease, rate)[source]

Interventions that modify a rate associated with a chronic disease.

Parameters:

intervention (str) –
disease (str) –
rate (str) –

property configuration_defaults: Dict[str, Any]

Provides a dictionary containing the defaults for any configurations managed by this component.

These default values will be stored at the component_configs layer of the simulation’s ConfigTree.

Returns:: A dictionary containing the defaults for any configurations managed by this component.
Return type:: Dict[str, Any]

setup(builder)[source]

Defines custom actions this component needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the component. By default, it does nothing.

Parameters:: builder (Builder) – The builder object used to set up the component.
Return type:: None

adjust_rate(index, rates)[source]

class vivarium_public_health.mslt.intervention.ModifyDiseaseIncidence(intervention, disease)[source]

Interventions that modify a disease incidence rate, based on a PIF lookup table.

Parameters:

intervention (str) –
disease (str) –

class vivarium_public_health.mslt.intervention.ModifyDiseaseMortality(intervention, disease)[source]

Interventions that modify a disease fatality rate, based on a PIF lookup table.

Parameters:

intervention (str) –
disease (str) –

class vivarium_public_health.mslt.intervention.ModifyDiseaseMorbidity(intervention, disease)[source]

Interventions that modify a disease disability rate, based on a PIF lookup table.

Parameters:

intervention (str) –
disease (str) –

class vivarium_public_health.mslt.intervention.ModifyAcuteDiseaseIncidence(intervention)[source]

Interventions that modify an acute disease incidence rate. Note that this intervention will simply modify both the disability rate and the mortality rate for the chosen acute disease.

Parameters:: intervention (str) –

property configuration_defaults: Dict[str, Any]

Provides a dictionary containing the defaults for any configurations managed by this component.

These default values will be stored at the component_configs layer of the simulation’s ConfigTree.

Returns:: A dictionary containing the defaults for any configurations managed by this component.
Return type:: Dict[str, Any]

setup(builder)[source]

Defines custom actions this component needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the component. By default, it does nothing.

Parameters:: builder (Builder) – The builder object used to set up the component.
Return type:: None

rate_adjustment(index, rates)[source]

class vivarium_public_health.mslt.intervention.ModifyAcuteDiseaseMorbidity(intervention)[source]

Interventions that modify an acute disease disability rate.

Parameters:: intervention (str) –

property configuration_defaults: Dict[str, Any]

Provides a dictionary containing the defaults for any configurations managed by this component.

These default values will be stored at the component_configs layer of the simulation’s ConfigTree.

Returns:: A dictionary containing the defaults for any configurations managed by this component.
Return type:: Dict[str, Any]

setup(builder)[source]

Defines custom actions this component needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the component. By default, it does nothing.

Parameters:: builder (Builder) – The builder object used to set up the component.
Return type:: None

disability_adjustment(index, rates)[source]

class vivarium_public_health.mslt.intervention.ModifyAcuteDiseaseMortality(intervention)[source]

Interventions that modify an acute disease fatality rate.

Parameters:: intervention (str) –

property configuration_defaults: Dict[str, Any]

Provides a dictionary containing the defaults for any configurations managed by this component.

These default values will be stored at the component_configs layer of the simulation’s ConfigTree.

Returns:: A dictionary containing the defaults for any configurations managed by this component.
Return type:: Dict[str, Any]

setup(builder)[source]

Defines custom actions this component needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the component. By default, it does nothing.

Parameters:: builder (Builder) – The builder object used to set up the component.
Return type:: None

mortality_adjustment(index, rates)[source]

class vivarium_public_health.mslt.intervention.TobaccoFreeGeneration[source]

Eradicate tobacco uptake at some point in time.

property configuration_defaults: Dict[str, Any]

Provides a dictionary containing the defaults for any configurations managed by this component.

These default values will be stored at the component_configs layer of the simulation’s ConfigTree.

Returns:: A dictionary containing the defaults for any configurations managed by this component.
Return type:: Dict[str, Any]

setup(builder)[source]

Defines custom actions this component needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the component. By default, it does nothing.

Parameters:: builder (Builder) – The builder object used to set up the component.
Return type:: None

adjust_rate(index, rates)[source]

class vivarium_public_health.mslt.intervention.TobaccoEradication[source]

Eradicate all tobacco use at some point in time.

property configuration_defaults: Dict[str, Any]

Provides a dictionary containing the defaults for any configurations managed by this component.

These default values will be stored at the component_configs layer of the simulation’s ConfigTree.

Returns:: A dictionary containing the defaults for any configurations managed by this component.
Return type:: Dict[str, Any]

setup(builder)[source]

Defines custom actions this component needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the component. By default, it does nothing.

Parameters:: builder (Builder) – The builder object used to set up the component.
Return type:: None

adjust_inc_rate(index, rates)[source]

adjust_rem_rate(index, rates)[source]