Tutorials

This section contains step-by-step tutorials and examples for using TBsim. These tutorials range from basic introductions to advanced modeling scenarios.

Getting Started

Beginner Tutorials

• tutorials/basic_tbrun
• tutorials/tuberculosis_sim.ipynb

Core Modeling

TB Modeling

• tutorials/tb_interventions_tutorial.ipynb
• tutorials/run_tbhiv_scens.ipynb

Advanced Topics

Advanced Features

• tutorials/tbhiv_comorbidity.ipynb
• tutorials/malnutrition_tutorial.ipynb
• tutorials/comprehensive_analyzer_plots_example.ipynb

Tutorial Descriptions

basic_tbrun.md
Basic introduction to TBsim concepts and workflow

tuberculosis_sim.ipynb
Comprehensive TB simulation tutorial with step-by-step explanations

tb_interventions_tutorial.ipynb
Detailed guide to implementing and analyzing TB interventions

run_tbhiv_scens.ipynb
TB-HIV co-infection modeling scenarios and analysis

tbhiv_comorbidity.ipynb Advanced comorbidity modeling between TB and HIV

malnutrition_tutorial.ipynb TB-malnutrition comorbidity modeling and nutritional status effects

comprehensive_analyzer_plots_example.ipynb Using TBsim's built-in analyzers and plotting tools

Running Tutorials

All tutorials can be run:

1. Locally: After installing TBsim and its dependencies
2. In Jupyter: Open the .ipynb files in Jupyter Notebook or JupyterLab

For the best experience, we recommend starting with the basic tutorials and progressing to more advanced topics as you become familiar with the framework.