Magic Wand Models

This module contains tools for making crude adjustments to rates in multi-state lifetable simulations.

class vivarium_public_health.mslt.magic_wand_components.MortalityShift

setup(builder)

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)

class vivarium_public_health.mslt.magic_wand_components.YLDShift

setup(builder)

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)

class vivarium_public_health.mslt.magic_wand_components.IncidenceShift(disease)

Parameters:

disease (str) –

setup(builder)

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

incidence_adjustment(index, rates)

class vivarium_public_health.mslt.magic_wand_components.ModifyAcuteDiseaseYLD(disease)

Parameters:

disease (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)

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)

class vivarium_public_health.mslt.magic_wand_components.ModifyAcuteDiseaseMortality(disease)

Parameters:

disease (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)

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)