Predefined Datasets

Table 7.1 lists dataset classes that are predefined in urbansim (in alphabetical order), including the default value for dataset_name, in_table_name, id_name and name of the module in which the class is implemented (excluding '.py'). In most cases they correspond to database tables described in Chapter . The corresponding table name is the value of in_table_name.

Table 7.1: Datasets defined in urbansim. A dataset marked with * is a location set, i.e. it represents a set of locations of a specific geographical unit and can be visualized as a two-dimensional image.

dataset_name	in_table_name (default)	id_name (default)
city*	cities	city_id
building	buildings	building_id
building_type	building_types	building_type_id
control_total (households)	annual_household_control_totals	year
control_total (jobs)	annual_employment_control_totals	year, sector_id
county*	counties	county_id
development_constraint	development_constraints	constraint_id
development_event	development_events_exogenous	grid_id, scheduled_year
development_event_history	development_event_history	grid_id, scheduled_year
development_group	development_type_groups	group_id
development_project	-	project_id
development_type	development_types,	development_type_id
	development_type_group_definitions
employment_sector	sector_id	employment_sectors
employment_sector_group	employment_adhoc_sector_groups	group_id
faz*	fazes	faz_id
fazdistrict*	-	fazdistrict_id
gridcell*	gridcells	grid_id
household_characteristic	household_characteristics_for_ht	-
household	households	household_id
job_building_type	job_building_types	id
job	jobs	job_id
large_area*	large_areas	large_area_id
neighborhood*	neighborhoods	neighborhood_id
plan_type	plan_types	plan_type_id
plan_type_group	plan_type_groups	group_id
race	race_names	race_id
rate (households)	annual_relocation_rates_for_households	age_min, income_min
rate (jobs)	annual_relocation_rates_for_jobs	sector_id
region	regions	region_id
ring	rings	ring_id
target_vacancy	target_vacancies	year
travel_data	travel_data	from_zone_id, to_zone_id
vacant_land_and_building_type
zone*	zones	zone_id

In addition, they are a few interaction sets defined in urbansim, listed in Table 7.2. The dataset name of such interaction set is created automatically from the names of the two interacting datasets.

Table 7.2: Interaction datasets defined in urbansim.

dataset_name

development_project_x_gridcell

household_x_gridcell

household_x_neighborhood

household_x_zone

job_x_gridcell