Input File Documentation

There are two input files that need to be defined to use the GeoJSON to Modelica Translator: a GeoJSON file and a System Parameters file.

GeoJSON Documentation

Presently only the building_properties.json of URBANopt’s GeoJSON schemas is leveraged in the GMT.

Building Properties

Bolded elements are required fields.

URBANopt Building

http://json-schema.org/openstudio-urban-modeling/building_properties.json#
Schema for an URBANopt Building object. Fields prefaced with [unused] in the description are placeholders (or informational) and are not actually connected in the GMT.
type	object
properties
id	Unique id used to refer to this feature within this dataset.
	type	string
project_id	[unused] Project which this feature belongs to.
	type	string
type	Type of feature.
	type	string
	enum	Building
source_name	[unused] Name of the original data source.
	type	string
source_id	[unused] Id of the feature in original data source.
	type	string
name	[unused] Feature name.
	type	string
legal_name	[unused] Legal name used to identify this feature.
	type	string
address	[unused] Street address.
	type	string
building_status	[unused] Building status.
	type	string
	enum	Proposed, Existing
detailed_model_filename	[unused] Name of a detailed model which can be loaded from disk as a seed model or complete model. Mapper class decides which measures to disable if this is present.
	type	string
weather_filename	[unused] Name of EPW weather file for this building. Defaults to site’s weather_filename.
	type	string
tariff_filename	[unused] Name of the tariff file for this building. Defaults to site’s tariff_filename.
	type	string
surface_elevation	[unused] The surface elevation (above NAVD88 datum) of the building (ft). This is the elevation of the ground at the building location, any below ground stories will be lower than this. Defaults to site’s surface_elevation.
	type	number
timesteps_per_hour	[unused] Number of timesteps per hour for energy simulations. Defaults to site’s timesteps_per_hour.
	type	integer
	maximum	60
	minimum	1
begin_date	[unused] Date to begin simulation, format YYYY-MM-DD. Defaults to site’s begin_date.
	type	string
end_date	[unused] Date to end simulation, format YYYY-MM-DD. Defaults to site’s end_date.
	type	string
climate_zone	[unused] ASHRAE 169 climate zone. Defaults to site’s climate_zone
	type	string
cec_climate_zone	[unused] CEC Title24 climate zone. Defaults to site’s cec_climate_zone
	type	string
floor_area	Usable floor area (ft^2). Required for residential buildings, this represents conditioned floor area.
	type	number
number_of_stories	The maximum number of building stories, sum of number of above and below ground stories.
	type	integer
number_of_stories_above_ground	The number of building stories above ground. Defaults to number_of_stories. Required for residential buildings.
	type	integer
maximum_roof_height	[unused] Maximum height of the roof relative to surface elevation (ft)
	type	number
roof_type	[unused] The type of roof. Defaults to flat.
	type	string
	enum	Flat, Gable, Hip
foundation_type	#/definitions/foundationType
attic_type	#/definitions/atticType
footprint_area	[unused] Area of the footprint (ft^2). Calculated on export.
	type	number
footprint_perimeter	[unused] Perimeter of the footprint (ft). Calculated on export.
	type	number
year_built	The year construction of the building was completed. Can be in the future to indicate future build out. Defaults to current year.
	type	integer
template	#/definitions/templateType
building_type	#/definitions/buildingType
system_type	#/definitions/systemType
heating_system_fuel_type	#/definitions/heatingSystemFuelType
weekday_start_time	[unused] Weekday operating hours start time in 08:30 format, using 24-hr clock. Leave blank to use default.
	type	string
weekday_duration	[unused] Length of weekend operating hours in 08:30 format, up to 24:00.
	type	string
weekend_start_time	[unused] Weekend operating hours start time in 08:30 format, using 24-hr clock. Leave blank to use default.
	type	string
weekend_duration	[unused] Length of weekend operating hours in 08:30 format, up to 24:00.
	type	string
mixed_type_1	#/definitions/buildingType
mixed_type_1_percentage	[unused] Percentage of 1st mixed building space type. Only used when building_type is Mixed use.
	type	number
	maximum	100
	minimum	0
mixed_type_2	#/definitions/buildingType
mixed_type_2_percentage	[unused] Percentage of 2nd mixed building space type. Only used when building_type is Mixed use.
	type	number
	maximum	100
	minimum	0
mixed_type_3	#/definitions/buildingType
mixed_type_3_percentage	[unused] Percentage of 3rd mixed building space type. Only used when building_type is Mixed use.
	type	number
	maximum	100
	minimum	0
mixed_type_4	#/definitions/buildingType
mixed_type_4_percentage	[unused] Percentage of 4th mixed building space type. Only used when building_type is Mixed use.
	type	number
	maximum	100
	minimum	0
number_of_residential_units	[unused] Total number of residential units in the building. Required for single-family attached and multifamily residential buildings.
	type	integer
number_of_bedrooms	[unused] Total number of bedrooms in the building. Required for residential buildings. Must be divisible by the number of residential units.
	type	integer
