API Reference

This section provides comprehensive API documentation for all TBsim modules and components, automatically generated from Python docstrings.

Core Modules

Analysis and Visualization

Interventions

Comorbidities

Configuration and Support

Data and Utilities

Module Overview

Core TB Model (tbsim.tb)

Main tuberculosis simulation module with disease dynamics, transmission, and state transitions. Implements the TBS state enumeration and TB disease class.

Networks (tbsim.networks)

Social network structures for modeling transmission patterns, including household networks and RATIONS trial specific implementations.

Analyzers (tbsim.analyzers)

Comprehensive data analysis tools including dwell time analysis (DWT), visualization, and post-processing capabilities for simulation results.

Interventions (tbsim.interventions.*)

Various intervention modules for TB control and prevention, including DOTS implementation, BCG vaccination, enhanced diagnostics, and treatment protocols.

Comorbidities (tbsim.comorbidities.*)

Modeling of HIV, malnutrition, and other co-occurring conditions with bidirectional interactions with TB dynamics.

Utilities (tbsim.utils.*)

Helper functions for demographics, plotting, probability calculations, and data processing.

Configuration (tbsim.config)

Parameter management, simulation configuration, and result directory creation utilities.

Data (tbsim.data)

Data extraction, processing utilities, and anthropometric reference data for malnutrition modeling.

Miscellaneous (tbsim.misc.*)

TB terminology definitions, version information, and additional utility functions.

For detailed information about each module, click on the links above or use the search functionality. All documentation is automatically generated from Python docstrings to ensure accuracy and completeness.