API reference#

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

arrays

Define array-handling classes, including agent states

demographics

Define pregnancy, deaths, migration, etc.

disease

Base classes for diseases

distributions

Define random-number-safe distributions.

interventions

Define interventions

loop

Parent class for the integration loop.

modules

General module class -- base class for diseases, interventions, etc.

networks

Networks that connect people within a population

parameters

Set parameters

people

Defines the People class and functions associated with making people

products

Define products

results

Result structures.

run

Utilities for running in parallel

samples

Create a class for storing a large number of simulations.

settings

Define options for Starsim. All options should be set using set() or directly, e.g.::.

sim

Define core Sim classes

utils

Numerical utilities