Bulk upload of development projects

Development projects can be bulk uploaded into the platform through a request here. The data schema below must be followed for the upload to occur. Development projects 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 development projects to zones, see below for details on the methods available:

Note

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

Connecting development projects to zones

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

  1. CSV: use a zone_id column to directly associate the project 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 projects that are associated with more than one zone ID, denote multiple zones using a semicolon ; as a delimiter, for example: 112; 113

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

  3. Shapefile: use polygons denoting the project area to associate the project with intersecting zone polygons, zone_id. Development project 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:

Development Projects as CSV Method 1: zone_id columns

Column Name

Data Type

Required

Description

zone_id

Integer

Yes

zone_id must correspond exactly to
the zone_id in the uploaded zone geometry shapefile.
For projects that are associated with more than one zone id,
denote multiple zones using a semicolon ; as a
delimiter, for example: 112; 113
Development Projects as CSV Method 2: xy coordinate columns

Column Name

Data Type

Required

Description

x

Float

Yes

Longitude coordinate of project address or centroid.

y

Float

Yes

Latitude coordinate of project address or centroid.

Development project attribute data schema

A basic set of columns are required to upload development projects and are identical to those required in the user interface development projects. Required and optional columns and their data schema are described separately below by category for interpretation purposes:

  1. General attributes: Required for all development project records.

  2. Residential building attributes: Required for development project records that are denoted as a is_residential building type (residential) in the building types table.

  3. Non-residential building attributes: Required for development project records that are denoted as a is_non_residential building type (non-residential) in the building types table.

  4. Mixed use building attributes: Required for development project records that are denoted as a being both is_residential and is_non_residential building type (residential and non-residential) in the building types table.

  5. Phased attributes (Optional): Requirement for development project records that should phase the construction of units or space over multiple years. See the development projects section for more on phases.

  6. AMI levels (Required only if project has inclusionary affordable units): Requirement for development project records that have inclusionary affordable units. See the development projects section for more on AMI levels.

General attributes

Regardless of development project building type, these general columns are required where indicated below:

Development Projects as CSV: General attributes

Column Name

Data Type

Required

Description

name

String

Yes

The name of the project.

building_type_id

Integer

Yes

The ID of the project building type. Must
correspond exactly to one building_type_id in the building types table

start_year

Integer

Yes

The construction start year of the
development.

duration

Integer

Yes

Construction duration in months. Must
be greater than 0.

status

String

Yes

The certainty that the project will be
constructed or that it has already been
constructed. Must be exactly one of either:
Committed, Completed, or Proposed

redevelopment

Boolean

Yes

Indicator that development is a
redevelopment. True if development project is
a redevelopment, else False. If True,
all existing residential units and employment
spaces on the selected zones will be removed
and replaced with the values specified in
this development.

tags

String

Yes

Tags to use to link with scenarios. For setting
more than one tag on a project, list the tags and
separate each one using a semicolon ; as
a delimiter, for example: Baseline; High growth

phased

Boolean

Yes

Indicator that development residential units and
or employment spaces are phased over the construction
duration. True if development project is phased,
else False. If phased, record must utilize
the phased data schema

buildings_count

Integer

No

Total number of buildings in the
project. Must be greater than 0.

floors

Integer

No

Average number of floors in the buildings in
the project. Must be greater than 0.

descriptive_location

String

No

General description of project location.

street

String

No

Physical street address of project.

city

String

No

The city the project is located in.

state

String

No

The state or province the project is located in.

zip

String

No

The ZIP or postal code the project is located in.

identification

String

No

User specified identification (ID).
This ID can be different from that used by UrbanSim
and is intended to be used to connect or join the
development data to other external
data sources outside of the platform.

developer

String

No

Name of project developer.

source

String

No

The source of the information on the development
project.

notes

String

No

Notes can be added to include any other pertinent
information for context.

Residential

If the development project is a residential building type, additional columns are required:

Development Projects as CSV: Residential attributes

Column Name

Data Type

Required

Description

residential_units

Integer

Yes

Total number of residential units.
Must be greater than 0.

average_unit_size

Integer

Yes

Average unit size (square feet or square meters) in
the development. Must be greater than 100 sqft or 9 square meters.

market_rate_units

Integer

Yes

Total number of units that will be
market rate. If none exist, set to 0. market_rate_units
and affordable_units cannot both be 0.

affordable_units

Integer

Yes

Total number of units that will be
affordable. If none exist, set to 0. market_rate_units
and affordable_units cannot both be 0.

affordable_program

String

No - Required only
if affordable_units
exist

Type of affordable housing program. Must be
exactly one of either: Inclusionary, Other, or Both. Affordable
programs of Inclusionary and Both types must also have
corresponding AMI level unit columns in this format

own_units

Integer

No

Total number of units that will be owner
occupied. If none exist, set to 0. own_units and
rent_units cannot both be 0.

rent_units

Integer

No

Total number of units that will be renter
occupied. If none exist, set to 0. own_units and
rent_units cannot both be 0.

building_program

String

No

Residential building program specific
to the development project. Must be exactly one of either:
Family, Senior, Veteran, Student, Homeless, or Other.
Additional categories can be added upon request.

group_quarters

String

No

If the project offers group-quarters,
specify the category. Must be exactly one of
either: Assisted Living,
Dormitory, Hospital,
Single room occupancy,
Homeless shelter, or Other.
Additional categories can be
added upon request.

