API reference

Core

Core simulation classes and utilities.

sim	User API for creating an STI simulation
parameters	Set parameters
networks	STIsim networks package.
demographics	Define demographic modules used within STIsim
analyzers	Common analyzers for STI analyses
calibration	Define the calibration class
care_seeking	Define care-seeking propensity module for STIsim.
utils	STIsim utilities

Diseases

STI disease modules.

diseases.sti	Template class for SEIS-type STIs
diseases.hiv	Define HIV disease module
diseases.syphilis	Define syphilis disease module
diseases.chlamydia	Chlamydia trachomatis disease module
diseases.gonorrhea	Gonorrhea disease module
diseases.trichomoniasis	Trichomoniasis disease module
diseases.bv	BV modules
diseases.gud	Placeholder modules for non-specific STIs, including:

Interventions

Testing, treatment, and prevention.

interventions.base_interventions	Define interventions for STIsim
interventions.bv_interventions	Define BV interventions
interventions.gonorrhea_interventions	Define gonorrhea interventions for STIsim
interventions.hiv_interventions	Define HIV interventions for STIsim
interventions.syphilis_interventions	Define syphilis interventions for STIsim

Connectors

Coinfection interactions.

connectors.hiv_sti	Syphilis-HIV connector for running coinfection analyses
connectors.gud_syph