Root Level Scripts

Main simulation scripts located in the scripts root directory.

Common Functions

Shared utility functions used across multiple scripts.

scripts.common_functions.make_tb(pars=None)

Set up the TB simulation with default parameters.

scripts.common_functions.make_pop(pars=None, n_agents=500)

Set up the population with default parameters.

scripts.common_functions.make_net(pars=None)

Set up the network with default parameters.

scripts.common_functions.make_births(pars=None)

Set up the births demographic with default parameters.

scripts.common_functions.make_deaths(pars=None)

Set up the deaths demographic with default parameters.

scripts.common_functions.make_intervention(pars=None)

Set up the intervention with default parameters.

scripts.common_functions.make_hiv(pars=None)

Set up the HIV intervention with default parameters.

scripts.common_functions.make_cnn(pars=None)

Set up the CNN intervention with default parameters.

scripts.common_functions.load_age_data(source='default', file_path='')

Load population data from a CSV file or use default data.

scripts.common_functions.make_hiv_interventions(include: bool = True, pars=None)

Set up HIV interventions with default parameters.

Parameters:

• include (bool, optional) – Whether to include HIV interventions. Default is True.

• pars (dict, optional) – Custom parameters for HIV interventions. If None, uses defaults.

Returns:

List containing HIV intervention object, or None if not included.

Return type:

list or None

scripts.common_functions.make_hiv_comorbidity(include: bool = True, hiv_pars=None)

Set up HIV comorbidity with default parameters.

Parameters:

• include (bool, optional) – Whether to include HIV. Default is True.

• hiv_pars (dict, optional) – Custom parameters for HIV. If None, uses defaults.

Returns:

HIV object, or None if not included.

Return type:

tbsim.HIV or None

scripts.common_functions.make_tb_comorbidity(include: bool = True, tb_pars=None)

Set up TB comorbidity with default parameters.

Parameters:

• include (bool, optional) – Whether to include TB. Default is True.

• tb_pars (dict, optional) – Custom parameters for TB. If None, uses defaults.

Returns:

TB object, or None if not included.

Return type:

tbsim.TB or None

scripts.common_functions.make_tb_hiv_connector(include: bool = True, pars=None)

Set up TB-HIV connector with default parameters.

Parameters:

• include (bool, optional) – Whether to include TB-HIV connector. Default is True.

• pars (dict, optional) – Custom parameters for TB-HIV connector. If None, uses defaults.

Returns:

TB-HIV connector object, or None if not included.

Return type:

tbsim.TB_HIV_Connector or None

scripts.common_functions.make_demographics(include: bool = False)

Set up demographics with default parameters.

Parameters:

include (bool, optional) – Whether to include demographics. Default is False.

Returns:

List containing birth and death objects, or None if not included.

Return type:

list or None

scripts.common_functions.plot_results(flat_results, keywords=None, exclude=('15',), n_cols=5, dark=True, cmap='tab20', heightfold=3, style='default')

Plot simulation results across multiple scenarios.

Parameters:

• flat_results (dict[str, dict[str, Result]]) – Mapping scenario→{metric→Result(timevec, values)}.

• keywords (list[str], optional) – Only plot metrics containing any of these substrings.

• exclude (tuple[str], optional) – Skip metrics whose name contains any of these substrings.

• n_cols (int, optional) – Number of columns in the subplot grid.

• dark (bool, optional) – If True use greyish dark mode; otherwise default style.

• cmap (str, optional) – Name of the Matplotlib colormap to use.

• heightfold (int, optional) – Height factor for subplot rows.

• style (str, optional) – Matplotlib style to use.

scripts.common_functions.uncertainty_plot()

Create an uncertainty plot with example data. This is a demonstration function showing how to create uncertainty plots.