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[[tables]]
 61file_type = "csv"
 62table_name = "inflation_adjustment"
 63filepath = "../data/sf_bay_example/observed_calibration_values/inflation_adjustment.csv"
 64index_col = "year"
 65custom_dtype_casting = {"year" = "int", "adjustment" = "float"}
 66
 67## Simultaneous Calibration data
 68### For simultaneous calibration, tables need 
 69### to be manually included here
 70[[tables]]
 71file_type = "csv"
 72table_name = "observed_employment"
 73filepath = "../data/sf_bay_example/observed_calibration_values/employment_obs.csv"
 74index_col = "year"
 75
 76[[tables]]
 77file_type = "csv"
 78table_name = "observed_marrital_data"
 79filepath = "../data/sf_bay_example/observed_calibration_values/marrital_status_over_time_obs.csv"
 80index_col = "year"
 81
 82
 83# Modules configuration
 84[employment_module_config.simultaneous_calibration_config]
 85tolerance = 100
 86max_iter = 20
 87learning_rate = 2
 88momentum_weight = 0.3
 89
 90## Mortality
 91[mortality_module_config.calibration_procedure]
 92procedure_type = "rmse_error"
 93tolerance_type = "absolute"
 94tolerance = 1000
 95max_iter = 1000
 96[mortality_module_config.calibration_procedure.observed_values_table]
 97file_type = "csv"
 98table_name = "observed_fatalities_data"
 99filepath = "../data/sf_bay_example/observed_calibration_values/mortalities_over_time_obs.csv"
100index_col = "year"
101
102## Birth
103[birth_module_config.calibration_procedure]
104procedure_type = "rmse_error"
105tolerance_type = "absolute"
106tolerance = 1000
107max_iter = 1000
108[birth_module_config.calibration_procedure.observed_values_table]
109file_type = "csv"
110table_name = "observed_births_data"
111filepath = "../data/sf_bay_example/observed_calibration_values/births_over_time_obs.csv"
112index_col = "year"
113
114## HH Reorg
115[hh_reorg_module_config]
116geoid_col = "lcm_county_id"
117
118[hh_reorg_module_config.simultaneous_calibration_config]
119tolerance = 5_000
120max_iter = 100
121learning_rate = 2.5
122momentum_weight = 0.3
123
124## HH Rebalancing
125[hh_rebalancing_module_config]
126control_table = "hsize_ct"
127control_col = "hh_size"
128geoid_col = "lcm_county_id"
129
130# Kids Moving
131[kids_moving_module_config]
132geoid_col = "lcm_county_id"
133calibration_target_share = 0.12
134calibration_tolerance = 0.001
135
136## Income
137# The income model was estimated for the base year (2010), so income predictions
138# are in 2010 nominal dollars.  The two fields below tell DEMOS to scale those
139# predictions forward to the current simulation year using the annual inflation
140# rates stored in the `inflation_adjustment` table (loaded above in [[tables]]).
141#
142# To disable inflation adjustment, comment out both fields.
143[income_module_config]
144inflation_reference_year = 2010
145inflation_adjustment_table = "inflation_adjustment"
146
147# Optional: calibrate aggregate predicted income to observed values.
148# Uncomment and fill in the block below to enable calibration.
149# [income_module_config.calibration_procedure]
150# procedure_type = "rmse_error"
151# tolerance_type = "absolute"
152# tolerance = 5000
153# max_iter = 500
154# [income_module_config.calibration_procedure.observed_values_table]
155# file_type = "csv"
156# table_name = "observed_income_data"
157# filepath = "../data/sf_bay_example/observed_calibration_values/income_over_time_obs.csv"
158# index_col = "year"