Datasets

All datasets defined in urbansim are implemented as children of the Opus opus_core class Dataset described in Section 6.1. Each dataset sets default values for several class properties, such as a name of the unique identifier (id_name), dataset name (dataset_name), in_table_name and out_table_name.

The urbansim datasets are defined in urbansim.datasets. We use the following naming convention: For module name we use the dataset name in lower case in singular form, where single words are connected by '_', and ending with ``_dataset''. For class name we capitalize the first letters in each word of the dataset name, use singular form and add 'Dataset' at the end. For example, a dataset for development projects is defined in class DevelopmentProjectDataset implemented in the module development_project_dataset.py. For interaction sets, we connect the two dataset names in the same way, but with an 'x' in the module name and an 'X' in the class name. For example, an interaction set of development projects and gridcells is defined in DevelopmentXProjectGridcellDataset implemented in development_project_x_gridcell_dataset.py.