Data reference#
Warning
This reference is work in progress.
blind_types
#
Window blind characteristics. Currently not used.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
- |
Blind efficiency (absorbed irradiation / incident irradiation). |
buildings
#
Building definition.
Column |
Unit |
Description |
---|---|---|
|
Unique building identifier. |
|
|
Type identifier as defined in |
|
|
Type identifier as defined in |
constraint_schedules
#
The constraint timeseries is constructed by obtaining the appropriate value for internal_gain_occupancy
/ internal_gain_appliances
based on the time_period
in ddTHH:MM
format. Each value is kept constant at the given value for any daytime greater than or equal to HH:MM
and any weekday greater than or equal to dd
until the next defined ddTHH:MM
. Note that the daily schedule is repeated for any weekday greater than or equal to dd
until the next defined dd
. The initial value for each zone_constraint_profile
must start at time_period = 01T00:00
.
Column |
Unit |
Description |
---|---|---|
|
Constraint type identifier. |
|
|
Time period in |
|
|
°C |
|
|
°C |
|
|
m/s |
|
|
m³/s/person |
|
|
ppm |
|
|
m/s |
|
|
% |
|
|
% |
electricity_price_timeseries
#
Electricity price time series definition.
Column |
Unit |
Description |
---|---|---|
|
Price type identifier. |
|
|
Timestamp according to ISO 8601. |
|
|
SGD |
Currently only in SGD |
hvac_ahu_types
#
Air handling unit (AHU) set points and characteristics.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
°C |
Supply air temperature at outlet of AHU towards zone. |
|
% |
Supply air relative humidity at outlet of AHU towards zone. |
|
J/kg |
Fan efficiency (electric power / air mass flow rate). |
|
- |
Chiller plant efficiency (thermal power / electrical power). |
|
- |
Heating plant efficiency (thermal power / electrical power). |
|
- |
Recovery efficiency (recovered power / available power). |
hvac_generic_types
#
Generic HVAC system characteristics.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
- |
Heating efficiency (thermal power / electric power). |
|
- |
Cooling efficiency (thermal power / electric power). |
hvac_radiator_types
#
Column |
Unit |
Description |
---|---|---|
|
°C |
|
|
°C |
|
|
Unique type identifier. |
|
|
- |
Number of radiator panels. |
|
m² |
Radiator panel surface area. |
|
m |
Radiator panel thickness. |
|
m³ |
Radiator panel water volume. |
|
W/(m²K) |
Natural convection coefficient. |
|
- |
Emissivity factor. |
|
W/(mK) |
Radiator hull material conductivity. |
|
J/m³ |
Radiator hull material heat capacity. |
|
- |
Radiator fin effectiveness. |
hvac_tu_types
#
Terminal unit (TU) set points and characteristics.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
Currently not used. |
|
|
°C |
Supply air temperature at outlet of TU towards zone. |
|
J/kg |
Fan efficiency (electric power / air mass flow rate). |
|
- |
Chiller plant efficiency (thermal power / electrical power). |
|
- |
Heating plant efficiency (thermal power / electrical power). |
initial_state_types
#
Initial state settings to be taken for simulation and optimization.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
°C |
Initial zone air temperature. |
|
°C |
Initial surface temperature. |
|
ppm |
Initial zone air CO₂ concentration. |
|
kg/kg |
Initial zone air absolute humidity (mass of water / mass of air). |
|
m³ |
Initial stored volume of useable water layer in the sensible thermal storage. |
|
kWh |
Initial stored electric energy in the battery storage. |
internal_gain_schedules
#
The internal gain timeseries is constructed by obtaining the appropriate value for internal_gain_occupancy
/ internal_gain_appliances
based on the time_period
in ddTHH:MM
format. Each value is kept constant at the given value for any daytime greater than or equal to HH:MM
and any weekday greater than or equal to dd
until the next defined ddTHH:MM
. Note that the daily schedule is repeated for any weekday greater than or equal to dd
until the next defined dd
. The initial value for each zone_constraint_profile
must start at time_period = 01T00:00
.
Column |
Unit |
Description |
---|---|---|
|
Type identifier as defined in |
|
|
Time period in |
|
|
W/m² |
Internal gains related to occupants. |
|
W/m² |
Internal gains related to appliances. |
internal_gain_timeseries
#
Time series of internal gains.
Column |
Unit |
Description |
---|---|---|
|
Type identifier as defined in |
|
|
Timestamp according to ISO 8601. |
|
|
W/m² |
Internal gains related to occupants. |
|
W/m² |
Internal gains related to appliances. |
internal_gain_types
#
Internal gain type definitions.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
Definition type, corresponding to definitions in |
|
|
- |
Occupancy gains scaling factor. |
|
- |
Appliance gains scaling factor. |
linearization_types
#
Linearization point definitions.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
°C |
|
|
°C |
|
|
°C |
|
|
°C |
|
|
W/m² |
|
|
W/m² |
|
|
°C |
|
|
°C |
|
|
kg/kg |
Absolute humidity (mass of water / mass of air). |
|
kg/kg |
Absolute humidity (mass of water / mass of air). |
|
W/m² |
|
|
ppm |
|
|
m/s |
parameters
#
Parameter definitions, which includes constants and user-defined parameters.
In all tables, a parameter_name
string can be used to define numerical parameters in place of numerical values. During building model setup, those strings will be parsed from the parameters
table to obtain the corresponding numerical values.
Column |
Unit |
Description |
---|---|---|
|
Parameter set identifier. |
|
|
Parameter name string. |
|
|
various |
Numerical value. |
|
Comment field for the parameter unit. |
|
|
Comment field for further explanations. |
scenarios
#
Building scenario definitions.
Column |
Unit |
Description |
---|---|---|
|
Unique scenario identifier. |
|
|
Building identifier as defined in |
|
|
Parameter set identifier as defined in |
|
|
Type identifier as defined in |
|
|
Currently not used. |
|
|
Currently not used. |
|
|
Currently not used. |
|
|
Currently not used. |
|
|
Type identifier as defined in |
|
|
Timestamp according to ISO 8601. |
|
|
Timestamp according to ISO 8601. |
|
|
Time step length in seconds. |
storage_types
#
Storage characteristics.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
m³ or kWh |
Volume of sensible thermal storage or electric energy capacity of battery storage. |
|
- |
Round trip efficiency (discharged energy / charged energy). |
|
- |
Maximum utilizable battery storage capacity (utilized capacity / total capacity). |
|
K |
Temperature difference between the supply and return water temperature of sensible thermal storage. |
|
years |
Storage lifetime. Only used for storage planning problems. |
|
SGD/m³ or SGD/kWh |
Investment cost per installed energy capacity. Only used for storage planning problems. |
|
SGD/kW |
Investment cost per installed power capacity. Only used for storage planning problems. |
|
SGD |
Investment cost per installed storage unit. Only used for storage planning problems. |
surface_types
#
Surface type characteristics.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
J/(m³K) |
Specific heat capacity. |
|
m²K/W |
Specific thermal resistance. |
|
- |
Absorptivity factor / irradiation gain coefficient (absorbed irradiation / incident irradiation). |
|
- |
Emissivity factor. |
|
Type identifier as defined in |
|
|
- |
Window surface area / total surface area. |
|
- |
Sky view factor. |
surfaces_adiabatic
#
Adiabatic surfaces geometry.
Column |
Unit |
Description |
---|---|---|
|
Building identifier as defined in |
|
|
Zone identifier as defined in |
|
|
Unique surface identifier. |
|
|
Type identifier as defined in |
|
|
m² |
Surface area. |
|
Explanatory comment, e.g., description of the geometry. |
surfaces_exterior
#
Exterior surfaces geometry.
Column |
Unit |
Description |
---|---|---|
|
Building identifier as defined in |
|
|
Zone identifier as defined in |
|
|
Direction name ( |
|
|
Unique surface identifier. |
|
|
Type identifier as defined in |
|
|
m² |
Surface area. |
|
Explanatory comment, e.g., description of the geometry. |
surfaces_interior
#
Interior surfaces geometry.
Column |
Unit |
Description |
---|---|---|
|
Building identifier as defined in |
|
|
Zone on primary side identifier as defined in |
|
|
Zone on secondary side identifier as defined in |
|
|
Unique surface identifier. |
|
|
Type identifier as defined in |
|
|
m² |
Surface area. |
|
Explanatory comment, e.g., description of the geometry. |
weather_timeseries
#
Weather time series definition.
Column |
Unit |
Description |
---|---|---|
|
Type identifier as defined in |
|
|
Timestamp according to ISO 8601. |
|
|
°C |
Ambient air dry-bulb temperature. |
|
°C |
Equivalent sky temperature. |
|
kg/kg |
Ambient air absolute humidity (mass of water / mass of air). |
|
W/m² |
Irradiation onto a horizontal surface. |
|
W/m² |
Irradiation onto a vertical surface oriented towards East. |
|
W/m² |
Irradiation onto a vertical surface oriented towards South. |
|
W/m² |
Irradiation onto a vertical surface oriented towards West. |
|
W/m² |
Irradiation onto a vertical surface oriented towards North. |
weather_types
#
Additional weather and site information.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
Time zone indicator according to ISO 8601. |
|
|
Latitude of the weather station. |
|
|
Longitude of the weather station. |
|
|
K |
To be revised. |
window_types
#
Window characteristics.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
m²K/W |
Specific thermal resistance. |
|
- |
Irradiation gain coefficient (absorbed irradiation / incident irradiation). |
|
- |
Emissivity factor. |
zone_types
#
Zone type characteristics.
Column |
Unit |
Description |
---|---|---|
|
Unique type identifier. |
|
|
J/(m³K) |
Specific heat capacity. |
|
1/h |
Infiltration rate. |
|
Type identifier as defined in |
|
|
Type identifier as defined in |
|
|
Type identifier as defined in |
|
|
Type identifier as defined in |
|
|
Type identifier as defined in |
|
|
Type identifier as defined in |
|
|
Type identifier as defined in |
|
|
Constraint type identifier as defined in |
zones
#
Zone geometry.
Column |
Unit |
Description |
---|---|---|
|
Building identifier as defined in |
|
|
Unique zone identifier. |
|
|
Type identifier as defined in |
|
|
m |
Zone height (clear interior height from base to ceiling). |
|
m² |
Zone area (interior area excluding surfaces). |
|
Explanatory comment, e.g., description of the geometry. |