Observations
The observations the CityLearn are grouped into calendar, weather, district and building categories. The observation values in the calendar, weather and district categories are equal across all buildings in the environment while the building category observations are building-specific. The observations may be pre-calculated, pre-simulated or pre-measured and supplied to the environment through flat .csv
files. Other observations are dependent on the actions taken by agents thus, are calculated during the simulation runtime.
Category |
Name |
Source |
Unit |
Description |
---|---|---|---|---|
Calendar |
|
|
Month of year ranging from 1 (January) through 12 (December). |
|
Calendar |
|
|
Day of week ranging from 1 (Monday) through 7 (Sunday). |
|
Calendar |
|
|
Hour of day ranging from 1 to 24. |
|
Calendar |
|
|
Boolean that indicates if the current day is daylight savings period. |
|
Weather |
|
|
C |
Outdoor dry bulb temperature. |
Weather |
|
|
C |
Outdoor dry bulb temperature predicted 6 hours ahead. |
Weather |
|
|
C |
Outdoor dry bulb temperature predicted 12 hours ahead. |
Weather |
|
|
C |
Outdoor dry bulb temperature predicted 24 hours ahead |
Weather |
|
|
% |
Outdoor relative humidity. |
Weather |
|
|
% |
Outdoor relative humidity predicted 6 hours ahead. |
Weather |
|
|
% |
Outdoor dry bulb temperature predicted 12 hours ahead. |
Weather |
|
|
% |
Outdoor dry bulb temperature predicted 24 hours ahead. |
Weather |
|
|
W/m2 |
Diffuse solar irradiance. |
Weather |
|
|
W/m2 |
Diffuse solar irradiance predicted 6 hours ahead. |
Weather |
|
|
W/m2 |
Diffuse solar irradiance predicted 12 hours ahead. |
Weather |
|
|
W/m2 |
Diffuse solar irradiance predicted 24 hours ahead. |
Weather |
|
|
W/m2 |
Direct solar irradiance. |
Weather |
|
|
W/m2 |
Direct solar irradiance predicted 6 hours ahead. |
Weather |
|
|
W/m2 |
Direct solar irradiance predicted 12 hours ahead. |
Weather |
|
|
W/m2 |
Direct solar irradiance predicted 24 hours ahead. |
District |
|
|
kgCO2/kWh |
Grid carbon emission rate. |
Building |
|
|
C |
Zone volume-weighted average building dry bulb temperature. |
Building |
|
|
C |
Zone volume-weighted average difference between indoor_dry_bulb_temperature and cooling temperature setpoints. |
Building |
|
|
% |
Zone volume-weighted average building relative humidity. |
Building |
|
|
kWh |
Total building non-shiftable plug and equipment loads. |
Building |
|
|
kWh |
PV electricity generation. |
Building |
|
Runtime calculation |
kWh/kWhcapacity |
State of the charge (SOC) of the cooling_storage from 0 (no energy stored) to 1 (at full capacity). |
Building |
|
Runtime calculation |
kWh/kWhcapacity |
State of the charge (SOC) of the heating_storage from 0 (no energy stored) to 1 (at full capacity). |
Building |
|
Runtime calculation |
kWh/kWhcapacity |
State of the charge (SOC) of the dhw_storage (domestic hot water storage) from 0 (no energy stored) to 1 (at full capacity). |
Building |
|
Runtime calculation |
kWh/kWhcapacity |
State of the charge (SOC) of the electrical_storage from 0 (no energy stored) to 1 (at full capacity). |
Building |
|
Runtime calculation |
kWh |
Total building electricity consumption. |
Building |
|
|
$/kWh |
Electricity rate. |
Building |
|
|
$/kWh |
Electricity rate predicted 6 hours ahead. |
Building |
|
|
$/kWh |
Electricity rate predicted 12 hours ahead. |
Building |
|
|
$/kWh |
Electricity rate predicted 24 hours ahead. |
Building |
|
Runtime calculation |
1 |
|
Building |
|
Runtime calculation |
1 |
|
Building |
|
Runtime calculation |
1 |
|
Building |
|
|
kWh |
Cooling energy supplied by |
Building |
|
|
kWh |
Heating energy supplied by |
Building |
|
|
kWh |
Heating energy supplied by |
Building |
|
Runtime calculation |
kWh |
|
Building |
|
Runtime calculation |
kWh |
|
Building |
|
Runtime calculation |
kWh |
|
Building |
|
|
C |
Zone volume-weighted average building dry bulb temperature set point. |
Building |
|
|
C |
Absolute difference between |
Building |
|
|
Integer signal indicating power outage at time step (1) or not (0). |