exterior_lighting_zone	[unused] Choice of exterior lighting zone.
	type	string
	enum	0 - Undeveloped Areas Parks, 1 - Developed Areas Parks, 2 - Neighborhood, 3 - All Other Areas, 4 - High Activity
onsite_parking_fraction	[unused] Fraction of building parking to include in this model. Choose 1 to include exterior lights for parking in this building model. Choose 0 if parking is modeled separately.
	type	number
	maximum	1
	minimum	0
power_factor	[unused] Ratio of the real power used by building to the apparent power seen by grid.
	type	number
	minimum	0
user_data	[unused] Arbitrary user data
ev_charging	[unused] Should be set to true if EV charging is associated with the building.
	type	boolean
ev_charging_station_type	[unused] Indicates whether EV charging associated with the building is for Typical Home, Public or Work charging station
	type	string
	enum	Typical Home, Typical Public, Typical Work
delay_type	[unused] Adds workplace charging flexibility for different scenarios. Min delay scenario indicates EV charging immediately upon arriving to work, Max delay indicates not charging until necessary thereby shifting EV charging load to later in the day and Min power indicates charging EVs at a minimum rate over the parking event.
	type	string
	enum	Min Delay, Max Delay, Min Power
ev_charging_behavior	[unused] Describes scenarios for EV charging behavior, Business as Usual implies home dominant charging behavior, Free Workplace Charging at Project Site implies peak power draw from EV charging during morning hours due to EV charging at workplaces and Free Workplace Charging Across Metro Area scenario reduces Home EV charging relative to Free Workplace Charging at Project Site for residents who work elsewhere and can charge their vehicles for free at those workplaces.
	type	string
	enum	Business as Usual, Free Workplace Charging at Project Site, Free Workplace Charging Across Metro Area
ev_percent	Denotes the % of vehicles parked at the building that are EVs.
	type	number
ev_curtailment_frac	[unused] Fraction between 0 and 1 that denotes curtailment of EV charging load to better align EV charging with expected energy production from a solar PV system
	type	number
additionalProperties	True
oneOf	properties
	building_type	enum	Single-Family Detached
	properties
	building_type	enum	Single-Family Attached
	properties
	building_type	enum	Multifamily
	properties
	building_type	enum	Single-Family, Multifamily (2 to 4 units), Multifamily (5 or more units), Vacant, Office, Laboratory, Nonrefrigerated warehouse, Food sales, Public order and safety, Outpatient health care, Refrigerated warehouse, Religious worship, Public assembly, Education, Food service, Inpatient health care, Nursing, Lodging, Strip shopping mall, Enclosed mall, Retail other than mall, Service, Mixed use, Uncovered Parking, Covered Parking
definitions
buildingType	[unused] Primary building space type.
	type	string
	enum	Single-Family Detached, Single-Family Attached, Multifamily, Single-Family, Multifamily (2 to 4 units), Multifamily (5 or more units), Vacant, Office, Laboratory, Nonrefrigerated warehouse, Food sales, Public order and safety, Outpatient health care, Refrigerated warehouse, Religious worship, Public assembly, Education, Food service, Inpatient health care, Nursing, Lodging, Strip shopping mall, Enclosed mall, Retail other than mall, Service, Mixed use, Uncovered Parking, Covered Parking, null
