Bulk upload of constraints

Constraints can be bulk uploaded into the platform through a request here. The data schema below must be followed for the upload to occur. Constraints can either be uploaded as a CSV file or as a zipped (.zip) shapefile of polygons. CSV files and shapefiles use different methods to connect constraints to parcels, see below for details on the methods available:

Note

The ability to bulk upload constraints is not yet available in the user interface. If you would like to upload your constraints, please format them to fit the data schema and send the data with a request here.

Connecting constraints to parcels

Three methods are available to connect your constraints to specific parcels. The set of constraints to upload should be formatted to only utilize one method:

1. CSV: use a parcel_id column to directly associate the constraint with the primary_id of parcel polygons. This is the preferred and most accurate method of association. The parcel_id must correspond exactly to the primary_id in the uploaded parcel geometry shapefile. For constraints that are associated with more than one parcel ID, denote multiple parcels using a semicolon ; as a delimiter, for example: 448878; 425091

2. CSV: use columns x (longitude) and y (latitude) to hold coordinates of the constraint address or centroid to associate with the intersecting parcel, primary_id. Coordinates must be in the World Geodetic System 1984 (WGS84) coordinate system.

3. Shapefile: use polygons denoting the constraint area to associate the constraint with intersecting parcel polygons, primary_id. Constraint polygon intersection occurs using a within parcel polygon centroid method.

Each method requires a different data schema for specific columns to include in your file to upload, see below:

Constraints as CSV Method 1: parcel_id columns

Column Name	Data Type	Required	Description
parcel_id	Integer	Yes	parcel_id must correspond exactly to the primary_id in the uploaded parcel geometry shapefile. For constraints that are associated with more than one parcel id, denote multiple parcels using a semicolon ; as a delimiter, for example: 448878; 425091

Constraints as CSV Method 2: xy coordinate columns

Column Name	Data Type	Required	Description
x	Float	Yes	Longitude coordinate of constraint address or centroid.
y	Float	Yes	Latitude coordinate of constraint address or centroid.

Constraints attribute data schema

A basic set of columns are required to upload constraints and are identical to those required in the user interface constraints. Note for Australian users: Localization for regions based in Australia should use the term FAR instead of plot ratio for bulk uploaded constraints. Required and optional columns and their data schema are described below:

Constraints as CSV:

Column Name	Data Type	Unit	Required	Description
zoning_id	Integer		Yes	Unique identifier for the zoning designation
name	String		Yes	Name of zoning designation
zoning_code	String		No	Zoning designation code
start_year	Float		Yes	The year in which the constraints begin in the simulation. Constraint will persist until either the end of the simulation or until overridden by another constraint.
min_far	Float		No	Minimum floor-area ratio
max_far	Float		Yes	Maximum floor-area ratio
min_dua	Float	Units per acre or hectare	No	Minimum dwelling units per acre or hectare
max_dua	Float	Units per acre or hectare	Yes	Maximum dwelling units per acre or hectare
max_height	Float	Feet or meters	No	Maximum building height
min_front_setback	Float	Feet or meters	No	Minimum front setback
max_front_setback	Float	Feet or meters	No	Maximum front setback
rear_setback	Float	Feet or meters	No	Rear setback
side_setback	Float	Feet or meters	No	Side setback
coverage	Float	0-100%	No	Proportion of parcel land area that can be developed
allowed_building_types	String		Yes	Semicolon (;) delimited list of building_type_id’s that are allowed. For example: 30; 45. building_type_id’s must correspond to the IDs in the building types table’s. To denote no building type restriction use All and to denote all building types are prohibited use None
tags	String		Yes	Tags to use to link with scenarios. For setting more than one tag on a constraint, list the tags and separate each one using a semicolon ; as a delimiter, for example: Baseline; High growth
notes	String		No	Notes can be added to include any other pertinent information for context such as overlay or special district information or jurisdiction reference.