Index

A

action_dimension (citylearn.agents.base.Agent property) action_metadata (citylearn.building.Building property) action_scaling_coefficient (citylearn.agents.rlc.RLC property) action_space (citylearn.agents.base.Agent property) (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) (citylearn.citylearn.StableBaselines3Wrapper property) actions (citylearn.agents.base.Agent property) active_actions (citylearn.building.Building property) active_observations (citylearn.building.Building property) add_to_buffer() (citylearn.agents.base.Agent method) (citylearn.agents.marlisa.MARLISA method) (citylearn.agents.sac.SAC method) agent (citylearn.simulator.Simulator property) Agent (class in citylearn.agents.base) alpha (citylearn.agents.rlc.RLC property)

apply_actions() (citylearn.building.Building method) autosize() (citylearn.energy_model.ElectricHeater method) (citylearn.energy_model.HeatPump method) (citylearn.energy_model.PV method) (citylearn.energy_model.StorageDevice method) autosize_cooling_device() (citylearn.building.Building method) autosize_cooling_storage() (citylearn.building.Building method) autosize_dhw_device() (citylearn.building.Building method) autosize_dhw_storage() (citylearn.building.Building method) autosize_electrical_storage() (citylearn.building.Building method) autosize_heating_device() (citylearn.building.Building method) autosize_heating_storage() (citylearn.building.Building method) autosize_pv() (citylearn.building.Building method) available_nominal_power (citylearn.energy_model.ElectricDevice property) average_daily_peak() (citylearn.cost_function.CostFunction static method) average_unmet_cooling_setpoint_difference (citylearn.data.EnergySimulation attribute)

B

BasicBatteryRBC (class in citylearn.agents.rbc) BasicRBC (class in citylearn.agents.rbc) batch_size (citylearn.agents.marlisa.MARLISA property) (citylearn.agents.rlc.RLC property)

Battery (class in citylearn.energy_model) Building (class in citylearn.building) building_information (citylearn.agents.base.Agent property) BuildingDynamicsReward (class in citylearn.reward_function) buildings (citylearn.citylearn.CityLearnEnv property)

C

calculate() (citylearn.reward_function.BuildingDynamicsReward method) (citylearn.reward_function.IndependentSACReward method) (citylearn.reward_function.MARL method) (citylearn.reward_function.RewardFunction method) calculate_comfort_reward() (citylearn.reward_function.BuildingDynamicsReward method) calculate_peak_reward() (citylearn.reward_function.BuildingDynamicsReward method) calculate_storage_reward() (citylearn.reward_function.BuildingDynamicsReward method) capacity (citylearn.energy_model.Battery property) (citylearn.energy_model.StorageDevice property) capacity_history (citylearn.energy_model.Battery property) capacity_loss_coefficient (citylearn.energy_model.Battery property) capacity_power_curve (citylearn.energy_model.Battery property) carbon_emissions() (citylearn.cost_function.CostFunction static method) carbon_intensity (citylearn.building.Building property) (citylearn.data.CarbonIntensity attribute) CarbonIntensity (class in citylearn.data) central_agent (citylearn.citylearn.CityLearnEnv property) charge() (citylearn.energy_model.Battery method) (citylearn.energy_model.StorageDevice method) (citylearn.energy_model.StorageTank method) citylearn module citylearn.agents module citylearn.agents.base module citylearn.agents.marlisa module citylearn.agents.rbc module citylearn.agents.rlc module citylearn.agents.sac module

citylearn.base module citylearn.building module citylearn.citylearn module citylearn.cost_function module citylearn.data module citylearn.energy_model module citylearn.preprocessing module citylearn.reward_function module citylearn.rl module citylearn.simulator module citylearn.utilities module CityLearnEnv (class in citylearn.citylearn) cooling_demand (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) (citylearn.data.EnergySimulation attribute) cooling_device (citylearn.building.Building property) cooling_electricity_consumption (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) cooling_storage (citylearn.building.Building property) cooling_storage_electricity_consumption (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) coordination_variables_history (citylearn.agents.marlisa.MARLISA property) copy() (citylearn.data.DataSet static method) CostFunction (class in citylearn.cost_function)

D

DataSet (class in citylearn.data) day_type (citylearn.data.EnergySimulation attribute) daylight_savings_status (citylearn.data.EnergySimulation attribute) degrade() (citylearn.energy_model.Battery method) deterministic_start_time_step (citylearn.agents.rlc.RLC property) Device (class in citylearn.energy_model) dhw_demand (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) (citylearn.data.EnergySimulation attribute) dhw_device (citylearn.building.Building property) dhw_electricity_consumption (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property)