systemType	[unused] Building HVAC system type.
	type	string
	enum	PTAC with baseboard electric, PTAC with baseboard gas boiler, PTAC with baseboard district hot water, PTAC with gas unit heaters, PTAC with electric coil, PTAC with gas coil, PTAC with gas boiler, PTAC with no heat, PTAC with district hot water, PTAC with central air source heat pump, PTHP, PSZ-AC with gas coil, PSZ-AC with baseboard electric, PSZ-AC with no heat, PSZ-AC with district hot water, PSZ-AC with central air source heat pump, PSZ-HP, Fan coil district chilled water with no heat, Fan coil district chilled water with boiler, Fan coil district chilled water with central air source heat pump, Fan coil district chilled water with gas unit heaters, Fan coil district chilled water with baseboard electric, Fan coil district chilled water with district hot water, Fan coil chiller with district hot water, Fan coil air-cooled chiller with district hot water, Fan coil chiller with boiler, Fan coil air-cooled chiller with boiler, Fan coil chiller with central air source heat pump, Fan coil air-cooled chiller with central air source heat pump, Fan coil chiller with no heat, DOAS with fan coil district chilled water with no heat, DOAS with fan coil district chilled water and boiler, DOAS with fan coil district chilled water with central air source heat pump, DOAS with fan coil district chilled water with gas unit heaters, DOAS with fan coil district chilled water with baseboard electric, DOAS with fan coil district chilled water with district hot water, DOAS with fan coil chiller with district hot water, DOAS with fan coil air-cooled chiller with district hot water, DOAS with fan coil air-cooled chiller with boiler, DOAS with fan coil chiller with central air source heat pump, DOAS with fan coil air-cooled chiller with central air source heat pump, DOAS with fan coil chiller with no heat, DOAS with VRF, VRF, DOAS with water source heat pumps with ground source heat pump, Forced air furnace, Baseboard district hot water, Baseboard electric, Baseboard gas boiler, Baseboard central air source heat pump, Window AC with no heat, Window AC with forced air furnace, Window AC with baseboard district hot water, Window AC with baseboard electric, Window AC with unit heaters, Window AC with baseboard gas boiler, Window AC with baseboard central air source heat pump, Direct evap coolers with baseboard district hot water, Direct evap coolers with baseboard electric, Direct evap coolers with baseboard gas boiler, Direct evap coolers with baseboard central air source heat pump, Direct evap coolers with no heat, Direct evap coolers with gas unit heaters, Direct evap coolers with forced air furnace, Gas unit heaters, VAV chiller with gas boiler reheat, VAV chiller with gas coil reheat, VAV chiller with central air source heat pump reheat, VAV chiller with PFP boxes, VAV air-cooled chiller with gas boiler reheat, VAV air-cooled chiller with central air source heat pump reheat, VAV air-cooled chiller with district hot water reheat, VAV air-cooled chiller with gas coil reheat, VAV air-cooled chiller with no reheat with gas unit heaters, VAV district chilled water with gas boiler reheat, VAV district chilled water with central air source heat pump reheat, VAV district chilled water with no reheat with zone heat pump, VAV chiller with no reheat with baseboard electric, VAV air-cooled chiller with no reheat with zone heat pump, VAV district chilled water with district hot water reheat, VAV district chilled water with gas coil reheat, PVAV with gas heat with electric reheat, PVAV with central air source heat pump reheat, PVAV with PFP boxes, Residential - electric resistance and no cooling, Residential - electric resistance and central air conditioner, Residential - electric resistance and room air conditioner, Residential - electric resistance and evaporative cooler, Residential - furnace and no cooling, Residential - furnace and central air conditioner, Residential - furnace and room air conditioner, Residential - furnace and evaporative cooler, Residential - boiler and no cooling, Residential - boiler and central air conditioner, Residential - boiler and room air conditioner, Residential - boiler and evaporative cooler, Residential - air-to-air heat pump, Residential - mini-split heat pump, Residential - ground-to-air heat pump
heatingSystemFuelType	[unused] The fuel type of the heating system. This does not apply for certain system types (e.g., electric resistance or heat pumps).
	type	string
	enum	electricity, natural gas, fuel oil, propane, wood
templateType	[unused] Standard template applied to building. Default to site’s default_template
	type	string
	enum	DOE Ref Pre-1980, DOE Ref 1980-2004, 90.1-2004, 90.1-2007, 90.1-2010, 90.1-2013, NREL ZNE Ready 2017, DEER Pre-1975, DEER 1985, DEER 1996, DEER 2003, DEER 2007, DEER 2011, DEER 2014, DEER 2015, DEER 2017, DEER 2020, DEER 2025, DEER 2030, DEER 2035, DEER 2040, DEER 2045, DEER 2050, DEER 2055, DEER 2060, DEER 2065, DEER 2070, DEER 2075, Residential IECC 2006 - Customizable Template Sep 2020, Residential IECC 2009 - Customizable Template Sep 2020, Residential IECC 2012 - Customizable Template Sep 2020, Residential IECC 2015 - Customizable Template Sep 2020, Residential IECC 2018 - Customizable Template Sep 2020
foundationType	[unused] The foundation type of the building. Required for residential buildings.
	type	string
	enum	slab, crawlspace - vented, crawlspace - unvented, basement - unconditioned, basement - conditioned, ambient
atticType	[unused] The attic type of the building. Required for single-family residential buildings.
	type	string
	enum	attic - vented, attic - unvented, attic - conditioned, flat roof

System Parameters Schema

Bolded elements are required fields.

#/definitions/system_design_parameter_def
definitions
system_design_parameter_def	System Design Parameter Schema
	Definition of System Design Parameters. (Version 0.1). Fields prefaced with [unused] in the description are placeholders (or informational) and are not actually connected in the GMT.
	type	object
	properties
	buildings	Parameters for individual buildings.
		type	array
		items	#/definitions/building_def
	connectors	#/definitions/connector_def
	district_system	Parameters associated with district systems.
		type	object
		oneOf	#/definitions/fourth_generation_def
			#/definitions/fifth_generation_def
	weather	Path, relative or absolute, to a weather file for the district in Modelica format (MOS).
		type	string
	topology	defaults
		[unused] Parameters associated with district topologies.
		type	object
		properties
		topology_parameters	Description of topology style
			#/definitions/topology_def
		topology_optimization	Perform topology optimization?
			type	boolean
		cost_function	Cost function to use in topology optimization
			#/definitions/cost_function_definition
		optimization_approach	Approach to use for topology optimization
			#/definitions/optimization_definition
		time_period	Time horizon for topology optimization.This parameter is used only if LCC is used as the cost function.
			type	integer
		discount_rate	Discount rate for topology optimization. This parameter is used only if LCC is used as the cost function.
			type	integer
		convergence_criteria	Convergence criteria used to indicate to the optimization algorithm when to stop. This could represent a number of iterations.
			type	integer
		additionalProperties	False
		dependencies
		topology_optimization	cost_function, optimization_approach, time_period, discount_rate, convergence_criteria
	electrical_grid	#/definitions/electrical_grid_parameters
	photovoltaic_panels	Photovoltaic systems (rooftop or ground mount) associated with the district - from scenario optimization
		type	array
		items	#/definitions/pv_parameters
	wind_turbines	Wind turbines associated with the district - from scenario optimization
		type	array
		items	#/definitions/wind_turbine_parameters
	combined_heat_and_power_systems	Combined heat and power (CHP) systems associated with the district - from scenario optimization
		type	array
		items	#/definitions/combined_heat_and_power_parameters
	capacitor_banks	Capacitor banks associated with the district
		type	array
		items	#/definitions/capacitor_bank_parameters
	substations	Substations associated with the district
		type	array
		items	#/definitions/substation_parameters
	transformers	Transformers associated with the district
		type	array
		items	#/definitions/transformer_parameters
	power_converters	Power converters associated with the district
		type	array
		items	#/definitions/power_converter_parameters
	distribution_lines	Distribution lines associated with the district
		type	array
		items	#/definitions/distribution_line_parameters
	ac_inductive_loads	AC inductive loads associated with the district
		type	array
		items	#/definitions/ac_inductive_load_parameters
	dc_loads	DC loads associated with the district
