API reference
API reference
Full details on all Starsim classes and functions.
analyzers | Define analyzers, which are used to track variables when the sim is run. |
arrays | Define array-handling classes, including agent states |
calibration | Define the calibration class |
connectors | Define connectors, which are used to mediate interactions between modules when the sim is run. |
debugtools | Utilities to help with debugging Starsim runs |
demographics | Define pregnancy, deaths, migration, etc. |
diseases | Base classes for diseases |
distributions | Define random-number-safe distributions. |
interventions | Define interventions, which are used to modify the state of the sim during run. |
loop | Parent class for the integration loop. |
modules | General module class – base class for diseases, interventions, etc. Also |
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. |
sim | Define core Sim classes |
time | Functions and classes for handling time |
timeline | Simulation and module timelines |
utils | Numerical utilities and other helper functions |