Skip to main content
Back to top
Ctrl
+
K
Installation
SynthPops overview
What’s new
SynthPops algorithm
Using SynthPops
More
API reference
Glossary
Search
Ctrl
+
K
Light
Dark
System Settings
Web
GitHub
Search
Ctrl
+
K
Installation
SynthPops overview
What’s new
SynthPops algorithm
Using SynthPops
API reference
Glossary
Light
Dark
System Settings
Web
GitHub
Section Navigation
base
LayerGroup
norm_dic
norm_age_group
get_index_by_brackets
get_age_by_brackets
get_ids_by_age
count_ages
get_aggregate_ages
get_aggregate_matrix
get_asymmetric_matrix
get_bin_edges
get_bin_labels
count_values
count_binned_values
binned_values_dist
config
checkmem
set_nbrackets
set_datadir
validate_datadir
set_location_defaults
version_info
contact_networks
compute_layer_degree_description
count_layer_degree
create_reduced_contacts_with_group_types
filter_people
get_contact_counts_by_layer
get_expected_density
make_contacts
random_graph_model
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
default_datadir_path
reset_default_settings
reset_settings
reset_settings_by_key
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
LongTermCareFacility
add_ltcf
assign_facility_staff
generate_ltcfs
get_ltcf
get_ltcf_sizes
initialize_empty_ltcfs
ltcf_resample_age
populate_ltcfs
remove_ltcf_residents_from_potential_workers
plotting
plotting_kwargs
calculate_contact_matrix
plot_contacts
plot_array
plot_ages
plot_household_sizes
plot_ltcf_resident_sizes
plot_enrollment_rates_by_age
plot_employment_rates_by_age
plot_school_sizes
plot_workplace_sizes
plot_household_head_ages_by_size
plot_contact_counts
pop
Pop
make_population
generate_synthetic_population
sampling
check_dist
check_normal
check_poisson
check_truncated_poisson
fast_choice
resample_age
sample_from_range
sample_single_arr
sample_single_dict
set_seed
statistic_test
schools
School
Classroom
get_school_type_labels
count_enrollment_by_school_type
get_generated_school_size_distributions
count_enrollment_by_age
get_enrollment_rates_by_age
workplaces
Workplace
count_employment_by_age
get_workplace_sizes
get_employment_rates_by_age
get_generated_workplace_size_distribution
get_workplace
add_workplace
initialize_empty_workplaces
populate_workplaces
On this page
validate_datadir()
API reference
config
validate_datadir
validate_datadir
#
validate_datadir
(
verbose
=
True
)
[source]
#
Check that the data folder can be found.
Installation
SynthPops overview
What’s new
SynthPops algorithm
Using SynthPops
API reference
Glossary