type		array
items		#/definitions/dc_load_parameters
battery_banks	Battery banks associated with the district
	type	array
	items	#/definitions/battery_bank_parameters
additionalProperties	False
topology_def	defaults
	[unused] Parameters associated with district topologies.
	type	object
	properties
	configuration	type	string
		enum	Radial, Ring, Mesh, Out and Back
	additionalProperties	False
cost_function_definition	defaults
	[unused] Possible cost functions for the topology optimization problem
	type	object
	properties
	cost_function	type	string
		enum	Energy, Life Cycle Cost, Carbon Emissions
	additionalProperties	False
optimization_definition	defaults
	[unused] Optimization approach for the topology optimization problem
	type	object
	properties
	optimization_approach	type	string
		enum	Black box, Gradient-based
	additionalProperties	False
building_def	Specific parameters for each building.
	type	object
	properties
	geojson_id	The GeoJSON ID as defined in the GeoJSON file. This is used to overwrite the default data for a specific building. This option is not used in the default section.
		type	string
	load_model	Type of load model to use for the building.
		type	string
		enum	rc, time_series, time_series_massflow_temperature, spawn
	load_model_parameters	type	object
		properties
		spawn	#/definitions/spawn_model_parameters
		rc	#/definitions/rc_model_parameters
		time_series	#/definitions/time_series_model_parameters
		additionalProperties	False
	ets_model	Energy transfer station model. One side is connected to the district water loops and the other side is connected to the building water loops.
		type	string
		enum	None, Indirect Heating and Cooling, Fifth Gen Heat Pump
	ets_model_parameters	type	object
		additionalProperties	False
		oneOf	#/definitions/ets_indirect_parameters
			#/definitions/fifth_gen_ets_parameters
	photovoltaic_panels	Photovoltaic systems (rooftop or ground mount) associated with the building - from feature optimization
		type	array
		items	#/definitions/pv_parameters
	diesel_generators	Diesel generators associated with the building
		type	array
		items	#/definitions/diesel_generator_parameters
	battery_banks	Battery banks associated with the building
		type	array
		items	#/definitions/battery_bank_parameters
	electric_load	microgrid-related load fields
		properties
		nominal_voltage	Nominal load voltage (V)
			type	number
		max_power	Maximim load power (kW)
			type	number
		max_reactive_power	Maximum reactive power (kvar)
			type	number
connector_def	[unused] Parameters associated with the connectors in a district system.
	type	object
	properties
	pipe_diameter	[unused] Pipe diameter. (m)
		type	number
	pipe_insulation_rvalue	[unused] Pipe insulation R-Value. (m2-K/W)
		type	number
	pipe_location	[unused] Location of the pipe.
		type	string
		enum	Tunnel, Buried
	pipe_material	[unused] Pipe material (to be used for determining surface roughness)
		type	string
		enum	Plastic, Steel
	additionalProperties	False
district_system_def	Parameters associated with the district system.
	type	object
	properties
	return_configuration	[unused] Type of return configuration for the overall district system. MW - not really needed. Just use pipes with supply/return.
		type	string
		enum	Direct Return, Reverse Return
	connection_configuration	[unused] Type of connection of buildings to the loop
		type	string
		enum	Series, Parallel
	central_cooling_plant_parameters	#/definitions/central_cooling_plant_parameters
	central_heating_plant_parameters	#/definitions/central_heating_plant_parameters
	combined_heat_and_power_parameters	#/definitions/combined_heat_and_power_parameters
	additionalProperties	False
