API reference

API reference

Full details on all HPVsim classes and functions.

analysis Additional analysis functions that are not part of the core workflow,
base Base classes for HPVsim. These classes handle a lot of the boilerplate of the
calibration Define the calibration class
defaults Set the defaults across each of the different files.
hiv Defines classes and methods for HIV natural history
immunity Defines classes and methods for calculating immunity
interventions Specify the core interventions. Other interventions can be
misc Miscellaneous functions that do not belong anywhere else
parameters Set the parameters for hpvsim.
people Defines the People class and functions associated with making people and handling
plotting Core plotting functions for simulations, multisims, and scenarios.
population Defines functions for making the population.
run Functions and classes for running multiple HPVsim runs.
settings Define options for hpvsim, mostly plotting options. All options should
sim Define core Sim classes
utils Numerical utilities for running hpvsim.
data.downloaders Download data needed for HPVsim.
data.loaders Load data