population_or_beds

Integer

No - Required only
if development project
has group-quarters

Total number of people or beds
that can be accommodated
in group-quarters.

Non-residential

If the development project is a non-residential building type, additional columns are required. You may represent jobs using two methods:

Development Projects as CSV: Non-residential attributes - method 1

Column Name

Data Type

Required

Description

non_residential_space

Integer

Yes

Total non-residential square
footage of the development. Must be
greater than 0.

space_per_job

Integer

Yes

Average square feet or square meters per job in
the development. Must be
greater than 100 sqft or 9 square meters.
Development Projects as CSV: Non-residential attributes - method 2

Column Name

Data Type

Required

Description

employment_capacity

Integer

Yes

Total employment capacity
of the development. Must be
greater than 0.

Mixed use

If the development project is a mixed use building type (residential and non-residential), additional columns are required that combine both the residential and non-residential attributes. Note that mixed use projects cannot have 0 or null values for both non_residential_space or employment_capacity and residential_units. You may represent jobs using one of the two methods combined with the residential component below:

Development Projects as CSV: Mixed Use attributes - non-residential component method 1

Column Name

Data Type

Required

Description

non_residential_space

Integer

Yes

Total non-residential square
footage of the development. Mixed use projects
must be greater than or equal to 0.

space_per_job

Integer

Yes

Average square feet or square meters per job in
the development. Must be
greater than 100 sqft or 9 square meters, otherwise if
there is no non_residential_space set to 0.
Development Projects as CSV: Mixed Use attributes - non-residential component method 2

Column Name

Data Type

Required

Description

employment_capacity

Integer

Yes

Total employment capacity
of the development. Mixed use projects must
be greater than or equal to 0.
Development Projects as CSV: Mixed Use attributes - residential component

Column Name

Data Type

Required

Description

residential_units

Integer

Yes

Total number of residential units.
Mixed use projects must be greater than or equal to 0.

average_unit_size

Integer

Yes

Average unit size (square feet or square meters) in
the development. Must be greater than 100 sqft or 9 square meters
if residential_units is greater than 0, otherwise if
there is no residential_units set to 0.

market_rate_units

Integer

Yes

Total number of units that will be
market rate. If none exist, set to 0. market_rate_units
and affordable_units cannot both be 0.

affordable_units

Integer

Yes

Total number of units that will be
affordable. If none exist, set to 0. market_rate_units
and affordable_units cannot both be 0.

affordable_program

String

No - Required only
if affordable_units
exist

Type of affordable housing program. Must be
exactly one of either: Inclusionary, Other, or Both. Affordable
programs of Inclusionary and Both types must also have
corresponding AMI level unit columns in this format

own_units

Integer

No

Total number of units that will be owner
occupied. If none exist, set to 0. own_units and
rent_units cannot both be 0.

rent_units

Integer

No

Total number of units that will be renter
occupied. If none exist, set to 0. own_units and
rent_units cannot both be 0.

building_program

String

No

Residential building program specific
to the development project. Must be exactly one of either:
Family, Senior, Veteran, Student, Homeless, or Other.
Additional categories can be added upon request.

group_quarters

String

No

If the project offers group-quarters,
specify the category. Must be exactly one of
either: Assisted Living,
Dormitory, Hospital,
Single room occupancy,
Homeless shelter, or Other.
Additional categories can be
added upon request.

population_or_beds

Integer

No - Required only
if development project
has group-quarters

Total number of people or beds
that can be accommodated
in group-quarters.

Phased construction

If the development project utilizes the optional phased construction of unit or space over the construction duration, additional columns are required. Only market rate, affordable, non-residential space, and employment capacity can be phased. The general syntax for columns follow this naming rule: “phases_[TYPE OF ATTRIBUTE]_[PHASED YEAR]” for example to phase market rate units over a two year construction period from 2011 to 2012 add the two columns: phases_market_rate_units_2011 and phases_market_rate_units_2012.

Development Projects as CSV: Phased attribute column

Column Name

Data Type

Description

phases_market_rate_units_[PHASED YEAR]

Integer

Total number of
market rate units constructed in phased year.
Phased units must sum across phased years to equal total
market rate units. Phased year must be between
start year and the end of the duration.

phases_affordable_units_[PHASED YEAR]

Integer

Total number of
affordable units constructed in phased year.
Phased units must sum across phased years to equal total
affordable units. Phased year must be between
start year and the end of the duration.

phases_non_residential_space_[PHASED YEAR]

Integer

Total number of
non-residential sqft or square meters constructed in phased year.
Phased space must sum across phased years to
equal total non-residential space. Phased year must
be between start year and the end of the duration.

phases_employment_capacity_[PHASED YEAR]

Integer

Total number of
jobs available in phased year.
Phased jobs must sum across phased years to
equal total jobs. Phased year must
be between start year and the end of the duration.

AMI levels

If the development project has inclusionary or both affordable program unit categories, you must specify the AMI levels of units with additional columns. The general syntax for columns follow this naming rule: “ami_[AMI LEVEL]_units” for example to set two different AMI levels such as 30% and 40% for different numbers of units, add the two columns: ami_30_units and ami_40_units.

Development Projects as CSV: AMI level attribute column

Column Name

Data Type

Description

ami_[AMI LEVEL]_units

Integer

Total number of affordable units at
specified AMI level. Units must sum across AMI levels
to equal total affordable units.