ets_indirect_parameters	The parameters associated with the indirect energy transfer station.
	type	object
	properties
	heat_flow_nominal	Nominal heat flow rate. (W)
		type	number
		default	10000
	heat_exchanger_efficiency	Heat exchanger efficiency. (fraction)
		type	number
		default	0.8
	heat_exchanger_primary_pressure_drop	Heat exchanger primary side pressure drop. (Pa)
		type	number
		default	500
	heat_exchanger_secondary_pressure_drop	Heat exchanger secondary side pressure drop. (Pa)
		type	number
		default	500
	nominal_mass_flow_building	Building water nominal flow rate. (kg/s)
		type	number
		default	10
	nominal_mass_flow_district	District water nominal flow rate. (kg/s)
		type	number
		default	10
	valve_pressure_drop	Valve pressure drop. (Pa)
		type	number
		default	6000
	cooling_supply_water_temperature_building	Chilled water supply temperature building side. (C)
		type	number
		default	7
	heating_supply_water_temperature_building	Heating water supply temperature building side. (C)
		type	number
		default	50
	delta_temp_hw_district	Heating water temperature difference on on the district side. (deltaC)
		type	number
		default	20
	delta_temp_hw_building	Design temperature differential on the building side. (deltaC)
		type	number
		default	15
	delta_temp_chw_building	Chilled water temperature difference on the building side. (deltaC)
		type	number
		default	5
	delta_temp_chw_district	Design temperature differential on the district side. (deltaC)
		type	number
		default	8
	cooling_controller_y_max	Controller upper limit
		type	number
		default	1
	cooling_controller_y_min	Controller lower limit
		type	number
		default	0
	heating_controller_y_max	Controller upper limit
		type	number
		default	1
	heating_controller_y_min	Controller lower limit
		type	number
		default	0
spawn_model_parameters	Parameters associated with spawn models.
	type	object
	properties
	temp_setpoint_cooling	Cooling setpoint air temperature. (C)
		type	number
		default	24
	temp_setpoint_heating	Heating setpoint air temperature. (C)
		type	number
		default	20
	temp_hw_supply	Heating water supply temperature. (C)
		type	number
		default	40
	temp_hw_return	Heating water return temperature. (C)
		type	number
		default	35
	temp_chw_supply	Chilled water supply temperature. (C)
		type	number
		default	7
	temp_chw_return	Chilled water return temperature. (C)
		type	number
		default	12
	has_liquid_heating	Whether the building has liquid heating.
		type	boolean
		default	True
	has_liquid_cooling	Whether the building has liquid cooling.
		type	boolean
		default	True
	has_electric_heating	Whether the building has electric heating.
		type	boolean
		default	False
	has_electric_cooling	Whether the building has electric cooling.
		type	boolean
		default	False
	idf_filename	Absolute path or relative path from location where file instance is saved.
		type	string
	thermal_zone_names	List of thermal zones in the Spawn / EnergyPlus model.
		type	array
		items	type	string
	zone_nom_htg_loads	Array of zone nominal heating loads (values should be >0)
		type	array
		items	type	number
	zone_nom_clg_loads	Array of zone nominal cooling loads (values should be <0)
		type	array
		items	type	number
	additionalProperties	False
rc_model_parameters	Parameters associated with RC models.
	type	object
	properties
	temp_setpoint_cooling	Cooling setpoint air temperature. (C)
		type	number
		default	24
	temp_setpoint_heating	Heating setpoint air temperature. (C)
		type	number
		default	20
	temp_hw_supply	Heating water supply temperature. (C)
		type	number
		default	40
	temp_hw_return	Heating water return temperature. (C)
		type	number
		default	35
	temp_chw_supply	Chilled water supply temperature. (C)
		type	number
		default	7
	temp_chw_return	Chilled water return temperature. (C)
		type	number
		default	12
	has_liquid_heating	Whether the building has liquid heating.
		type	boolean
		default	True
	has_liquid_cooling	Whether the building has liquid cooling.
		type	boolean
		default	True
	has_electric_heating	Whether the building has electric heating.
		type	boolean
		default	False
	has_electric_cooling	Whether the building has electric cooling.
		type	boolean
		default	False
	order	type	integer
		enum	1, 2, 3, 4
		default	2
	fraction_latent_person	Fraction latent of sensible persons load (e.g., 0.8 = home, 1.25 = office).
		type	number
		default	1.25
	additionalProperties	False
time_series_model_parameters	Parameters associated with time series models.
	type	object
	properties
	temp_setpoint_cooling	Cooling setpoint air temperature. (C)
		type	number
		default	24
	temp_setpoint_heating	Heating setpoint air temperature. (C)
		type	number
		default	20
	temp_hw_supply	Heating water supply temperature. (C)
		type	number
		default	40
	temp_hw_return	Heating water return temperature. (C)
		type	number
		default	35
	temp_chw_supply	Chilled water supply temperature. (C)
		type	number
		default	7
	temp_chw_return	Chilled water return temperature. (C)
		type	number
		default	12
	has_liquid_heating	Whether the building has liquid heating.
		type	boolean
		default	True
	has_liquid_cooling	Whether the building has liquid cooling.
		type	boolean
		default	True
	has_electric_heating	Whether the building has electric heating.
		type	boolean
		default	False
	has_electric_cooling	Whether the building has electric cooling.
		type	boolean
		default	False
	max_electrical_load	Maximum electrical load from OpenStudio building simulation. (W)
		type	number
		default	0
	filepath	type	string
	delta_temp_air_cooling	Nominal cooling air temperature difference across the terminal unit heat exchanger. (deltaC)
		type	number
		default	10
	delta_temp_air_heating	Nominal heating air temperature difference across the terminal unit heat exchanger. (deltaC)
		type	number
		default	18
	additionalProperties	False
