API reference

API reference

analysis Additional analysis functions that are not part of the core Covasim workflow,
base Base classes for Covasim. These classes handle a lot of the boilerplate of the
data.loaders Load data
defaults Set the defaults across each of the different files.
immunity Defines classes and methods for calculating immunity
interventions Specify the core interventions available in Covasim. Other interventions can be
misc Miscellaneous functions that do not belong anywhere else
parameters Set the parameters for Covasim.
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.
requirements Check that correct versions of each library are installed, and print warnings
run Functions and classes for running multiple Covasim runs.
settings Define options for Covasim, mostly plotting and Numba options. All options should
sim Defines the Sim class, Covasim’s core class.
utils Numerical utilities for running Covasim.