dhw_storage (citylearn.building.Building property) dhw_storage_electricity_consumption (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) diffuse_solar_irradiance (citylearn.data.Weather attribute) diffuse_solar_irradiance_predicted_12h (citylearn.data.Weather attribute) diffuse_solar_irradiance_predicted_24h (citylearn.data.Weather attribute) diffuse_solar_irradiance_predicted_6h (citylearn.data.Weather attribute) direct_solar_irradiance (citylearn.data.Weather attribute) direct_solar_irradiance_predicted_12h (citylearn.data.Weather attribute) direct_solar_irradiance_predicted_24h (citylearn.data.Weather attribute) direct_solar_irradiance_predicted_6h (citylearn.data.Weather attribute) discount (citylearn.agents.rlc.RLC property) done (citylearn.citylearn.CityLearnEnv property)

E

efficiency (citylearn.energy_model.Battery property) (citylearn.energy_model.Device property) (citylearn.energy_model.ElectricHeater property) (citylearn.energy_model.HeatPump property) (citylearn.energy_model.StorageDevice property) efficiency_history (citylearn.energy_model.Battery property) efficiency_scaling (citylearn.energy_model.StorageDevice property) electrical_storage (citylearn.building.Building property) electrical_storage_electricity_consumption (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) ElectricDevice (class in citylearn.energy_model) ElectricHeater (class in citylearn.energy_model) electricity_consumption (citylearn.energy_model.Battery property) (citylearn.energy_model.ElectricDevice property) electricity_consumption() (citylearn.cost_function.CostFunction static method) electricity_pricing (citylearn.data.Pricing attribute) electricity_pricing_predicted_12h (citylearn.data.Pricing attribute) electricity_pricing_predicted_24h (citylearn.data.Pricing attribute) electricity_pricing_predicted_6h (citylearn.data.Pricing attribute) Encoder (class in citylearn.preprocessing) end_exploration_time_step (citylearn.agents.rlc.RLC property) energy_balance (citylearn.energy_model.StorageDevice property) energy_from_cooling_device (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) energy_from_cooling_device_to_cooling_storage (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) energy_from_cooling_storage (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property)

energy_from_dhw_device (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) energy_from_dhw_device_to_dhw_storage (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) energy_from_dhw_storage (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) energy_from_electrical_storage (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) energy_from_heating_device (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) energy_from_heating_device_to_heating_storage (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) energy_from_heating_storage (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) energy_simulation (citylearn.building.Building property) energy_to_electrical_storage (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) EnergySimulation (class in citylearn.data) env (citylearn.reward_function.RewardFunction property) (citylearn.simulator.Simulator property) env_history (citylearn.simulator.Simulator property) Environment (class in citylearn.base) episodes (citylearn.simulator.Simulator property) Error estimate_action_space() (citylearn.building.Building method) estimate_observation_space() (citylearn.building.Building method) evaluate() (citylearn.citylearn.CityLearnEnv method)

F

forward() (citylearn.rl.PolicyNetwork method) (citylearn.rl.SoftQNetwork method)

G

get_building_information() (citylearn.citylearn.CityLearnEnv method) get_cop() (citylearn.energy_model.HeatPump method) get_current_efficiency() (citylearn.energy_model.Battery method) get_default_shared_observations() (citylearn.citylearn.CityLearnEnv static method) get_encoded_observations() (citylearn.agents.sac.SAC method) get_encoded_regression_targets() (citylearn.agents.marlisa.MARLISA method) get_encoded_regression_variables() (citylearn.agents.marlisa.MARLISA method) get_exploration_actions() (citylearn.agents.marlisa.MARLISA method) (citylearn.agents.sac.SAC method) (citylearn.agents.sac.SACRBC method) get_exploration_actions_with_information_sharing() (citylearn.agents.marlisa.MARLISA method) get_exploration_actions_without_information_sharing() (citylearn.agents.marlisa.MARLISA method) get_generation() (citylearn.energy_model.PV method) get_info() (citylearn.citylearn.CityLearnEnv method) get_input_power() (citylearn.energy_model.ElectricHeater method) (citylearn.energy_model.HeatPump method)

get_max_input_power() (citylearn.energy_model.Battery method) get_max_output_power() (citylearn.energy_model.Battery method) (citylearn.energy_model.ElectricHeater method) (citylearn.energy_model.HeatPump method) get_names() (citylearn.data.DataSet static method) get_normalized_observations() (citylearn.agents.sac.SAC method) get_normalized_reward() (citylearn.agents.sac.SAC method) get_post_exploration_actions() (citylearn.agents.marlisa.MARLISA method) (citylearn.agents.sac.SAC method) get_post_exploration_actions_with_information_sharing() (citylearn.agents.marlisa.MARLISA method) get_post_exploration_actions_without_information_sharing() (citylearn.agents.marlisa.MARLISA method) get_regression_variables() (citylearn.agents.marlisa.MARLISA method) get_schema() (citylearn.data.DataSet static method) get_simulator() (in module citylearn.simulator)

