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

building_id.csv

Month of year ranging from 1 (January) through 12 (December).

Calendar

day_type

building_id.csv

Day of week ranging from 1 (Monday) through 7 (Sunday).

Calendar

hour

building_id.csv

Hour of day ranging from 1 to 24.

Calendar

daylight_savings_status

building_id.csv

Boolean that indicates if the current day is daylight savings period.

Weather

outdoor_dry_bulb_temperature

weather.csv

C

Outdoor dry bulb temperature.

Weather

outdoor_dry_bulb_temperature_predicted_6h

weather.csv

C

Outdoor dry bulb temperature predicted 6 hours ahead.

Weather

outdoor_dry_bulb_temperature_predicted_12h

weather.csv

C

Outdoor dry bulb temperature predicted 12 hours ahead.

Weather

outdoor_dry_bulb_temperature_predicted_24h

weather.csv

C

Outdoor dry bulb temperature predicted 24 hours ahead

Weather

outdoor_relative_humidity

weather.csv

%

Outdoor relative humidity.

Weather

outdoor_relative_humidity_predicted_6h

weather.csv

%

Outdoor relative humidity predicted 6 hours ahead.

Weather

outdoor_relative_humidity_predicted_12h

weather.csv

%

Outdoor dry bulb temperature predicted 12 hours ahead.

Weather

outdoor_relative_humidity_predicted_24h

weather.csv

%

Outdoor dry bulb temperature predicted 24 hours ahead.

Weather

diffuse_solar_irradiance

weather.csv

W/m2

Diffuse solar irradiance.

Weather

diffuse_solar_irradiance_predicted_6h

weather.csv

W/m2

Diffuse solar irradiance predicted 6 hours ahead.

Weather

diffuse_solar_irradiance_predicted_12h

weather.csv

W/m2

Diffuse solar irradiance predicted 12 hours ahead.

Weather

diffuse_solar_irradiance_predicted_24h

weather.csv

W/m2

Diffuse solar irradiance predicted 24 hours ahead.

Weather

direct_solar_irradiance

weather.csv

W/m2

Direct solar irradiance.

Weather

direct_solar_irradiance_predicted_6h

weather.csv

W/m2

Direct solar irradiance predicted 6 hours ahead.

Weather

direct_solar_irradiance_predicted_12h

weather.csv

W/m2

Direct solar irradiance predicted 12 hours ahead.

Weather

direct_solar_irradiance_predicted_24h

weather.csv

W/m2

Direct solar irradiance predicted 24 hours ahead.

District

carbon_intensity

carbon_intensity.csv

kgCO2/kWh

Grid carbon emission rate.

Building

indoor_dry_bulb_temperature

building_id.csv

C

Zone volume-weighted average building dry bulb temperature.

Building

average_unmet_cooling_setpoint_difference

building_id.csv

C

Zone volume-weighted average difference between indoor_dry_bulb_temperature and cooling temperature setpoints.

Building

indoor_relative_humidity

building_id.csv

%

Zone volume-weighted average building relative humidity.

Building

non_shiftable_load

building_id.csv

kWh

Total building non-shiftable plug and equipment loads.

Building

solar_generation

building_id.csv

kWh

PV electricity generation.

Building

cooling_storage_soc

Runtime calculation

kWh/kWhcapacity

State of the charge (SOC) of the cooling_storage from 0 (no energy stored) to 1 (at full capacity).

Building

heating_storage_soc

Runtime calculation

kWh/kWhcapacity

State of the charge (SOC) of the heating_storage from 0 (no energy stored) to 1 (at full capacity).

Building

dhw_storage_soc

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

electrical_storage_soc

Runtime calculation

kWh/kWhcapacity

State of the charge (SOC) of the electrical_storage from 0 (no energy stored) to 1 (at full capacity).

Building

net_electricity_consumption

Runtime calculation

kWh

Total building electricity consumption.

Building

electricity_pricing

pricing.csv

$/kWh

Electricity rate.

Building

electricity_pricing_predicted_6h

pricing.csv

$/kWh

Electricity rate predicted 6 hours ahead.

Building

electricity_pricing_predicted_12h

pricing.csv

$/kWh

Electricity rate predicted 12 hours ahead.

Building

electricity_pricing_predicted_24h

pricing.csv

$/kWh

Electricity rate predicted 24 hours ahead.