SynthPops
latest
Installation
SynthPops overview
What’s new
SynthPops algorithm
Using SynthPops
API reference
Glossary
SynthPops
IDM docs
»
SynthPops
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
add_contacts() (BasePeople method)
add_household() (in module synthpops.households)
(Pop method)
add_layer() (Contacts method)
add_ltcf() (in module synthpops.ltcfs)
(Pop method)
add_school() (Pop method)
add_workplace() (in module synthpops.workplaces)
(Pop method)
age_range (SchoolTypeByAge attribute)
agent-based model
append() (Layer method)
are_location_constraints_satisfied() (in module synthpops.data)
assign_facility_staff() (in module synthpops.ltcfs)
assign_uids_by_homes() (in module synthpops.households)
axis (plotting_kwargs attribute)
B
BasePeople (class in synthpops.people.people)
binned_values_dist() (in module synthpops.base)
brief() (FlexPretty method)
C
calculate_contact_matrix() (in module synthpops.plotting)
calculate_location_filename() (in module synthpops.data_distributions)
calculate_location_filepath() (in module synthpops.data_distributions)
calculate_which_nbrackets_to_use() (in module synthpops.data_distributions)
check_all_probability_distribution_nonnegative() (in module synthpops.data)
check_all_probability_distribution_sums() (in module synthpops.data)
check_array_of_array_entry_lens_arr() (in module synthpops.data)
check_array_of_arrays_entry_lens() (in module synthpops.data)
check_dist() (in module synthpops.sampling)
check_employment_rates_by_age() (in module synthpops.data)
check_enrollment_rates_by_age() (in module synthpops.data)
check_household_head_age_brackets() (in module synthpops.data)
check_household_head_age_distributions_by_family_size() (in module synthpops.data)
check_household_size_distribution() (in module synthpops.data)
check_location_constraints_satisfied() (in module synthpops.data)
check_location_name() (in module synthpops.data)
check_ltcf_num_residents_distribution() (in module synthpops.data)
check_ltcf_num_staff_distribution() (in module synthpops.data)
check_ltcf_resident_to_staff_ratio_distribution() (in module synthpops.data)
check_normal() (in module synthpops.sampling)
check_poisson() (in module synthpops.sampling)
check_population_age_distributions() (in module synthpops.data)
check_probability_distribution_nonnegative() (in module synthpops.data)
check_probability_distribution_nonnegative_age_distributions() (in module synthpops.data)
check_probability_distribution_sum() (in module synthpops.data)
check_probability_distribution_sum_age_distributions() (in module synthpops.data)
check_school_size_brackets() (in module synthpops.data)
check_school_size_distribution() (in module synthpops.data)
check_school_size_distribution_by_type() (in module synthpops.data)
check_school_types_by_age() (in module synthpops.data)
check_truncated_poisson() (in module synthpops.sampling)
check_valid_probability_distributions() (in module synthpops.data)
check_workplace_size_counts_by_num_personnel() (in module synthpops.data)
checkmem() (in module synthpops.config)
choose (in module synthpops.people.utils)
choose_r (in module synthpops.people.utils)
citations (Location attribute)
Classroom (class in synthpops.schools)
clean_up_layer_info() (Pop method)
compute_information() (Pop method)
compute_layer_degree_description() (in module synthpops.contact_networks)
compute_summary() (Pop method)
contact layers
Contacts (class in synthpops.people.people)
convert_df_to_json_array() (in module synthpops.data)
count() (BasePeople method)
count_ages() (in module synthpops.base)
count_binned_values() (in module synthpops.base)
count_employment_by_age() (in module synthpops.workplaces)
(Pop method)
count_enrollment_by_age() (in module synthpops.schools)
(Pop method)
count_enrollment_by_school_type() (in module synthpops.schools)
(Pop method)
count_household_head_ages() (Pop method)
count_household_sizes() (Pop method)
count_layer_degree() (in module synthpops.contact_networks)
count_ltcf_sizes() (Pop method)
count_not() (BasePeople method)
count_pop_ages() (Pop method)
count_values() (in module synthpops.base)
count_workplace_sizes() (Pop method)
create_reduced_contacts_with_group_types() (in module synthpops.contact_networks)
D
data_provenance_notices (Location attribute)
default_datadir_path() (in module synthpops.defaults)
default_plotting_kwargs() (plotting_kwargs method)
defined() (BasePeople method)
disp() (FlexPretty method)
distribution (PopulationAgeDistribution attribute)
E
edge
employment_rates_by_age (Location attribute)
(Pop attribute)
enrollment_rates_by_age (Location attribute)
(Pop attribute)
F
false() (BasePeople method)
fast_choice() (in module synthpops.sampling)
filter_people() (in module synthpops.contact_networks)
find_contacts (in module synthpops.people.utils)
find_contacts() (Layer method)
FlexDict (class in synthpops.people.people)
FlexPretty (class in synthpops.people.people)
from_df() (Layer method)
from_people() (BasePeople method)
G
generate() (Pop method)
generate_age_count() (in module synthpops.households)
generate_age_count_multinomial() (in module synthpops.households)
generate_all_households_fixed_ages() (in module synthpops.households)
generate_all_households_infer_ages() (in module synthpops.households)
generate_household_head_ages() (in module synthpops.households)
generate_household_size_count_from_fixed_pop_size() (in module synthpops.households)
generate_household_sizes() (in module synthpops.households)
generate_larger_households_fixed_ages() (in module synthpops.households)
generate_larger_households_infer_ages() (in module synthpops.households)
generate_ltcfs() (in module synthpops.ltcfs)
generate_synthetic_population() (in module synthpops.pop)
get() (BasePeople method)
get_age_by_brackets() (in module synthpops.base)
get_age_distribution() (in module synthpops.people.loaders)
get_aggregate_ages() (in module synthpops.base)
get_aggregate_matrix() (in module synthpops.base)
get_all_households() (in module synthpops.households)
get_asymmetric_matrix() (in module synthpops.base)
get_bin_edges() (in module synthpops.base)
get_bin_labels() (in module synthpops.base)
get_census_age_brackets() (in module synthpops.data_distributions)
get_classroom() (Pop method)
(School method)
get_contact_counts_by_layer() (in module synthpops.contact_networks)
(Pop method)
get_contact_matrices() (in module synthpops.data_distributions)
get_contact_matrix() (in module synthpops.data_distributions)
get_country_aliases() (in module synthpops.people.loaders)
get_default_school_size_distr_brackets() (in module synthpops.data_distributions)
get_default_school_size_distr_by_type() (in module synthpops.data_distributions)
get_default_school_type_age_ranges() (in module synthpops.data_distributions)
get_default_school_types_by_age_single() (in module synthpops.data_distributions)
get_default_school_types_distr_by_age() (in module synthpops.data_distributions)
get_employment_rates() (in module synthpops.data_distributions)
get_employment_rates_by_age() (in module synthpops.workplaces)
get_enrollment_rates_by_age() (in module synthpops.schools)
get_expected_density() (in module synthpops.contact_networks)
get_generated_household_size_distribution() (in module synthpops.households)
get_generated_school_size_distributions() (in module synthpops.schools)
get_generated_workplace_size_distribution() (in module synthpops.workplaces)
get_head_age_brackets() (in module synthpops.data_distributions)
get_head_age_by_size_distr() (in module synthpops.data_distributions)
get_household() (in module synthpops.households)
(Pop method)
get_household_head_ages() (Pop method)
get_household_head_ages_by_size() (in module synthpops.households)
(Pop method)
get_household_heads() (in module synthpops.households)
(Pop method)
get_household_size() (in module synthpops.people.loaders)
get_household_size_distr() (in module synthpops.data_distributions)
get_household_sizes() (in module synthpops.households)
(Pop method)
get_ids_by_age() (in module synthpops.base)
get_index_by_brackets() (in module synthpops.base)
get_list_properties() (Location method)
get_location_attr() (in module synthpops.data)
get_long_term_care_facility_resident_to_staff_ratios_brackets() (in module synthpops.data_distributions)
get_long_term_care_facility_resident_to_staff_ratios_distr() (in module synthpops.data_distributions)
get_long_term_care_facility_residents_distr() (in module synthpops.data_distributions)
get_long_term_care_facility_residents_distr_brackets() (in module synthpops.data_distributions)
get_long_term_care_facility_use_rates() (in module synthpops.data_distributions)
get_ltcf() (in module synthpops.ltcfs)
(Pop method)
get_ltcf_sizes() (in module synthpops.ltcfs)
(Pop method)
get_nbrackets() (in module synthpops.data_distributions)
get_population_age_distribution() (Location method)
get_relative_path() (in module synthpops.data)
(in module synthpops.data_distributions)
get_school() (Pop method)
get_school_enrollment_rates() (in module synthpops.data_distributions)
get_school_size_brackets() (in module synthpops.data_distributions)
get_school_size_distr_by_brackets() (in module synthpops.data_distributions)
get_school_size_distr_by_type() (in module synthpops.data_distributions)
get_school_type_age_ranges() (in module synthpops.data_distributions)
get_school_type_labels() (in module synthpops.schools)
get_smoothed_single_year_age_distr() (in module synthpops.data_distributions)
get_state_postal_code() (in module synthpops.data_distributions)
get_workplace() (in module synthpops.workplaces)
(Pop method)
get_workplace_size_brackets() (in module synthpops.data_distributions)
get_workplace_size_distr_by_brackets() (in module synthpops.data_distributions)
get_workplace_sizes() (in module synthpops.workplaces)
(Pop method)
H
Household (class in synthpops.households)
household contact layer
household_head_age_brackets (Location attribute)
household_head_age_distribution_by_family_size (Location attribute)
household_size_distribution (Location attribute)
I
indices() (BasePeople method)
init_contacts() (BasePeople method)
initialize() (plotting_kwargs method)
initialize_empty_households() (in module synthpops.households)
(Pop method)
initialize_empty_ltcfs() (in module synthpops.ltcfs)
(Pop method)
initialize_empty_schools() (Pop method)
initialize_empty_workplaces() (in module synthpops.workplaces)
(Pop method)
initialize_households_list() (Pop method)
initialize_ltcfs_list() (Pop method)
initialize_schools_list() (Pop method)
initialize_workplaces_list() (Pop method)
items() (FlexDict method)
K
keys() (BasePeople method)
(FlexDict method)
L
Layer (class in synthpops.people.people)
layer_keys() (BasePeople method)
LayerGroup (class in synthpops.base)
load() (Pop static method)
load_location() (in module synthpops.data_distributions)
load_location_from_filepath() (in module synthpops.data)
load_location_from_json() (in module synthpops.data)
load_location_from_json_str() (in module synthpops.data)
location
Location (class in synthpops.data)
location_name (Location attribute)
lock() (BasePeople method)
LongTermCareFacility (class in synthpops.ltcfs)
ltcf_num_residents_distribution (Location attribute)
ltcf_num_staff_distribution (Location attribute)
ltcf_resample_age() (in module synthpops.ltcfs)
ltcf_resident_to_staff_ratio_distribution (Location attribute)
ltcf_use_rate_distribution (Location attribute)
M
make_contacts() (in module synthpops.contact_networks)
make_edgelist() (BasePeople method)
make_hybrid_contacts() (in module synthpops.people.makepop)
make_microstructured_contacts() (in module synthpops.people.makepop)
make_people() (in module synthpops.people.makepop)
make_population() (in module synthpops.pop)
make_random_contacts() (in module synthpops.people.makepop)
make_randpop() (in module synthpops.people.makepop)
make_title() (plotting_kwargs method)
map_entries() (in module synthpops.people.loaders)
member_ages() (Classroom method)
(LayerGroup method)
(LongTermCareFacility method)
(School method)
member_uids (Classroom attribute)
(LongTermCareFacility attribute)
(School attribute)
members (Layer attribute)
meta_keys() (Layer method)
N
n_multinomial() (in module synthpops.people.utils)
n_neg_binomial() (in module synthpops.people.utils)
n_poisson (in module synthpops.people.utils)
node
non_teaching_staff_ages() (School method)
norm_age_group() (in module synthpops.base)
norm_dic() (in module synthpops.base)
notes (Location attribute)
num_bins (PopulationAgeDistribution attribute)
P
parent (Location attribute)
parse_synthpop() (in module synthpops.people.makepop)
People (class in synthpops.people.people)
Person (class in synthpops.people.people)
person() (BasePeople method)
plot() (People method)
plot_ages() (in module synthpops.plotting)
(Pop method)
plot_array() (in module synthpops.plotting)
plot_contact_counts() (in module synthpops.plotting)
(Pop method)
plot_contacts() (in module synthpops.plotting)
(Pop method)
plot_employment_rates_by_age() (in module synthpops.plotting)
(Pop method)
plot_enrollment_rates_by_age() (in module synthpops.plotting)
(Pop method)
plot_graph() (People method)
plot_household_head_ages_by_size() (in module synthpops.plotting)
(Pop method)
plot_household_sizes() (in module synthpops.plotting)
(Pop method)
plot_ltcf_resident_sizes() (in module synthpops.plotting)
(Pop method)
plot_people() (Pop method)
plot_school_sizes() (in module synthpops.plotting)
(Pop method)
plot_workplace_sizes() (in module synthpops.plotting)
(Pop method)
plotting_kwargs (class in synthpops.plotting)
poisson (in module synthpops.people.utils)
Pop (class in synthpops.pop)
pop_inds() (Layer method)
pop_item() (Pop method)
pop_layer() (Contacts method)
populate_all_classrooms() (Pop method)
populate_households() (in module synthpops.households)
(Pop method)
populate_ltcfs() (in module synthpops.ltcfs)
(Pop method)
populate_parent_data() (in module synthpops.data)
populate_parent_data_from_file_path() (in module synthpops.data)
populate_parent_data_from_json_obj() (in module synthpops.data)
populate_schools() (Pop method)
populate_workplaces() (in module synthpops.workplaces)
(Pop method)
population_age_distributions (Location attribute)
PopulationAgeDistribution (class in synthpops.data)
R
random_graph_model() (in module synthpops.contact_networks)
read_age_bracket_distr() (in module synthpops.data_distributions)
reference_links (Location attribute)
remove_duplicates() (BasePeople static method)
remove_ltcf_residents_from_potential_workers() (in module synthpops.ltcfs)
resample_age() (in module synthpops.sampling)
reset_default_settings() (in module synthpops.defaults)
reset_settings() (in module synthpops.defaults)
reset_settings_by_key() (in module synthpops.defaults)
resident_ages() (LongTermCareFacility method)
restore_defaults() (plotting_kwargs method)
S
sample_from_range() (in module synthpops.sampling)
sample_single_arr() (in module synthpops.sampling)
sample_single_dict() (in module synthpops.sampling)
sanitize_location() (in module synthpops.data_distributions)
save() (Pop method)
save_location_to_filepath() (in module synthpops.data)
School (class in synthpops.schools)
school contact layer
school_size_brackets (Location attribute)
school_size_distribution (Location attribute)
school_size_distribution_by_type (Location attribute)
school_type (SchoolSizeDistributionByType attribute)
(SchoolTypeByAge attribute)
school_types_by_age (Location attribute)
SchoolSizeDistributionByType (class in synthpops.data)
SchoolTypeByAge (class in synthpops.data)
set() (BasePeople method)
set_datadir() (in module synthpops.config)
set_default_pop_pars() (plotting_kwargs method)
set_figure_display_size() (plotting_kwargs method)
set_font() (plotting_kwargs method)
set_layer_classes() (Pop method)
set_layer_group() (LayerGroup method)
set_location_defaults() (in module synthpops.config)
set_nbrackets() (in module synthpops.config)
set_pars() (BasePeople method)
set_seed() (in module synthpops.sampling)
show_locations() (in module synthpops.people.loaders)
size_distribution (SchoolSizeDistributionByType attribute)
staff_ages() (LongTermCareFacility method)
statistic_test() (in module synthpops.sampling)
story() (People method)
student_ages() (Classroom method)
(School method)
summarize() (BasePeople method)
(Pop method)
synthpops (module)
synthpops.base (module)
synthpops.config (module)
synthpops.contact_networks (module)
synthpops.data (module)
synthpops.data_distributions (module)
synthpops.defaults (module)
synthpops.households (module)
synthpops.ltcfs (module)
synthpops.people (module)
synthpops.people.country_age_data (module)
synthpops.people.household_size_data (module)
synthpops.people.loaders (module)
synthpops.people.makepop (module)
synthpops.people.people (module)
synthpops.people.state_age_data (module)
synthpops.people.utils (module)
synthpops.plotting (module)
synthpops.pop (module)
synthpops.sampling (module)
synthpops.schools (module)
synthpops.version (module)
synthpops.workplaces (module)
T
teacher_ages() (Classroom method)
(School method)
time step
to_arr() (BasePeople method)
to_df() (BasePeople method)
(Layer method)
to_dict() (Pop method)
to_graph() (BasePeople method)
(Contacts method)
(Layer method)
to_json() (Pop method)
to_people() (BasePeople method)
(Pop method)
true() (BasePeople method)
U
undefined() (BasePeople method)
unlock() (BasePeople method)
update() (Layer method)
update_defaults() (plotting_kwargs method)
V
validate() (BasePeople method)
(Classroom method)
(Household method)
(Layer method)
(LayerGroup method)
(LongTermCareFacility method)
(School method)
(Workplace method)
validate_datadir() (in module synthpops.config)
values() (FlexDict method)
version_info() (in module synthpops.config)
W
Workplace (class in synthpops.workplaces)
workplace contact layer
workplace_size_counts_by_num_personnel (Location attribute)