H

heating_demand (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) (citylearn.data.EnergySimulation attribute) heating_device (citylearn.building.Building property) heating_electricity_consumption (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property)

heating_storage (citylearn.building.Building property) heating_storage_electricity_consumption (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) HeatPump (class in citylearn.energy_model) hidden_dimension (citylearn.agents.marlisa.MARLISA property) (citylearn.agents.rlc.RLC property) hour (citylearn.data.EnergySimulation attribute)

I

IndependentSACReward (class in citylearn.reward_function) indoor_dry_bulb_temperature (citylearn.data.EnergySimulation attribute) indoor_relative_humidity (citylearn.data.EnergySimulation attribute)

information_sharing (citylearn.agents.marlisa.MARLISA property) initial_soc (citylearn.energy_model.StorageDevice property) iterations (citylearn.agents.marlisa.MARLISA property)

K

keep_env_history (citylearn.simulator.Simulator property)

L

load_agent() (citylearn.citylearn.CityLearnEnv method) load_factor() (citylearn.cost_function.CostFunction static method)

logging_level (citylearn.simulator.Simulator property) loss_coefficient (citylearn.energy_model.StorageDevice property) lr (citylearn.agents.rlc.RLC property)

M

MARL (class in citylearn.reward_function) MARLISA (class in citylearn.agents.marlisa) max_input_power (citylearn.energy_model.StorageTank property) max_output_power (citylearn.energy_model.StorageTank property) module citylearn citylearn.agents citylearn.agents.base citylearn.agents.marlisa citylearn.agents.rbc citylearn.agents.rlc citylearn.agents.sac citylearn.base citylearn.building citylearn.citylearn citylearn.cost_function citylearn.data citylearn.energy_model citylearn.preprocessing citylearn.reward_function citylearn.rl citylearn.simulator citylearn.utilities

month (citylearn.data.EnergySimulation attribute)

N

name (citylearn.building.Building property) net_electricity_consumption (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) net_electricity_consumption_emission (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) net_electricity_consumption_price (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) net_electricity_consumption_without_storage (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) net_electricity_consumption_without_storage_and_pv (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) net_electricity_consumption_without_storage_and_pv_emission (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) net_electricity_consumption_without_storage_and_pv_price (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property)

net_electricity_consumption_without_storage_emission (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) net_electricity_consumption_without_storage_price (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) next_time_step() (citylearn.agents.base.Agent method) (citylearn.base.Environment method) (citylearn.building.Building method) (citylearn.citylearn.CityLearnEnv method) (citylearn.energy_model.ElectricDevice method) nominal_power (citylearn.energy_model.ElectricDevice property) non_shiftable_load (citylearn.data.EnergySimulation attribute) non_shiftable_load_demand (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) NoNormalization (class in citylearn.preprocessing) Normalize (class in citylearn.preprocessing)

O

observation_dimension (citylearn.agents.rlc.RLC property) observation_metadata (citylearn.building.Building property) observation_names (citylearn.agents.base.Agent property) (citylearn.citylearn.CityLearnEnv property) observation_space (citylearn.agents.base.Agent property) (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) (citylearn.citylearn.StableBaselines3Wrapper property) observations (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property)

OnehotEncoding (class in citylearn.preprocessing) OptimizedRBC (class in citylearn.agents.rbc) outdoor_dry_bulb_temperature (citylearn.data.Weather attribute) outdoor_dry_bulb_temperature_predicted_12h (citylearn.data.Weather attribute) outdoor_dry_bulb_temperature_predicted_24h (citylearn.data.Weather attribute) outdoor_dry_bulb_temperature_predicted_6h (citylearn.data.Weather attribute) outdoor_relative_humidity (citylearn.data.Weather attribute) outdoor_relative_humidity_predicted_12h (citylearn.data.Weather attribute) outdoor_relative_humidity_predicted_24h (citylearn.data.Weather attribute) outdoor_relative_humidity_predicted_6h (citylearn.data.Weather attribute)

P

pca_compression (citylearn.agents.marlisa.MARLISA property) peak_demand() (citylearn.cost_function.CostFunction static method) PeriodicNormalization (class in citylearn.preprocessing) PolicyNetwork (class in citylearn.rl) power_efficiency_curve (citylearn.energy_model.Battery property) predict_demand() (citylearn.agents.marlisa.MARLISA method)

price() (citylearn.cost_function.CostFunction static method) pricing (citylearn.building.Building property) Pricing (class in citylearn.data) push() (citylearn.rl.RegressionBuffer method) (citylearn.rl.ReplayBuffer method) pv (citylearn.building.Building property) PV (class in citylearn.energy_model)

Q

quadratic() (citylearn.cost_function.CostFunction static method)

