Simple Intervention Models

This module contains simple intervention models that work at the population level by providing direct shifts to epidemiological measures.

class vivarium_public_health.treatment.magic_wand.AbsoluteShift(target)[source]
Parameters:

target (str) –

CONFIGURATION_DEFAULTS: Dict[str, Any] = {'intervention': {'age_end': 125, 'age_start': 0, 'target_value': 'baseline'}}

A dictionary containing the defaults for any configurations managed by this component. An empty dictionary indicates no managed configurations.

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]

property columns_required: List[str] | None

Provides names of columns required by the component.

Returns:

Names of required columns not created by this component. An empty list means all available columns are needed. None means no additional columns are necessary.

Return type:

Optional[List[str]]

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

intervention_effect(index, value)[source]