API reference#

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

`base`	The module contains frequently-used functions that do not neatly fit into other areas of the code base.
`config`	This module sets the location of the data folder and other global settings.
`contact_networks`	This module generates the household, school, and workplace contact networks.
`data_distributions`	Read in data distributions.
`data`
`defaults`	Defaults for synthpops files and data types.
`households`	Functions for generating households
`ltcfs`	Modeling Seattle Metro Long Term Care Facilities
`plotting`	This module provides plotting methods including methods to plot the age-specific contact matrix in different contact layers.
`pop`	This module provides the main class for interacting with SynthPops, the Pop class.
`sampling`	Sample distributions, either from real world data or from uniform distributions.
`schools`	This module generates school contacts by class and grade in flexible ways.
`workplaces`