API reference

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

covasim.analysis	Additional analysis functions that are not part of the core Covasim workflow, but which are useful for particular investigations.
covasim.base	Base classes for Covasim.
covasim.defaults	Set the defaults across each of the different files.
covasim.immunity	Defines classes and methods for calculating immunity
covasim.interventions	Specify the core interventions available in Covasim.
covasim.misc	Miscellaneous functions that do not belong anywhere else
covasim.parameters	Set the parameters for Covasim.
covasim.people	Defines the People class and functions associated with making people and handling the transitions between states (e.g., from susceptible to infected).
covasim.plotting	Core plotting functions for simulations, multisims, and scenarios.
covasim.population	Defines functions for making the population.
covasim.requirements	Check that correct versions of each library are installed, and print warnings or errors if not.
covasim.run	Functions and classes for running multiple Covasim runs.
covasim.settings	Define options for Covasim, mostly plotting and Numba options. All options should be set using set() or directly, e.g.::.
covasim.sim	Defines the Sim class, Covasim's core class.
covasim.utils	Numerical utilities for running Covasim.
covasim.data