API reference

This page lists HPVsim’s full API, including all functions and classes.

hpvsim.analysis	Additional analysis functions that are not part of the core workflow, but which are useful for particular investigations.
hpvsim.base	Base classes for HPVsim.
hpvsim.calibration	Define the calibration class
hpvsim.defaults	Set the defaults across each of the different files.
hpvsim.hiv	Defines classes and methods for HIV natural history
hpvsim.immunity	Defines classes and methods for calculating immunity
hpvsim.interventions	Specify the core interventions.
hpvsim.misc	Miscellaneous functions that do not belong anywhere else
hpvsim.parameters	Set the parameters for hpvsim.
hpvsim.people	Defines the People class and functions associated with making people and handling the transitions between states (e.g., from susceptible to infected).
hpvsim.plotting	Core plotting functions for simulations, multisims, and scenarios.
hpvsim.population	Defines functions for making the population.
hpvsim.run	Functions and classes for running multiple HPVsim runs.
hpvsim.settings	Define options for hpvsim, mostly plotting options. All options should be set using set() or directly, e.g.::.
hpvsim.sim	Define core Sim classes
hpvsim.utils	Numerical utilities for running hpvsim.
hpvsim.data.downloaders	Download data needed for HPVsim.
hpvsim.data.loaders	Load data