CityLearn
Installation
QuickStart
Overview
Usage
citylearn
The CityLearn Challenge
Contributing
References
CityLearn
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
|
Z
A
action() (citylearn.wrappers.DiscreteActionWrapper method)
(citylearn.wrappers.NormalizedActionWrapper method)
(citylearn.wrappers.StableBaselines3ActionWrapper method)
(citylearn.wrappers.TabularQLearningActionWrapper method)
action_dimension (citylearn.agents.base.Agent property)
action_map (citylearn.agents.rbc.BasicBatteryRBC property)
(citylearn.agents.rbc.BasicRBC property)
(citylearn.agents.rbc.HourRBC property)
(citylearn.agents.rbc.OptimizedRBC property)
action_metadata (citylearn.building.Building property)
action_names (citylearn.agents.base.Agent property)
(citylearn.citylearn.CityLearnEnv 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.wrappers.DiscreteActionWrapper property)
(citylearn.wrappers.NormalizedActionWrapper property)
(citylearn.wrappers.StableBaselines3ActionWrapper property)
(citylearn.wrappers.TabularQLearningActionWrapper property)
actions (citylearn.agents.base.Agent property)
active_actions (citylearn.building.Building property)
active_observations (citylearn.building.Building property)
Agent (class in citylearn.agents.base)
alpha (citylearn.agents.rlc.RLC property)
apply_actions() (citylearn.building.Building method)
(citylearn.building.DynamicsBuilding 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)
B
band (citylearn.reward_function.ComfortReward property)
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_metadata (citylearn.agents.base.Agent property)
buildings (citylearn.citylearn.CityLearnEnv property)
C
caidi (citylearn.power_outage.ReliabilityMetricsPowerOutage property)
calculate() (citylearn.reward_function.ComfortReward method)
(citylearn.reward_function.IndependentSACReward method)
(citylearn.reward_function.MARL method)
(citylearn.reward_function.RewardFunction method)
(citylearn.reward_function.SolarPenaltyAndComfortReward method)
(citylearn.reward_function.SolarPenaltyReward method)
capacity (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)
CarbonIntensity (class in citylearn.data)
central_agent (citylearn.citylearn.CityLearnEnv property)
(citylearn.reward_function.RewardFunction 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.q_learning
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.dynamics
module
citylearn.energy_model
module
citylearn.power_outage
module
citylearn.preprocessing
module
citylearn.rendering
module
citylearn.reward_function
module
citylearn.rl
module
citylearn.utilities
module
citylearn.wrappers
module
CityLearnEnv (class in citylearn.citylearn)
coefficients (citylearn.reward_function.SolarPenaltyAndComfortReward property)
ComfortReward (class in citylearn.reward_function)
cooling_demand (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
cooling_demand_without_partial_load (citylearn.building.DynamicsBuilding property)
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)
cost() (citylearn.cost_function.CostFunction static method)
CostFunction (class in citylearn.cost_function)
D
DataSet (class in citylearn.data)
DEFAULT_RANDOM_SEED_RANGE (citylearn.base.Environment attribute)
DEFAULT_SECONDS_PER_TIME_STEP (citylearn.base.Environment attribute)
degrade() (citylearn.energy_model.Battery method)
degraded_capacity (citylearn.energy_model.Battery property)
depth_of_discharge (citylearn.energy_model.Battery property)
Device (class in citylearn.energy_model)
dhw_demand (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
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)
discomfort() (citylearn.cost_function.CostFunction static method)
discount (citylearn.agents.rlc.RLC property)
DiscreteActionWrapper (class in citylearn.wrappers)
DiscreteObservationWrapper (class in citylearn.wrappers)
DiscreteSpaceWrapper (class in citylearn.wrappers)
done (citylearn.citylearn.CityLearnEnv property)
downward_electrical_flexibility (citylearn.building.Building property)
draw_building() (citylearn.rendering.RenderBuilding method)
draw_line() (citylearn.rendering.RenderBuilding method)
Dynamics (class in citylearn.dynamics)
DynamicsBuilding (class in citylearn.building)
E
efficiency (citylearn.energy_model.Battery property)
(citylearn.energy_model.Device property)
(citylearn.energy_model.ElectricHeater property)
(citylearn.energy_model.HeatPump property)
efficiency_history (citylearn.energy_model.Battery 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.ElectricDevice property)
electricity_consumption() (citylearn.cost_function.CostFunction static method)
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_init (citylearn.energy_model.StorageDevice property)
energy_simulation (citylearn.building.Building property)
energy_to_electrical_storage (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
energy_to_non_shiftable_load (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
EnergySimulation (class in citylearn.data)
env_metadata (citylearn.reward_function.RewardFunction property)
(citylearn.reward_function.SolarPenaltyAndComfortReward property)
Environment (class in citylearn.base)
episode (citylearn.base.EpisodeTracker property)
(citylearn.citylearn.CityLearnEnv property)
episode_end_time_step (citylearn.base.EpisodeTracker property)
episode_start_time_step (citylearn.base.EpisodeTracker property)
episode_time_steps (citylearn.agents.base.Agent property)
(citylearn.base.EpisodeTracker property)
(citylearn.citylearn.CityLearnEnv property)
episode_tracker (citylearn.base.Environment property)
(citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
EpisodeTracker (class in citylearn.base)
Error
estimate_action_space() (citylearn.building.Building method)
estimate_observation_space() (citylearn.building.Building method)
estimate_observation_space_limits() (citylearn.building.Building method)
evaluate() (citylearn.citylearn.CityLearnEnv method)
evaluate_citylearn_challenge() (citylearn.citylearn.CityLearnEnv method)
EvaluationCondition (class in citylearn.citylearn)
F
forward() (citylearn.dynamics.LSTMDynamics method)
(citylearn.rl.PolicyNetwork method)
(citylearn.rl.SoftQNetwork method)
G
get_background() (in module citylearn.rendering)
get_coords() (citylearn.rendering.RenderBuilding 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_dynamics_input() (citylearn.building.DynamicsBuilding method)
(citylearn.building.LSTMDynamicsBuilding 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_prediction() (citylearn.agents.marlisa.MARLISA method)
(citylearn.agents.sac.SAC method)
(citylearn.agents.sac.SACRBC method)
get_exploration_prediction_with_information_sharing() (citylearn.agents.marlisa.MARLISA method)
get_exploration_prediction_without_information_sharing() (citylearn.agents.marlisa.MARLISA method)
(citylearn.agents.marlisa.MARLISARBC 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_metadata() (citylearn.base.Environment method)
(citylearn.building.Building method)
(citylearn.citylearn.CityLearnEnv method)
(citylearn.energy_model.Battery method)
(citylearn.energy_model.Device method)
(citylearn.energy_model.ElectricDevice method)
(citylearn.energy_model.HeatPump method)
(citylearn.energy_model.StorageDevice 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_periodic_observation_metadata() (citylearn.building.Building static method)
get_plots() (in module citylearn.rendering)
get_post_exploration_prediction() (citylearn.agents.marlisa.MARLISA method)
(citylearn.agents.sac.SAC method)
get_post_exploration_prediction_with_information_sharing() (citylearn.agents.marlisa.MARLISA method)
get_post_exploration_prediction_without_information_sharing() (citylearn.agents.marlisa.MARLISA method)
get_regression_variables() (citylearn.agents.marlisa.MARLISA method)
get_schema() (citylearn.data.DataSet static method)
get_signals() (citylearn.power_outage.PowerOutage method)
(citylearn.power_outage.ReliabilityMetricsPowerOutage method)
H
heating_demand (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
heating_demand_without_partial_load (citylearn.building.DynamicsBuilding property)
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)
higher_exponent (citylearn.reward_function.ComfortReward property)
HourRBC (class in citylearn.agents.rbc)
hvac_mode_switch (citylearn.building.Building property)
I
IndependentSACReward (class in citylearn.reward_function)
indoor_dry_bulb_temperature (citylearn.building.Building property)
indoor_dry_bulb_temperature_set_point (citylearn.building.Building property)
indoor_dry_bulb_temperature_without_partial_load (citylearn.building.DynamicsBuilding property)
information_sharing (citylearn.agents.marlisa.MARLISA property)
init_hidden() (citylearn.dynamics.LSTMDynamics method)
initial_soc (citylearn.energy_model.Battery property)
(citylearn.energy_model.StorageDevice property)
iterations (citylearn.agents.marlisa.MARLISA property)
L
learn() (citylearn.agents.base.Agent method)
load_agent() (citylearn.citylearn.CityLearnEnv method)
loss_coefficient (citylearn.energy_model.StorageDevice property)
lower_exponent (citylearn.reward_function.ComfortReward property)
lr (citylearn.agents.rlc.RLC property)
LSTMDynamics (class in citylearn.dynamics)
LSTMDynamicsBuilding (class in citylearn.building)
M
MARL (class in citylearn.reward_function)
MARLISA (class in citylearn.agents.marlisa)
MARLISARBC (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.q_learning
citylearn.agents.rbc
citylearn.agents.rlc
citylearn.agents.sac
citylearn.base
citylearn.building
citylearn.citylearn
citylearn.cost_function
citylearn.data
citylearn.dynamics
citylearn.energy_model
citylearn.power_outage
citylearn.preprocessing
citylearn.rendering
citylearn.reward_function
citylearn.rl
citylearn.utilities
citylearn.wrappers
N
name (citylearn.building.Building property)
net_electricity_consumption (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_cost (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_cost_without_storage (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_cost_without_storage_and_partial_load (citylearn.building.DynamicsBuilding property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_cost_without_storage_and_partial_load_and_pv (citylearn.building.DynamicsBuilding property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_cost_without_storage_and_pv (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_emission (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_emission_without_storage (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_emission_without_storage_and_partial_load (citylearn.building.DynamicsBuilding property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_emission_without_storage_and_partial_load_and_pv (citylearn.building.DynamicsBuilding property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_emission_without_storage_and_pv (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_partial_load (citylearn.building.DynamicsBuilding property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_without_storage_and_partial_load_and_pv (citylearn.building.DynamicsBuilding property)
(citylearn.citylearn.CityLearnEnv property)
net_electricity_consumption_without_storage_and_pv (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
next_episode() (citylearn.base.EpisodeTracker method)
next_time_step() (citylearn.agents.base.Agent method)
(citylearn.base.Environment method)
(citylearn.building.Building method)
(citylearn.building.DynamicsBuilding method)
(citylearn.citylearn.CityLearnEnv method)
nominal_power (citylearn.energy_model.ElectricDevice property)
non_shiftable_load (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
non_shiftable_load_device (citylearn.building.Building property)
non_shiftable_load_electricity_consumption (citylearn.building.Building property)
NoNormalization (class in citylearn.preprocessing)
Normalize (class in citylearn.preprocessing)
normalized_unserved_energy() (citylearn.cost_function.CostFunction static method)
NormalizedActionWrapper (class in citylearn.wrappers)
NormalizedObservationWrapper (class in citylearn.wrappers)
NormalizedSpaceWrapper (class in citylearn.wrappers)
O
observation() (citylearn.wrappers.DiscreteObservationWrapper method)
(citylearn.wrappers.NormalizedObservationWrapper method)
(citylearn.wrappers.StableBaselines3ObservationWrapper method)
(citylearn.wrappers.TabularQLearningObservationWrapper method)
observation_dimension (citylearn.agents.rlc.RLC property)
observation_metadata (citylearn.building.Building property)
observation_names (citylearn.agents.base.Agent property)
(citylearn.citylearn.CityLearnEnv property)
(citylearn.wrappers.NormalizedObservationWrapper property)
observation_space (citylearn.agents.base.Agent property)
(citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
(citylearn.wrappers.DiscreteObservationWrapper property)
(citylearn.wrappers.NormalizedObservationWrapper property)
(citylearn.wrappers.StableBaselines3ObservationWrapper property)
(citylearn.wrappers.TabularQLearningObservationWrapper property)
observations (citylearn.citylearn.CityLearnEnv property)
observations() (citylearn.building.Building method)
occupant_count (citylearn.building.Building property)
one_minus_load_factor() (citylearn.cost_function.CostFunction static method)
one_minus_thermal_resilience() (citylearn.cost_function.CostFunction static method)
OnehotEncoding (class in citylearn.preprocessing)
OptimizedRBC (class in citylearn.agents.rbc)
P
pca_compression (citylearn.agents.marlisa.MARLISA property)
peak() (citylearn.cost_function.CostFunction static method)
PeriodicNormalization (class in citylearn.preprocessing)
PolicyNetwork (class in citylearn.rl)
power_efficiency_curve (citylearn.energy_model.Battery property)
power_outage (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
power_outage_signal (citylearn.building.Building property)
PowerOutage (class in citylearn.power_outage)
predict() (citylearn.agents.base.Agent method)
(citylearn.agents.q_learning.TabularQLearning method)
(citylearn.agents.rbc.HourRBC method)
(citylearn.agents.sac.SAC method)
predict_demand() (citylearn.agents.marlisa.MARLISA 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)
random_episode_split (citylearn.citylearn.CityLearnEnv property)
random_seed (citylearn.agents.rlc.RLC property)
(citylearn.base.Environment property)
(citylearn.building.Building property)
(citylearn.power_outage.PowerOutage property)
rbc (citylearn.agents.sac.SACRBC property)
RBC (class in citylearn.agents.rbc)
read_glow_image() (citylearn.rendering.RenderBuilding method)
read_image() (citylearn.rendering.RenderBuilding method)
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)
ReliabilityMetricsPowerOutage (class in citylearn.power_outage)
RemoveFeature (class in citylearn.preprocessing)
render() (citylearn.citylearn.CityLearnEnv method)
RenderBuilding (class in citylearn.rendering)
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.building.DynamicsBuilding method)
(citylearn.citylearn.CityLearnEnv method)
(citylearn.dynamics.Dynamics method)
(citylearn.dynamics.LSTMDynamics method)
(citylearn.energy_model.Battery method)
(citylearn.energy_model.ElectricDevice method)
(citylearn.energy_model.StorageDevice method)
reset_data_sets() (citylearn.building.Building method)
reset_dynamic_variables() (citylearn.building.Building method)
(citylearn.building.DynamicsBuilding method)
reset_power_outage_signal() (citylearn.building.Building method)
reset_time_step() (citylearn.base.Environment method)
reward() (citylearn.wrappers.StableBaselines3RewardWrapper 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)
rolling_episode_split (citylearn.citylearn.CityLearnEnv property)
root_directory (citylearn.citylearn.CityLearnEnv property)
round_trip_efficiency (citylearn.energy_model.StorageDevice property)
S
SAC (class in citylearn.agents.sac)
SACRBC (class in citylearn.agents.sac)
saifi (citylearn.power_outage.ReliabilityMetricsPowerOutage property)
sample() (citylearn.rl.PolicyNetwork method)
(citylearn.rl.ReplayBuffer method)
schema (citylearn.citylearn.CityLearnEnv property)
seconds_per_time_step (citylearn.base.Environment property)
set_combinations() (citylearn.wrappers.TabularQLearningActionWrapper method)
(citylearn.wrappers.TabularQLearningObservationWrapper method)
set_dynamics() (citylearn.building.DynamicsBuilding method)
set_encoders() (citylearn.agents.rlc.RLC method)
(citylearn.agents.sac.SAC method)
set_energy_balance() (citylearn.energy_model.StorageDevice method)
set_energy_coefficients() (citylearn.agents.marlisa.MARLISA method)
set_linear() (citylearn.dynamics.LSTMDynamics method)
set_lstm() (citylearn.dynamics.LSTMDynamics 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)
(citylearn.wrappers.NormalizedObservationWrapper property)
simulate_dynamics (citylearn.building.DynamicsBuilding property)
(citylearn.building.LSTMDynamicsBuilding property)
simulate_power_outage (citylearn.building.Building property)
simulation_end_time_step (citylearn.base.EpisodeTracker property)
simulation_start_time_step (citylearn.base.EpisodeTracker property)
simulation_time_steps (citylearn.base.EpisodeTracker property)
soc (citylearn.energy_model.StorageDevice property)
SoftQNetwork (class in citylearn.rl)
solar_generation (citylearn.building.Building property)
(citylearn.citylearn.CityLearnEnv property)
SolarPenaltyAndComfortReward (class in citylearn.reward_function)
SolarPenaltyReward (class in citylearn.reward_function)
StableBaselines3ActionWrapper (class in citylearn.wrappers)
StableBaselines3ObservationWrapper (class in citylearn.wrappers)
StableBaselines3RewardWrapper (class in citylearn.wrappers)
StableBaselines3Wrapper (class in citylearn.wrappers)
standardize_start_time_step (citylearn.agents.rlc.RLC property)
start_regression_time_step (citylearn.agents.marlisa.MARLISA property)
start_time_steps (citylearn.power_outage.ReliabilityMetricsPowerOutage property)
step() (citylearn.citylearn.CityLearnEnv method)
stochastic_power_outage (citylearn.building.Building property)
stochastic_power_outage_model (citylearn.building.Building property)
StorageDevice (class in citylearn.energy_model)
StorageTank (class in citylearn.energy_model)
T
TabularQLearning (class in citylearn.agents.q_learning)
TabularQLearningActionWrapper (class in citylearn.wrappers)
TabularQLearningObservationWrapper (class in citylearn.wrappers)
TabularQLearningWrapper (class in citylearn.wrappers)
target_cooling_temperature (citylearn.energy_model.HeatPump property)
target_heating_temperature (citylearn.energy_model.HeatPump property)
tau (citylearn.agents.rlc.RLC property)
terminate() (citylearn.dynamics.LSTMDynamics method)
time_step (citylearn.base.Environment property)
time_steps (citylearn.citylearn.CityLearnEnv property)
TimeSeriesData (class in citylearn.data)
to() (citylearn.rl.PolicyNetwork method)
training (citylearn.dynamics.LSTMDynamics attribute)
(citylearn.rl.PolicyNetwork attribute)
(citylearn.rl.SoftQNetwork attribute)
U
uid (citylearn.base.Environment property)
UnknownSchemaError
update() (citylearn.agents.base.Agent method)
(citylearn.agents.marlisa.MARLISA method)
(citylearn.agents.q_learning.TabularQLearning method)
(citylearn.agents.sac.SAC method)
update_cooling_demand() (citylearn.building.Building method)
(citylearn.building.LSTMDynamicsBuilding method)
update_cooling_storage() (citylearn.building.Building method)
update_dhw_storage() (citylearn.building.Building method)
update_electrical_storage() (citylearn.building.Building method)
update_electricity_consumption() (citylearn.energy_model.ElectricDevice method)
update_energy_from_cooling_device() (citylearn.building.Building method)
update_energy_from_dhw_device() (citylearn.building.Building method)
update_energy_from_heating_device() (citylearn.building.Building method)
update_heating_demand() (citylearn.building.Building method)
(citylearn.building.LSTMDynamicsBuilding method)
update_heating_storage() (citylearn.building.Building method)
update_indoor_dry_bulb_temperature() (citylearn.building.DynamicsBuilding method)
(citylearn.building.LSTMDynamicsBuilding method)
update_non_shiftable_load() (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)
WITH_STORAGE_AND_PARTIAL_LOAD_AND_PV (citylearn.citylearn.EvaluationCondition attribute)
WITH_STORAGE_AND_PV (citylearn.citylearn.EvaluationCondition attribute)
WITHOUT_STORAGE_AND_PARTIAL_LOAD_AND_PV (citylearn.citylearn.EvaluationCondition attribute)
WITHOUT_STORAGE_AND_PARTIAL_LOAD_BUT_WITH_PV (citylearn.citylearn.EvaluationCondition attribute)
WITHOUT_STORAGE_AND_PV (citylearn.citylearn.EvaluationCondition attribute)
WITHOUT_STORAGE_BUT_WITH_PARTIAL_LOAD_AND_PV (citylearn.citylearn.EvaluationCondition attribute)
WITHOUT_STORAGE_BUT_WITH_PV (citylearn.citylearn.EvaluationCondition attribute)
write_json() (in module citylearn.utilities)
Z
zero_net_energy() (citylearn.cost_function.CostFunction static method)