R

ramping() (citylearn.cost_function.CostFunction static method) rbc (citylearn.agents.sac.SACRBC property) RBC (class in citylearn.agents.rbc) read_json() (in module citylearn.utilities) regression_buffer_capacity (citylearn.agents.marlisa.MARLISA property) regression_frequency (citylearn.agents.marlisa.MARLISA property) RegressionBuffer (class in citylearn.rl) RemoveFeature (class in citylearn.preprocessing) replay_buffer_capacity (citylearn.agents.rlc.RLC property) ReplayBuffer (class in citylearn.rl) reset() (citylearn.agents.base.Agent method) (citylearn.agents.marlisa.MARLISA method) (citylearn.base.Environment method) (citylearn.building.Building method) (citylearn.citylearn.CityLearnEnv method) (citylearn.citylearn.StableBaselines3Wrapper method) (citylearn.energy_model.Battery method) (citylearn.energy_model.ElectricDevice method) (citylearn.energy_model.StorageDevice method)

reset_time_step() (citylearn.base.Environment method) reward_function (citylearn.citylearn.CityLearnEnv property) reward_scaling (citylearn.agents.rlc.RLC property) RewardFunction (class in citylearn.reward_function) rewards (citylearn.citylearn.CityLearnEnv property) RLC (class in citylearn.agents.rlc) root_directory (citylearn.citylearn.CityLearnEnv property)

S

SAC (class in citylearn.agents.sac) SACBasicBatteryRBC (class in citylearn.agents.sac) SACBasicRBC (class in citylearn.agents.sac) SACOptimizedRBC (class in citylearn.agents.sac) SACRBC (class in citylearn.agents.sac) sample() (citylearn.rl.PolicyNetwork method) (citylearn.rl.ReplayBuffer method) schema (citylearn.citylearn.CityLearnEnv property) seconds_per_time_step (citylearn.base.Environment property) seed (citylearn.agents.rlc.RLC property) select_actions() (citylearn.agents.base.Agent method) (citylearn.agents.rbc.BasicBatteryRBC method) (citylearn.agents.rbc.BasicRBC method) (citylearn.agents.rbc.OptimizedRBC method) (citylearn.agents.sac.SAC method) set_encoders() (citylearn.agents.base.Agent method) (citylearn.agents.sac.SAC method) set_energy_balance() (citylearn.energy_model.StorageDevice method) set_energy_coefficients() (citylearn.agents.marlisa.MARLISA method) set_networks() (citylearn.agents.marlisa.MARLISA method) (citylearn.agents.sac.SAC method)

set_pca() (citylearn.agents.marlisa.MARLISA method) set_regression_encoders() (citylearn.agents.marlisa.MARLISA method) shared_observations (citylearn.citylearn.CityLearnEnv property) simulate() (citylearn.simulator.Simulator method) simulation_end_time_step (citylearn.citylearn.CityLearnEnv property) simulation_start_time_step (citylearn.citylearn.CityLearnEnv property) Simulator (class in citylearn.simulator) soc (citylearn.energy_model.StorageDevice property) soc_init (citylearn.energy_model.StorageDevice property) SoftQNetwork (class in citylearn.rl) solar_generation (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) (citylearn.data.EnergySimulation attribute) StableBaselines3Wrapper (class in citylearn.citylearn) start_regression_time_step (citylearn.agents.marlisa.MARLISA property) start_training_time_step (citylearn.agents.rlc.RLC property) step() (citylearn.citylearn.CityLearnEnv method) (citylearn.citylearn.StableBaselines3Wrapper method) StorageDevice (class in citylearn.energy_model) StorageTank (class in citylearn.energy_model)

T

target_cooling_temperature (citylearn.energy_model.HeatPump property) target_heating_temperature (citylearn.energy_model.HeatPump property) tau (citylearn.agents.rlc.RLC property) time_step (citylearn.base.Environment property)

time_steps (citylearn.citylearn.CityLearnEnv property) to() (citylearn.rl.PolicyNetwork method) training (citylearn.rl.PolicyNetwork attribute) (citylearn.rl.SoftQNetwork attribute)

U

uid (citylearn.base.Environment property) UnknownSchemaError update_cooling() (citylearn.building.Building method) update_dhw() (citylearn.building.Building method) update_electrical_storage() (citylearn.building.Building method)

update_electricity_consumption() (citylearn.energy_model.ElectricDevice method) update_heating() (citylearn.building.Building method) update_per_time_step (citylearn.agents.rlc.RLC property) update_variables() (citylearn.building.Building method) (citylearn.citylearn.CityLearnEnv method)

W

weather (citylearn.building.Building property)

Weather (class in citylearn.data) write_json() (in module citylearn.utilities)

Z

zero_net_energy() (citylearn.cost_function.CostFunction static method)