Run functions

run_simulation()

Run the simulation

run_metapop_simulation()

Run a metapopulation model

run_simulation_with_repetitions()

Run the simulation with repetitions

run_resumable_simulation()

Run the simulation in a resumable way

Parameter functions

get_parameters()

Get model parameters

get_correlation_parameters()

Get default correlation parameters

set_parameter_draw()

Use parameter draw from the join posterior

set_equilibrium()

Set equilibrium

set_epi_outputs()

Parameterise age grouped output rendering

Demography functions

set_demography()

Parameterise variable deathrates

Mosquito species functions and parameters

set_species()

Parameterise the mosquito species to use in the model

set_carrying_capacity()

Parameterise custom baseline carrying capacity

calculate_carrying_capacity()

Calculate the vector carrying capacity

get_init_carrying_capacity()

Get initialised carrying capacity for each species

arab_params

Preset parameters for the An. arabiensis vector

fun_params

Preset parameters for the An. funestus vector

gamb_params

Preset parameters for the An. gambiae s.s vector

steph_params

Preset parameters for the An. stephensi vector

Intervention functions

Drug treatments

set_drugs()

Parameterise drugs to use in the model

set_clinical_treatment()

Parameterise clinical treatment

AL_params

Preset parameters for the AL drug

DHA_PQP_params

Preset parameters for the DHA-PQP drug

SP_AQ_params

Preset parameters for the SP-AQ drug

set_antimalarial_resistance()

Parameterise antimalarial resistance

get_antimalarial_resistance_parameters()

Retrieve resistance parameters

MDA and chemoprevention

set_mda()

Parameterise a Mass Drug Administration

set_pmc()

Parameterise a perennial malaria chemoprevention (PMC, formerly IPIi)

set_smc()

Parameterise a Seasonal Malaria Chemoprevention

peak_season_offset()

Calculate the yearly offset (in timesteps) for the peak mosquito season

Vaccines

set_mass_pev()

Parameterise a vaccine mass distribution strategy

set_pev_epi()

Parameterise a pre-erythrocytic vaccine with an EPI strategy

set_tbv()

Parameterise an TBV strategy

rtss_profile

RTS,S vaccine profile

rtss_booster_profile

RTS,S booster vaccine profile

r21_profile

R21 vaccine profile

r21_booster_profile

R21 booster vaccine profile

Vector control

set_bednets()

Parameterise a bed net strategy

set_spraying()

Parameterise an indoor spraying strategy

Non-user functions

CorrelationParameters

Class: Correlation parameters

create_pev_profile()

create a PEV profile

create_progress_process()

Create progress process

find_birthrates()

Calculate the birthrate for a population in equilibrium

parameter_draws

Parameter draws

parameterise_mosquito_equilibrium()

Parameterise total_M and carrying capacity for mosquitos from EIR

parameterise_total_M()

Parameterise total_M