API reference

API reference

analysis Additional analysis functions that are not part of the core Covasim workflow,
base The v3 contact layers (cv.Layer, now a Starsim network, and cv.Contacts), and the v3
data.loaders Load data
defaults Set the defaults across each of the different files.
immunity Variants and immunity for Covasim on the Starsim base.
interventions Specify the core interventions available in Covasim: testing, contact tracing, vaccination,
misc Miscellaneous functions that do not belong anywhere else
parameters Set the parameters for Covasim.
people Defines the People class.
plotting Core plotting functions for simulations, multisims, and scenarios.
population Defines functions for making contact edge lists, e.g. for custom layers.
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 for Covasim on the Starsim base.
utils Numerical utilities for Covasim: sampling, random numbers, and array indexing helpers.