Model Configuration

The run() method of this class expects a dictionary model_configuration as an argument. This object must contain an entry ``development_project_types'' which is also a dictionary. The name of each element is a project type and value is again a dictionary. Entries on this level are ``units'', ``categories'', and ``residential''. Entry ``units'' gives the name of the attribute that determines sizes of projects. An attribute of the same name must be contained in the location_set and in the dataset with the historical data. Entry ``categories'' determines categories of a project set. It can be an empty array if categories are not used. Entry ``residential'' is a boolean value determining if vacancy of this project type should be compared to the residential vacancy rate or not. In the latter case, it is compared to the non-residential vacancy rate.

The model is used in the gridcell version of UrbanSim only. Here, the method run() is called using the following arguments:

model_configuration

- The default configuration for project types in configs/general_configuration.py is

{
    'development_project_types':{
        'residential':{
            'units':'residential_units',
            'categories':array([1, 2, 3, 5, 10, 20]),
            'residential':True,
            },
        'commercial':{
            'units':'commercial_sqft',
            'categories': array([1000, 2000, 5000, 10000]),
            'residential':False,
            },
        'industrial':{
            'units':'industrial_sqft',
            'categories': array([1000, 2000, 5000, 10000]),
            'residential':False,
            },
        }
}

vacancy_table

- An object of class TargetVacancyDataset created with data from table ``target_vacancies'' (see Section 16.8.2 for the table structure).

history_table

- An object of class DevelopmentEventDataset created with data from table ``development_event_history'' (see Section 17.3.2 for the table structure).

location_set

- An instance of class GridcellDataset created with data from table ``gridcells'' (see Section 17.1 for the table structure).