central_cooling_plant_parameters	Central cooling plant with maximum number of two chillers. Parameters associated with the model
	type	object
	properties
	cooling_tower_fan_power_nominal	Cooling tower fan power (W)
		type	number
		default	5000
	heat_flow_nominal	Nominal district cooling load. (W)
		type	number
		default	8000
	mass_chw_flow_nominal	Nominal chilled water mass flow rate. (kg/s)
		type	number
		default	10
	chiller_water_flow_minimum	Chiller minimum water mass flow rate. (kg/s)
		type	number
		default	10
	mass_cw_flow_nominal	Nominal condenser water mass flow rate. (kg/s)
		type	number
		default	10
	chw_pump_head	Chilled water pump head (Pa)
		type	number
		default	300000
	cw_pump_head	Cooling water pump head (Pa)
		type	number
		default	200000
	pressure_drop_chw_nominal	Nominal chilled water (evaporator) side pressure drop. (Pa)
		type	number
		default	55000
	pressure_drop_cw_nominal	Nominal cooling water (condenser) side pressure drop. (Pa)
		type	number
		default	80000
	pressure_drop_setpoint	The chilled water circuit pressure drop setpoint. (Pa)
		type	number
		default	50000
	temp_setpoint_chw	District circuit chilled water temperature setpoint. (C)
		type	number
		default	5
	pressure_drop_chw_valve_nominal	Chiller isolation valve pressure drop. (Pa)
		type	number
		default	6000
	pressure_drop_cw_pum_nominal	Cooling tower isolation valve pressure drop. (Pa)
		type	number
		default	6000
	temp_air_wb_nominal	Design air wet-bulb temperature. (C)
		type	number
		default	25
	temp_cw_in_nominal	Nominal cooling water inlet temperature. (C)
		type	number
		default	35
	cooling_tower_water_temperature_difference_nominal	Nominal water temperature difference of the tower. (C)
		type	number
		default	7
	delta_temp_approach	Approach temperature difference. (deltaC)
		type	number
		default	3
	ratio_water_air_nominal	To be defined
		type	number
		default	0.625
central_heating_plant_parameters	Central heating plant with maximum number of two boilers. Parameters associated with the model.
	type	object
	properties
	heat_flow_nominal	Nominal district heating load. (W)
		type	number
		default	8000
	mass_hhw_flow_nominal	Nominal heating water mass flow rate. (kg/s)
		type	number
		default	1
	boiler_water_flow_minimum	[unused] Boiler minimum water mass flow rate. (kg/s)
		type	number
		default	0.1
	pressure_drop_hhw_nominal	[unused] Nominal heating water (boiler side) pressure drop. (Pa)
		type	number
		default	55000
	temp_setpoint_hhw	District circuit heating water temperature setpoint. (C)
		type	number
		default	55
	pressure_drop_hhw_valve_nominal	Boiler isolation valve pressure drop. (Pa)
		type	number
		default	6000
	chp_installed	True if heating plant is a Combined Heat and Power plant
		type	boolean
	chp_thermal_following	True if CHP is thermal_following (prioritized thermal heat over electricity)
		type	boolean
combined_heat_and_power_parameters	Combined heat and power (CHP) parameters used by the microgrid model.
	type	object
	properties
	fuel_type	Type of fuel used
		type	string
		enum	Gas, Oil
	number_of_machines	Number of machines
		type	integer
	single_electricity_generation_capacity	Single machine electricity generation capacity (kW)
		type	number
	performance_data_path	Relative path from location where file instance is saved to the .mo file which records the performance curve of a CHP
		type	string
ghe_parameters	Parameters associated with Ground Heat Exchangers.
	type	object
	properties
	version	Version of GHE Designer
		type	string
	ghe_dir	Results directory for GHE Designer. Absolute path, or relative to the sys-param file.
		type	string
	ghe_specific_params	Specific properties for each Ground Heat Exchanger
		type	array
		items	#/definitions/ghe_specific_params_def
	soil	#/definitions/soil_def
	pipe	#/definitions/pipe_def
	fluid	#/definitions/fluid_def
	grout	#/definitions/grout_def
	simulation	#/definitions/simulation_def
	geometric_constraints	#/definitions/geometric_constraints_def
	design	#/definitions/design_def
diesel_generator_parameters	Diesel generator parameters used by the microgrid model.
	type	object
	properties
	nominal_power_generation	Nominal power generation (W)
		type	number
	source_phase_shift	Phase shift angle of source (degrees)
		type	number
