Skip to content

Scripts

This section provides documentation for the example scripts in the tbsim_examples directory. These scripts demonstrate the core features of TBsim.

Available Examples

run_tb.py
Basic TB simulation with default parameters. The simplest starting point for understanding TBsim.

run_tb_lshtm.py
LSHTM "spectrum of TB disease" natural history model, comparing simulations with and without the acute compartment.

run_malnutrition.py
TB-Malnutrition comorbidity model demonstrating how to add a co-disease to a simulation.

run_tbhiv.py
TB-HIV coinfection model with the TB-HIV connector and optional HIV interventions.

run_tb_interventions.py Intervention framework demonstrating BCG vaccination, TPT, and time-varying beta scenarios.

run_health_seeking.py Health-seeking behaviour with the LSHTM TB model, comparing baseline, low-rate, and high-rate care-seeking scenarios.