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 zones, 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 zones¶
Three methods are available to connect your constraints to specific zones. The set of constraints to upload should be formatted to only utilize one method:
CSV: use a zone_id column to directly associate the constraint with the ID of zone polygons. This is the preferred and most accurate method of association. The zone_id must correspond exactly to the zone_id in the uploaded zone geometry shapefile. For constraints that are associated with more than one zone ID, denote multiple zones using a semicolon ; as a delimiter, for example: 112; 113
CSV: use columns x (longitude) and y (latitude) to hold coordinates of the constraint address or centroid to associate with the intersecting zone, zone_id. Coordinates must be in the World Geodetic System 1984 (WGS84) coordinate system.
Shapefile: use polygons denoting the constraint area to associate the constraint with intersecting zone polygons, zone_id. Development constraint polygon intersection occurs using a within zone polygon centroid method.
Each method requires a different data schema for specific columns to include in your file to upload, see below:
Column Name |
Data Type |
Required |
Description |
---|---|---|---|
zone_id |
Integer |
Yes |
zone_id must correspond exactly to |
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. One of the residential_capacity and or employment_capacity columns are required, however both are not required. Required and optional columns and their data schema are described below:
Column Name |
Data Type |
Unit |
Required |
Description |
---|---|---|---|---|
name |
String |
Yes |
Name of zoning designation |
|
start_year |
Float |
Yes |
The year in which the constraints |
|
residential_capacity |
Integer |
units |
Yes |
Number of residential units |
employment_capacity |
Integer |
jobs |
Yes |
Number of jobs |
allowed_building_types |
String |
Yes |
Semicolon (;) delimited list of building_type_id’s |
|
tags |
String |
Yes |
Tags to use to link with scenarios. For setting |
|
notes |
String |
No |
Notes can be added to include any other pertinent |