Skip to content

Quick Start Guide

This guide will help you run your first TBsim simulation in minutes.

Running Your First Simulation

  1. Navigate to the examples directory:
cd tbsim_examples
  1. Run the basic TB simulation:
python run_tb.py
  1. View the results: The script will display basic charts showing the simulation outcomes.

Understanding the Output

The basic simulation will show:

  • TB Prevalence: Number of active TB cases over time
  • Incidence: New TB cases per time period
  • Population Dynamics: Overall population changes
  • Treatment Outcomes: Success/failure rates

Key Components

TBsim simulations include several core elements:

  • TB Model: Core tuberculosis dynamics
  • Population: Demographics and social networks
  • Interventions: Treatment and prevention strategies
  • Comorbidities: HIV, malnutrition, and other conditions

Next Steps

After running the basic simulation:

  1. Explore Tutorials: Check out the comprehensive tutorials in the docs/tutorials/ directory
  2. Modify Parameters: Adjust simulation parameters in the scripts
  3. Add Interventions: Implement different TB control strategies
  4. Analyze Results: Use the built-in analyzers for detailed output analysis

For more detailed examples, see the examples section.