API reference

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

fpsim.analyzers	Specify the core analyzers available in FPsim.
fpsim.base	Base classes for loading parameters and for running simulations with FP model
fpsim.calibration	Define the Calibration class
fpsim.defaults	Define defaults for use throughout FPsim
fpsim.experiment	Define classes and functions for the Experiment class (running sims and comparing them to data)
fpsim.interventions	Specify the core interventions available in FPsim.
fpsim.parameters	Handle sim parameters
fpsim.scenarios	Class to define and run scenarios
fpsim.settings	Define options for FPsim, mostly plotting and Numba options. All options should be set using set() or directly, e.g.::.
fpsim.sim	Defines the Sim class, the core class of the FP model (FPsim).
fpsim.utils	File for storing utilities and probability calculators needed to run FP model
fpsim.locations