Welcome to SynthPops#
Note: SynthPops is no longer actively maintained.
SynthPops is used construct synthetic networks of people that satisfy statistical properties of real-world populations (such as the age distribution, household size, etc.). SynthPops can create generic populations with different network characteristics, as well as synthetic populations that interact in different layers of a multilayer contact network. These synthetic populations can then be used with agent-based models like COVID-19 Agent-based Simulator (Covasim) to simulate epidemics. SynthPops is available on GitHub. For more information on Covasim see Covasim on GitHub.
- Installation
- SynthPops overview
- What’s new
- SynthPops algorithm
- Using SynthPops
- API reference
- base
- config
- contact_networks
- data_distributions
- calculate_location_filename
- calculate_location_filepath
- calculate_which_nbrackets_to_use
- get_census_age_brackets
- get_contact_matrices
- get_contact_matrix
- get_default_school_size_distr_brackets
- get_default_school_size_distr_by_type
- get_default_school_type_age_ranges
- get_default_school_types_by_age_single
- get_default_school_types_distr_by_age
- get_employment_rates
- get_head_age_brackets
- get_head_age_by_size_distr
- get_household_size_distr
- get_long_term_care_facility_resident_to_staff_ratios_brackets
- get_long_term_care_facility_resident_to_staff_ratios_distr
- get_long_term_care_facility_residents_distr
- get_long_term_care_facility_residents_distr_brackets
- get_long_term_care_facility_use_rates
- get_nbrackets
- get_relative_path
- get_school_enrollment_rates
- get_school_size_brackets
- get_school_size_distr_by_brackets
- get_school_size_distr_by_type
- get_school_type_age_ranges
- get_smoothed_single_year_age_distr
- get_state_postal_code
- get_workplace_size_brackets
- get_workplace_size_distr_by_brackets
- load_location
- read_age_bracket_distr
- sanitize_location
- data
- Location
- PopulationAgeDistribution
- SchoolSizeDistributionByType
- SchoolTypeByAge
- are_location_constraints_satisfied
- check_all_probability_distribution_nonnegative
- check_all_probability_distribution_sums
- check_array_of_array_entry_lens_arr
- check_array_of_arrays_entry_lens
- check_employment_rates_by_age
- check_enrollment_rates_by_age
- check_household_head_age_brackets
- check_household_head_age_distributions_by_family_size
- check_household_size_distribution
- check_location_constraints_satisfied
- check_location_name
- check_ltcf_num_residents_distribution
- check_ltcf_num_staff_distribution
- check_ltcf_resident_to_staff_ratio_distribution
- check_population_age_distributions
- check_probability_distribution_nonnegative
- check_probability_distribution_nonnegative_age_distributions
- check_probability_distribution_sum
- check_probability_distribution_sum_age_distributions
- check_school_size_brackets
- check_school_size_distribution
- check_school_size_distribution_by_type
- check_school_types_by_age
- check_valid_probability_distributions
- check_workplace_size_counts_by_num_personnel
- convert_df_to_json_array
- get_location_attr
- get_relative_path
- load_location_from_filepath
- load_location_from_json
- load_location_from_json_str
- populate_parent_data
- populate_parent_data_from_file_path
- populate_parent_data_from_json_obj
- save_location_to_filepath
- defaults
- households
- Household
- add_household
- assign_uids_by_homes
- generate_age_count
- generate_age_count_multinomial
- generate_all_households_fixed_ages
- generate_all_households_infer_ages
- generate_household_head_ages
- generate_household_size_count_from_fixed_pop_size
- generate_household_sizes
- generate_larger_households_fixed_ages
- generate_larger_households_infer_ages
- get_all_households
- get_generated_household_size_distribution
- get_household
- get_household_head_ages_by_size
- get_household_heads
- get_household_sizes
- initialize_empty_households
- populate_households
- ltcfs
- plotting
- pop
- sampling
- schools
- workplaces
- Glossary