Model Configuration

In the parcel version of UrbanSim, the model is initialized as follows:

submodel_string

- 'land_use_type_id'

outcome_attribute

- 'ln_unit_price=ln(urbansim_parcel.parcel.unit_price)'

filter_attribute

- 'numpy.logical_or(urbansim_parcel.parcel.building_sqft, urbansim_parcel.parcel.is_land_use_type_vacant)'

In the zone version of UrbanSim, the model is initialized as follows:

submodel_string

- 'building_type_id'

outcome_attribute

- 'ln_unit_price=ln(pseudo_building.avg_value)'

Remaining arguments in both cases get the default values of the model constructor.

The run() method is called by passing the following arguments:

specification

- An EquationSpecification object created with data from table ``real_estate_price_model_specification''.

coefficients

- A Coefficients object created with data from table ``real_estate_price_model_coefficients''.

dataset

- For parcel projects, this is an instance of class ParcelDataset created with data from table ``parcels''. For zone projects, this is an instance of class PseudoBuildingDataset.

index

- None. Thus, the model runs on all members of dataset which are in case of the parcel project filtered using the filter passed to the constructor.

run_config

- For zone projects it is None. For parcel projects it has entries:

{
  'exclude_outliers_from_initial_error': True, 
  'outlier_is_less_than': 3, 
  'outlier_is_greater_than': 7
}