API reference

Core

Core simulation classes and utilities.

sim	TB simulation class – a convenience wrapper around ss.Sim with TB-specific defaults.
tb	TB natural history model. State definitions and transition diagram are in the API docs (tbsim.tb).
networks	Custom contact networks
analyzers	TBsim custom analyzers
plots	Plotting utilities for visualizing TB simulation results.

Interventions

Diagnostics, treatment, and prevention.

interventions.bcg	BCG vaccination: Product + Delivery following the Starsim Vx pattern.
interventions.beta	Intervention that modifies the TB transmission rate (beta) at specified time points.
interventions.diagnostics	Diagnostic products and delivery for TB testing.
interventions.health_seeking	Health-seeking behavior intervention
interventions.interventions	Shared intervention infrastructure for TBsim.
interventions.products	Base product classes for DataFrame-driven multi-outcome products.
interventions.tpt	Tuberculosis Preventive Therapy (TPT): Product + Delivery.
interventions.treatments	Treatment products and delivery for TB.

Comorbidities

HIV and malnutrition co-infection modules.

comorbidities.hiv	Simplified HIV disease model and TB-HIV connector for co-infection simulations.
comorbidities.malnutrition	Malnutrition disease model and TB-Malnutrition connector for TB simulation.

Resistance

Multi-strain drug-resistance extension.

resistance.analyzers	Analyzers for multi-strain (drug-resistance) TB.
resistance.dst	Drug-susceptibility testing (DST) for multi-strain TB.
resistance.strains	Strain registry for multi-strain (drug-resistance) TB.
resistance.tb_resistant	Multi-strain (drug-resistance) TB natural history.
resistance.tpt	Strain-aware TB preventive therapy (TPT).
resistance.treatments	Strain-aware TB treatment.

Compartmental

Compartmental (ODE-style) TB models.

compartmental.lshtm_ode

Define compartmental TB models.