Default Configuration File

This page shows the default demos_config_ref.toml

Default configuration (demos_config_ref.toml)
  1# Global config
  2random_seed = 100
  3base_year = 2010
  4forecast_year = 2019
  5calibrated_models_dir = "../data/sf_bay_example/calibrated_models_coefficients/"
  6inconsistent_persons_table_behavior = "fix"
  7modules = [
  8    "aging",
  9    "fatality",
 10    "household_reorg",
 11    "kids_moving",
 12    "birth",
 13    "education",
 14    "employment",
 15    "income",
 16    "income_adjustment",
 17    "household_rebalancing",
 18    "normalize_table_dtypes",
 19]
 20output_tables = [
 21    "persons",
 22    "households",
 23    "run_times"
 24]
 25initialize_empty_tables = [
 26    "graveyard",
 27    "rebalanced_persons",
 28    "rebalanced_households"
 29]
 30
 31# Data sources
 32## Synthetic population data
 33[[tables]]
 34file_type = "h5"
 35table_name = "persons"
 36filepath = "../data/sf_bay_example/custom_mpo_06197001_model_data.h5"
 37h5_key = "persons"
 38
 39[[tables]]
 40file_type = "h5"
 41table_name = "households"
 42filepath = "../data/sf_bay_example/custom_mpo_06197001_model_data.h5"
 43h5_key = "households"
 44
 45## Other static data tables
 46[[tables]]
 47file_type = "csv"
 48table_name = "income_rates"
 49filepath = "../data/sf_bay_example/observed_calibration_values/income_rates_06197001.csv"
 50index_col = "year"
 51custom_dtype_casting = {"lcm_county_id" = "object", "year" = "int", "rate" = "float"}
 52
 53[[tables]]
 54file_type = "csv"
 55table_name = "hsize_ct"
 56filepath = "../data/sf_bay_example/observed_calibration_values/hsize_ct_06197001.csv"
 57index_col = "year"
 58custom_dtype_casting = {"lcm_county_id" = "object", "year" = "int", "hh_size" = "object", "total_number_of_households" = "int"}
 59
 60## Simultaneous Calibration data
 61### For simultaneous calibration, tables need 
 62### to be manually included here
 63[[tables]]
 64file_type = "csv"
 65table_name = "observed_employment"
 66filepath = "../data/sf_bay_example/observed_calibration_values/employment_obs.csv"
 67index_col = "year"
 68
 69[[tables]]
 70file_type = "csv"
 71table_name = "observed_marrital_data"
 72filepath = "../data/sf_bay_example/observed_calibration_values/marrital_status_over_time_obs.csv"
 73index_col = "year"
 74
 75
 76# Modules configuration
 77[employment_module_config.simultaneous_calibration_config]
 78tolerance = 100
 79max_iter = 20
 80learning_rate = 2
 81momentum_weight = 0.3
 82
 83## Mortality
 84[mortality_module_config.calibration_procedure]
 85procedure_type = "rmse_error"
 86tolerance_type = "absolute"
 87tolerance = 1000
 88max_iter = 1000
 89[mortality_module_config.calibration_procedure.observed_values_table]
 90file_type = "csv"
 91table_name = "observed_fatalities_data"
 92filepath = "../data/sf_bay_example/observed_calibration_values/mortalities_over_time_obs.csv"
 93index_col = "year"
 94
 95## Birth
 96[birth_module_config.calibration_procedure]
 97procedure_type = "rmse_error"
 98tolerance_type = "absolute"
 99tolerance = 1000
100max_iter = 1000
101[birth_module_config.calibration_procedure.observed_values_table]
102file_type = "csv"
103table_name = "observed_births_data"
104filepath = "../data/sf_bay_example/observed_calibration_values/births_over_time_obs.csv"
105index_col = "year"
106
107## HH Reorg
108[hh_reorg_module_config]
109geoid_col = "lcm_county_id"
110
111[hh_reorg_module_config.simultaneous_calibration_config]
112tolerance = 5_000
113max_iter = 100
114learning_rate = 2.5
115momentum_weight = 0.3
116
117## HH Rebalancing
118[hh_rebalancing_module_config]
119control_table = "hsize_ct"
120control_col = "hh_size"
121geoid_col = "lcm_county_id"
122
123# Kids Moving
124[kids_moving_module_config]
125geoid_col = "lcm_county_id"
126calibration_target_share = 0.12
127calibration_tolerance = 0.001