API reference

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

starsim.demographics	Define pregnancy, deaths, migration, etc.
starsim.disease	Base classes for diseases
starsim.distributions	Define random-number-safe distributions.
starsim.interventions	Define interventions (and analyzers)
starsim.modules	General module class -- base class for diseases, interventions, etc.
starsim.network	Networks that connect people within a population
starsim.parameters	Set parameters
starsim.people	Defines the People class and functions associated with making people
starsim.products	Define products
starsim.results	Result structures.
starsim.run	Utilities for running in parallel
starsim.samples	Create a class for storing a large number of simulations.
starsim.settings	Define options for Starsim. All options should be set using set() or directly, e.g.::.
starsim.sim	Define core Sim classes
starsim.states	Define array-handling classes, including agent states
starsim.utils	Numerical utilities