electrical_grid_parameters	Electrical grid parameters used by the microgrid model.
	type	object
	properties
	frequency	Frequency (Hz)
		type	number
		default	60
	source_rms_voltage	Root mean square (RMS) voltage of source (V)
		type	number
	source_phase_shift	Phase shift angle of source (degrees)
		type	number
pv_parameters	Photovoltaic panel parameters used by the microgrid model.
	type	object
	properties
	net_surface_area	Net PV Surface Area (m2)
		type	number
	suface_tilt	PV Surface Tilt (degrees)
		type	number
	surface_azimuth	PV Surface Azimuth (degrees)
		type	number
	latitude	Latitude
		type	number
	nominal_voltage	Nominal System Voltage (V)
		type	number
		default	480
wind_turbine_parameters	Wind turbine parameters used by the microgrid model.
	type	object
	properties
	scaling_factor	Scaling Factor
		type	number
	height_over_ground	Height over ground (m)
		type	number
	power_curve	Power curve given as an array of pairs of value: the first in (m/s) and the second in (W).
		type	array
	rated_power	Wind turbine size (kW)
		type	number
	annual_energy_produced	Average yearly energy produced (kWh)
		type	number
	nominal_voltage	Nominal System Voltage (V)
		type	number
		default	480
capacitor_bank_parameters	Capacitor bank parameters used by the microgrid model.
	type	object
	properties
	nominal_capacity	Nominal Capacity (var)
		type	number
substation_parameters	Substation parameters used by the microgrid model.
	type	object
	properties
	RMS_voltage_high_side	RMS voltage on high side (V)
		type	number
	RMS_voltage_low_side	RMS voltage on low side (V)
		type	number
transformer_parameters	Transformer parameters used by the microgrid model.
	type	object
	properties
	id	The transformer ID as defined in the scenario report.
		type	string
	nominal_capacity	Nominal Capacity (kVA)
		type	number
	reactance_resistance_ratio	Ratio between reactance and resistance
		type	number
power_converter_parameters	Power converter parameters used by the microgrid model.
	type	object
	properties
	converter type	Power converter type
		type	string
	RMS_voltage_ratio	Ratio of RMS voltage on low side/high side
		type	number
	converter_efficiency	Converter Efficiency (%)
		type	number
	nominal_capacity	Nominal Capacity (kVA)
		type	number
distribution_line_parameters	Distribution lines parameters used by the microgrid model.
	type	object
	properties
	line_length	Length of distribution lines (m)
		type	number
	maximum_ampacity	Maximum power of the lines. this is defined in Amps
		type	number
	nominal_voltage	Nominal voltage of the lines (V)
		type	number
		default	480
	commercial_line_type	Commercial line type given by the type of each wire making up the line
		type	array
ac_inductive_load_parameters	AC inductive load parameters used by the microgrid model.
	type	object
	properties
	nominal_voltage	Nominal voltage (V)
		type	number
	nominal_power_consumption	Nominal Power Consumption type
		type	string
		enum	constant, variable load
dc_load_parameters	DC load parameters used by the microgrid model.
	type	object
	properties
	nominal_voltage	Nominal voltage (V)
		type	number
	nominal_power_consumption	Nominal Power Consumption type
		type	string
		enum	constant, variable load
battery_bank_parameters	Battery bank associated with the district
	type	object
	properties
	capacity	Maximum available charge (MWh)
		type	number
	nominal_voltage	Nominal voltage (V)
		type	number
fourth_generation_def	properties
	fourth_generation	properties
		central_cooling_plant_parameters	#/definitions/central_cooling_plant_parameters
		central_heating_plant_parameters	#/definitions/central_heating_plant_parameters
		combined_heat_and_power_parameters	#/definitions/combined_heat_and_power_parameters
		connected_buildings
		central_pump_parameters	Parameters for central pump
			type	object
			properties
			pump_design_head	Measured in Pa
				type	number
fifth_generation_def	properties
	fifth_generation	properties
		ghe_parameters	#/definitions/ghe_parameters
		connected_buildings
		central_pump_parameters	Parameters for central pump
			type	object
			properties
			pump_design_head	Measured in Pa.
				type	number
fifth_gen_ets_parameters	properties
	supply_water_temperature_building	Water supply temperature building side. (C)
		type	number
		default	15
	chilled_water_supply_temp	Chilled water supply temperature. (C)
		type	number
		default	5
	hot_water_supply_temp	Heating water supply temperature. (C)
		type	number
		default	50
	cop_heat_pump_heating	COP of heat pump for heating water production.
		type	number
		default	2.5
	cop_heat_pump_cooling	COP of heat pump for cooling water production.
		type	number
		default	3.5
	pump_flow_rate	Design volume flow rate of the ambient loop pump. (m3/s)
		type	number
		default	0.01
	pump_design_head	Design head pressure of the ambient loop pump. (Pa)
		type	number
		default	150000
	ets_pump_flow_rate	Design volume flow rate of the ETS pump. (m3/s)
		type	number
		default	0.0005
	ets_pump_head	Design head pressure of the ETS pump. (Pa)
		type	number
		default	10000
	fan_design_flow_rate	Design volume flow rate of the load-side fan. (m3/s)
		type	number
		default	0.25
	fan_design_head	Design head pressure of the load-side fan. (Pa)
		type	number
		default	150
