tlo.methods.tb module

The TB Module is under development. Here the contents of the module are commented out whilst work proceeds. It is included because this version should replace what is currently in Master.

class Tb(name=None, resourcefilepath=None)[source]

Set up the baseline population with TB prevalence

Bases: tlo.core.Module

Functions (defined or overridden in class Tb):

__init__(name=None, resourcefilepath=None)[source]

Construct a new disease module ready to be included in a simulation.

Initialises an empty parameters dictionary and module-specific random number generator.


name – the name to use for this module. Defaults to the concrete subclass’ name.


Read parameter values from file, if required.

Must be implemented by subclasses.


data_folder – path of a folder supplied to the Simulation containing data files. Typically modules would read a particular file within here.


Set our property values for the initial population.

Must be implemented by subclasses.

This method is called by the simulation when creating the initial population, and is responsible for assigning initial values, for every individual, of those properties ‘owned’ by this module, i.e. those declared in its PROPERTIES dictionary.

TODO: We probably need to declare somehow which properties we ‘read’ here, so the simulation knows what order to initialise modules in!


population – the population of individuals


Get ready for simulation start.

Must be implemented by subclasses.

This method is called just before the main simulation loop begins, and after all modules have read their parameters and the initial population has been created. It is a good place to add initial events to the event queue.

on_birth(mother_id, child_id)[source]

Initialise our properties for a newborn individual.

Must be implemented by subclasses.

This is called by the simulation whenever a new person is born.

  • mother – the mother for this child (can be -1 if the mother is not identified).

  • child – the new child

on_hsi_alert(person_id, treatment_id)[source]