Observations Reference
This page is the observation dictionary for the simulator. It is intended as a human-readable and machine-readable contract for wrappers, Offline RL, GraphRL and Transformer policies.
Unit Contract
Name pattern |
Unit |
Example |
|---|---|---|
|
kW |
|
|
kWh/step |
|
|
kWh |
|
|
ratio |
|
|
timestep index |
|
|
hours |
|
|
count |
|
|
currency/kWh |
Dataset-defined currency. |
|
kgCO2/kWh |
Grid emissions factor. |
Temperatures |
C |
|
Irradiance |
W/m2 |
|
Common sentinels:
Value |
Meaning |
|---|---|
|
Time, ID or quantity unavailable. |
|
Unknown SOC or no EV. |
|
Not applicable when zero is physically valid, or absent entity row. |
Flat Observations
Flat observations are controlled by schema["observations"]. With central_agent=True, observations marked shared_in_central_agent=true appear only once in the central vector.
Calendar
Observation |
Unit |
Meaning |
|---|---|---|
|
1-12 |
Month. |
|
1-8 |
Day of week or special day. |
|
1-24 |
Hour. |
|
0-59 |
Minute, only if present in the dataset. |
|
0-59 |
Second, needed for sub-minute datasets. |
|
binary |
Daylight saving status. |
Weather
Observation |
Unit |
Meaning |
|---|---|---|
|
C |
Outdoor temperature. |
|
percent |
Outdoor relative humidity. |
|
W/m2 |
Diffuse irradiance. |
|
W/m2 |
Direct irradiance. |
|
same unit |
Forecast horizons as encoded by the dataset. |
The simulator does not assume fixed forecast horizons. They are whatever the dataset provides.
Pricing and Carbon
Observation |
Unit |
Meaning |
|---|---|---|
|
currency/kWh |
Current grid import price. |
|
currency/kWh |
Price forecasts. |
|
kgCO2/kWh |
Grid carbon intensity. |
Loads, Comfort and HVAC
Observation |
Unit |
Meaning |
|---|---|---|
|
C |
Indoor temperature. |
|
C |
Average cooling setpoint violation. |
|
percent |
Indoor relative humidity. |
|
people |
Occupancy. |
|
C |
Cooling setpoint. |
|
C |
Heating setpoint. |
|
C |
Controlled cooling delta. |
|
C |
Controlled heating delta. |
|
C |
Comfort band. |
|
enum |
0 off, 1 cooling, 2 heating, 3 auto. |
|
kWh/step |
Cooling thermal demand. |
|
kWh/step |
Heating thermal demand. |
|
kWh/step |
Domestic hot water demand. |
|
kWh/step |
Non-flexible electric load. |
|
COP/ratio |
Cooling device efficiency. |
|
COP/ratio |
Heating device efficiency. |
|
COP/ratio |
DHW device efficiency. |
Storage, PV and Net Energy
Observation |
Unit |
Meaning |
|---|---|---|
|
ratio |
Cooling storage SOC. |
|
ratio |
Heating storage SOC. |
|
ratio |
DHW storage SOC. |
|
ratio |
BESS SOC. |
|
kWh/step |
End-use electricity consumption. |
|
kWh/step |
BESS consumption, positive charge and negative discharge. |
|
kWh/step |
PV generation after PV mode conversion. |
|
kWh/step |
Import positive, export negative. |
|
binary |
Power outage state. |
EV and Charger Flat Observations
Schema helper keys are expanded per charger.
Schema key |
Expanded key |
Unit |
Meaning |
|---|---|---|---|
|
|
binary |
EV connected and ready. |
|
|
steps |
Steps until departure. |
|
|
ratio |
Required SOC at departure. |
|
|
ratio |
Connected EV SOC. |
|
|
kWh |
Connected EV battery capacity. |
|
|
binary |
Incoming EV exists. |
|
|
steps |
Steps until estimated arrival. |
|
|
ratio |
Estimated SOC at arrival. |
Deferrable Flat Observations
deferrable_appliance_* helper keys are expanded per appliance. The same fields appear in the entity deferrable_appliance table.
Feature |
Unit |
Meaning |
|---|---|---|
|
binary |
Cycle state flags. |
|
global timestep |
Flexibility window and deadline. |
|
hours |
Time remaining. |
|
steps |
Remaining slack before latest start. |
|
ratio |
Normalized slack and urgency. |
|
steps |
Cycle duration. |
|
kWh |
Total cycle energy. |
|
kWh |
Energy still to serve. |
|
kWh/step |
Cycle energy at current step. |
|
ratio |
External priority. |
|
binary |
Mandatory service request. |
|
kW |
Average and peak cycle power. |
|
ratio |
Cycle profile descriptors. |
|
steps |
Remaining cycle duration. |
|
kW |
Remaining average and current step power. |
Escalator Flat Observations
escalator_* helper keys are expanded per escalator in the flat interface.
Feature |
Unit |
Meaning |
|---|---|---|
|
passengers/step |
Aggregate demand sources and total demand. |
|
binary |
Demand, availability and simple service indicators. |
|
count |
Passing trains; source arrival/departure duplicates are not double counted. |
|
minutes |
Time until next relevant train. |
|
enum |
Standby, slow or normal state. |
|
kW |
Applied operating power. |
|
passengers/step |
Demand left unserved in standby. |
Entity Tables
Entity mode returns tables, edges and meta. Feature availability depends on the schema, active assets and enabled bundles.
district
Feature group |
Bundle |
Unit |
Meaning |
|---|---|---|---|
Shared flat observations |
legacy |
varies |
Shared observations from the first building. |
Forecasts |
|
varies |
Dataset forecasts. |
|
|
kW |
District/community power aggregates. |
|
|
kWh/step |
District/community step energy aggregates. |
|
|
kW |
Import/export headroom aggregates. |
|
|
mixed |
Aggregate flexible charge/discharge power and energy slack. |
|
|
count |
Active topology counts. |
|
|
count |
Current topology version. |
|
|
binary |
Whether a demand-response request is active at this timestep. |
|
|
enum |
Request issuer code: |
|
|
enum |
Load-perspective direction: |
|
|
kW |
Active district target power. |
|
|
kW |
Frozen baseline net power for the active request when valid. |
|
|
hours |
Time remaining in the inclusive activation window. |
|
|
currency/kWh |
Credited price for delivered energy. |
|
|
currency/kWh |
Penalty price for shortfall energy. |
|
|
kW |
Delivered power settled at the previous active DR step. |
|
|
kW |
Shortfall power settled at the previous active DR step. |
|
|
kWh/step |
District lag features. |
|
|
ratio/binary |
Calendar features; raw |
|
|
mixed |
Point forecasts at 15m/1h/3h/6h/24h; their source is declared in |
Demand-response request_id and baseline validity are exposed in observations["meta"]["demand_response"], not as numeric table columns.
building
Feature group |
Bundle |
Unit |
Meaning |
|---|---|---|---|
Active building flat observations |
legacy |
varies |
Non-shared, non-asset-specific flat features. |
|
|
kW |
Electrical power by component. |
|
|
kWh/step |
Step energy by component. |
|
|
ratio |
Building BESS SOC. |
|
|
kW |
Total charging service power. |
|
|
kW |
Current charging power by phase. |
|
|
kW/kWh |
Local PV surplus after non-flex load. |
|
|
kW |
Current local electrical headroom. |
|
|
mixed |
Aggregate BESS and connected-EV charge/discharge capability and energy slack. |
|
|
kWh/step |
Building lag features. |
|
|
kWh/step |
Import/export lag features. |
|
|
ratio/binary |
Calendar features. |
|
|
kW |
Building point forecasts at 15m/1h/3h/6h/24h. |
charger
Feature |
Bundle |
Unit |
Meaning |
|---|---|---|---|
|
legacy |
binary |
Current EV connection/incoming state. |
|
legacy |
ratio |
Connected EV SOC fields. |
|
legacy |
kWh |
Connected EV capacity. |
|
legacy |
steps |
Steps until departure. |
|
legacy |
ratio |
Incoming EV arrival SOC. |
|
legacy |
steps |
Steps until incoming arrival. |
|
legacy |
kWh/step |
Last commanded energy. |
|
legacy |
kW |
Charger power limits. |
|
|
kW |
Technical minimum powers. |
|
|
ratio |
Fixed/default efficiency. |
|
|
one-hot |
Phase connection; |
|
|
kW |
Commanded and applied charger power. |
|
|
kWh/step |
Applied energy. |
|
|
hours/ratio |
Connected EV time pressure. |
|
|
kWh/kW |
Energy and average power required to meet departure SOC. |
|
|
kW/ratio |
Charging urgency descriptors. |
|
|
mixed |
Connected EV usable discharge energy and remaining charge headroom. |
|
|
mixed |
Current feasible charger action capacity after SOC, availability, outage and headroom limits. |
|
|
kWh |
Energy still deliverable by departure under current limits and its margin over required energy. |
|
|
ratio |
Deadline pressure; values above |
|
|
ratio |
Efficiency curve values at max power. |
|
|
ratio/steps |
Incoming EV departure requirement when known. |
|
|
hours/ratio |
Incoming EV time pressure. |
|
|
mixed |
Previous raw policy request, post-constraint command and physically applied charger power. |
|
|
mixed |
Short action/application history. |
|
|
binary |
One-hot clipping causes: availability, power/deadband, SOC, building/phase/export headroom, outage or deferrable window. |
ev
Feature |
Bundle |
Unit |
Meaning |
|---|---|---|---|
|
legacy |
ratio |
EV SOC. |
|
legacy |
kWh |
EV battery capacity. |
|
legacy |
ratio |
Allowed depth of discharge. |
|
|
ratio |
Canonical SOC bounds. |
|
|
kWh |
Usable energy and energy to full. |
storage
Feature |
Bundle |
Unit |
Meaning |
|---|---|---|---|
|
legacy |
mixed |
BESS state and settled consumption. |
|
|
kW |
Technical minimum powers. |
|
|
ratio |
Base and round-trip efficiency. |
|
|
one-hot |
Storage phase connection. |
|
|
ratio |
Canonical BESS SOC. |
|
|
kW |
Current max powers. |
|
|
kWh |
Energy headroom and available energy. |
|
|
mixed |
Current feasible BESS action capacity after SOC, outage and headroom limits. |
|
|
kWh/step |
Feasible BESS energy this step after SOC/headroom/outage limits. |
|
|
kWh/step |
Nominal BESS power limit converted to this step duration. |
|
|
ratio |
Normalized BESS charge room, discharge energy and SOC within usable range. |
|
|
mixed |
Current efficiency, degraded capacity and minimum SOC. |
|
|
mixed |
Previous BESS action request, limited command, applied power and clipping causes. |
pv
Only present when entity_core_electrical is enabled.
Feature |
Unit |
Meaning |
|---|---|---|
|
kW |
PV generation as power. |
|
kWh/step |
PV generation in current step. |
|
kW |
Installed PV power. |
|
ratio |
|
deferrable_appliance
Base deferrable features are in entity_base; see the flat deferrable table above for definitions. Entity deferrables also include remaining_duration_hours, cycle_remaining_fraction_ratio, hours_until_earliest_start, start_window_width_hours, start_energy_kwh_step, start_power_kw and must_start_now for RL deadline pressure. With entity_action_feedback, deferrables also expose last_start_requested, last_start_applied, start_blocked and clip_reason_*.
Derived forecasts default to future dataset values for backward compatibility
(load_pv_method = "actual_future"). A schema can instead set
derived_forecasts.load_pv_method = "daily_persistence"; load and PV then use
only the corresponding previous-day observation, with a current-step cold
start. Price respects the declared day-ahead publication boundary: realised
OMIE values are exposed only after publication and otherwise use the schema’s
causal fallback (daily persistence in the annual REC suite). The exact sources
are exposed in meta.forecast_config; real-world adapters should populate
equivalent fields from operational forecasts.
Entity Edges
Edge |
Shape |
Links |
|---|---|---|
|
|
District row 0 to each building. |
|
|
Building to charger. |
|
|
Building to BESS. |
|
|
Building to PV. |
|
|
Building to deferrable appliance. |
|
|
Charger to connected EV; |
|
|
Valid connected-edge mask. |
|
|
Charger to incoming EV. |
|
|
Valid incoming-edge mask. |