soil_def	Soil properties for Ground Heat Exchanger sizing
	type	object
	properties
	conductivity	The conductivity of the soil, in units of W/m-K.
		type	number
		default	2
	rho_cp	The volumetric heat capacity of the soil, in units of J/m^3-K
		type	number
		default	2600000
	undisturbed_temp	The undisturbed average soil temperature, in units of degrees Celsius.
		type	number
		default	15
ghe_specific_params_def	The properties associated with each Ground Heat Exchanger instance
	type	object
	properties
	ghe_id	Feature ID of GHE from GeoJSON Feature File.
		type	string
	borehole	Borehole properties for Ground Heat Exchanger sizing.
		type	object
		properties
		buried_depth	The depth below the ground surface to the top of the borehole, in meters.
			type	number
			default	1.2
		diameter	The diameter of the borehole, in meters.
			type	number
			default	0.15
		number_of_boreholes	Number of boreholes on the site, determined from Thermal Network sizing
			type	number
		length_of_boreholes	The length of the borehole (in meters), determined from Thermal Network sizing.
			type	number
		additionalProperties	True
	ghe_geometric_params	The length and width of the Ground Heat Exchanger determined from the GeoJSON Feature File.
		type	object
		properties
		length_of_ghe	Horizontal surface length allowed for the ground heat exchanger, in meters.
			type	number
		width_of_ghe	Horizontal surface width allowed for the ground heat exchanger, in meters.
			type	number
pipe_def	Pipe properties for Ground Heat Exchanger sizing
	type	object
	properties
	inner_diameter	The diameter of the inner pipe surface, in meters.
		type	number
		default	0.0269
	outer_diameter	The diameter of the outer pipe surface, in meters.
		type	number
		minimum	0
		default	0.0334
	shank_spacing	The spacing between the U-tube legs, as referenced from outer surface of the pipes (i.e. not referenced from each pipes respective centerline), in meters.
		type	number
		minimum	0
		default	0.0277
	roughness	The surface roughness of the pipe, in meters.
		type	number
		minimum	0
		default	1e-06
	conductivity	The conductivity of the pipe material, in W/m-K.
		type	number
		minimum	0
		default	0.4
	rho_cp	The volumetric heat capacity of the pipe material, in J/m^3-K
		type	number
		minimum	0
		default	1542000
	arrangement	Arrangement of the pipes.
		type	string
		enum	singleutube, coaxial, doubleutube
		default	singleutube
fluid_def	Fluid properties for Ground Heat Exchanger sizing
	type	object
	properties
	fluid_name	Circulating fluid parameters for ground heat exchanger sizing.
		type	string
		enum	Water, EthylAlcohol, EthyleneGlycol, MethylAlcohol, PropyleneGlycol
		default	Water
	concentration_percent	The concentration of circulation fluid in percent, from 0-60.
		type	number
		maximum	60
		minimum	0
		default	0
	temperature	Average design fluid temperature at peak conditions, in C.
		type	number
		default	20
grout_def	Grout properties used for ground heat exchanger sizing.
	type	object
	properties
	conductivity	Grout thermal conductivity, in W/m-K.
		type	number
		minimum	0
		default	2
	rho_cp	Grout volumetric heat capacity, in J/m^3-K.
		type	number
		minimum	0
		default	4408000
simulation_def	Simulation parameters use for ground heat exchanger sizing.
	type	object
	properties
	num_months	Length of ground heat exchanger sizing period, in months.
		type	integer
		minimum	0
		default	240
geometric_constraints_def	Geometric constraints for GHE and boreholes.
	type	object
	properties
	b_min	Minimum borehole-to-borehole spacing, in meters.
		type	number
		default	3
	b_max	Maximum borehole-to-borehole spacing, in meters.
		type	number
		default	10
	max_height	Maximum height, or depth, of each borehole heat exchanger, in meters.
		type	number
		default	200
	min_height	Minimum height, or depth, of each borehole heat exchanger, in meters.
		type	number
		default	100
	method	GHE sizing method
		type	string
		enum	nearsquare, rectangle
		default	rectangle
design_def	Design parameters used for GHE sizing.
	type	object
	properties
	method	Building load distribution method for Ground Heat Exchanger sizing
		type	string
		enum	AREAPROPORTIONAL, UPSTREAM
		default	AREAPROPORTIONAL
	flow_rate	Nominal design mass flow rate. Depending on whether the flow_type attribute is set to ‘borehole’ or ‘system’, this will be the nominal flow rate for either each borehole or the entire ground heat exchanger.
		type	number
		minimum	0
		default	0.3
	flow_type	Flow type for ground heat exchanger sizing, in l/s.
		type	string
		enum	borehole, system
		default	borehole
	max_eft	Maximum heat pump entering fluid temperature used for ground heat exchanger sizing, in Celsius.
		type	number
		default	35
	min_eft	Minimum heat pump entering fluid temperature used for ground heat exchanger sizing, in Celsius.
		type	number
		default	5