Index

A

action() (citylearn.wrappers.DiscreteActionWrapper method) (citylearn.wrappers.NormalizedActionWrapper method) (citylearn.wrappers.RLlibMultiAgentActionWrapper 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) (citylearn.electric_vehicle.ElectricVehicle 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.electric_vehicle.ElectricVehicle property) (citylearn.wrappers.DiscreteActionWrapper property) (citylearn.wrappers.NormalizedActionWrapper property) (citylearn.wrappers.RLlibMultiAgentActionWrapper property) (citylearn.wrappers.StableBaselines3ActionWrapper property) (citylearn.wrappers.TabularQLearningActionWrapper property) actions (citylearn.agents.base.Agent property) active_actions (citylearn.building.Building property) (citylearn.electric_vehicle.ElectricVehicle property) active_observations (citylearn.building.Building property) (citylearn.electric_vehicle.ElectricVehicle property)

add_other_equipment() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator method) adjust_electric_vehicle_soc_on_system_connection() (citylearn.electric_vehicle.ElectricVehicle method) Agent (class in citylearn.agents.base) allow_multi_load_time_step (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator property) alpha (citylearn.agents.rlc.RLC property) apply_actions() (citylearn.building.Building method) (citylearn.building.DynamicsBuilding method) (citylearn.building.OccupantInteractionBuilding method) associate_electric_vehicles_to_chargers() (citylearn.citylearn.CityLearnEnv method) associate_incoming_car() (citylearn.electric_vehicle_charger.Charger method) autosize() (citylearn.energy_model.Battery method) (citylearn.energy_model.ElectricHeater method) (citylearn.energy_model.HeatPump method) (citylearn.energy_model.PV method) (citylearn.energy_model.StorageDevice method) autosize_battery() (citylearn.electric_vehicle.ElectricVehicle method) autosize_config (citylearn.energy_model.Device property) 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.electric_vehicle_charger.Charger property) (citylearn.energy_model.ElectricDevice property)

B

band (citylearn.reward_function.ComfortReward property) BaselineAgent (class in citylearn.agents.base) 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 (citylearn.electric_vehicle.ElectricVehicle property) Battery (class in citylearn.energy_model)

BATTERY_CHOICES_FILENAME (citylearn.data.DataSet attribute) bldg_ids (citylearn.end_use_load_profiles.clustering.Clustering property) (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild property) build() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) Building (class in citylearn.building) building_metadata (citylearn.agents.base.Agent property) buildings (citylearn.citylearn.CityLearnEnv property) (citylearn.wrappers.RLlibMultiAgentEnv property)

C

cache_directory (citylearn.data.DataSet property) 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) (citylearn.reward_function.V2GPenaltyReward method) calculate_ev_penalty() (citylearn.reward_function.V2GPenaltyReward 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) 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) charge_efficiency_curve (citylearn.electric_vehicle_charger.Charger property) charger (citylearn.data.ElectricVehicleSimulation attribute) Charger (class in citylearn.electric_vehicle_charger) charger_id (citylearn.electric_vehicle_charger.Charger property) charger_type (citylearn.electric_vehicle_charger.Charger property) 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.electric_vehicle module citylearn.electric_vehicle_charger module

citylearn.end_use_load_profiles module citylearn.end_use_load_profiles.clustering module citylearn.end_use_load_profiles.lstm_model module citylearn.end_use_load_profiles.lstm_model.model module citylearn.end_use_load_profiles.lstm_model.model_generation module citylearn.end_use_load_profiles.lstm_model.model_generation_wrapper module citylearn.end_use_load_profiles.lstm_model.preprocessing module citylearn.end_use_load_profiles.neighborhood module citylearn.end_use_load_profiles.simulate module citylearn.energy_model module citylearn.occupant module citylearn.power_outage module citylearn.preprocessing module citylearn.reward_function module citylearn.rl module citylearn.utilities module citylearn.wrappers module citylearn_simulation_lstm_error_data (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild property) citylearn_simulation_lstm_prediction_data (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild property) citylearn_simulation_test_evaluation (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild property) CityLearnEnv (class in citylearn.citylearn) clear_cache() (citylearn.data.DataSet method) ClippedObservationWrapper (class in citylearn.wrappers) cluster() (citylearn.end_use_load_profiles.clustering.Clustering method) Clustering (class in citylearn.end_use_load_profiles.clustering) coefficients (citylearn.reward_function.SolarPenaltyAndComfortReward property) comfort_band (citylearn.building.Building property) ComfortReward (class in citylearn.reward_function) community_weight (citylearn.reward_function.V2GPenaltyReward property) connected_electric_vehicle (citylearn.electric_vehicle_charger.Charger property) 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_device_cop (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) cost() (citylearn.cost_function.CostFunction static method) CostFunction (class in citylearn.cost_function)

D

DataSet (class in citylearn.data) dataset_dataloader() (in module citylearn.end_use_load_profiles.lstm_model.preprocessing) dataset_directory (citylearn.end_use_load_profiles.neighborhood.Neighborhood property) datasets_path (citylearn.data.DataSet property) DEFAULT_CACHE_DIRECTORY (citylearn.data.DataSet attribute) DEFAULT_RANDOM_SEED_RANGE (citylearn.base.Environment attribute) DEFAULT_SECONDS_PER_TIME_STEP (citylearn.base.Environment attribute) DEFUALT_COMFORT_BAND (citylearn.data.EnergySimulation attribute) degrade() (citylearn.energy_model.Battery method) degraded_capacity (citylearn.energy_model.Battery property) delete_energyplus_simulation_output() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) delta_output_map (citylearn.occupant.LogisticRegressionOccupant property) demand_observation_limit_factor (citylearn.building.Building 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_device_cop (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) disassociate_incoming_car() (citylearn.electric_vehicle_charger.Charger method) discharge_efficiency_curve (citylearn.electric_vehicle_charger.Charger 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) downward_electrical_flexibility (citylearn.building.Building property) Dynamics (class in citylearn.dynamics) DynamicsBuilding (class in citylearn.building)

E

efficiency (citylearn.electric_vehicle_charger.Charger property) (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) electric_vehicle_charger_state (citylearn.data.ElectricVehicleSimulation attribute) electric_vehicle_chargers (citylearn.building.Building property) electric_vehicle_departure_time (citylearn.data.ElectricVehicleSimulation attribute) electric_vehicle_estimated_arrival_time (citylearn.data.ElectricVehicleSimulation attribute) electric_vehicle_estimated_soc_arrival (citylearn.data.ElectricVehicleSimulation attribute) electric_vehicle_required_soc_departure (citylearn.data.ElectricVehicleSimulation attribute) electric_vehicle_simulation (citylearn.electric_vehicle.ElectricVehicle property) electric_vehicles (citylearn.citylearn.CityLearnEnv 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.electric_vehicle_charger.Charger property) (citylearn.energy_model.ElectricDevice property) electricity_consumption() (citylearn.cost_function.CostFunction static method) ElectricVehicle (class in citylearn.electric_vehicle) ElectricVehicleSimulation (class in citylearn.data) Encoder (class in citylearn.preprocessing) end_exploration_time_step (citylearn.agents.rlc.RLC property) end_use_load_profiles (citylearn.end_use_load_profiles.neighborhood.Neighborhood property) EndUseLoadProfilesEnergyPlusPartialLoadSimulator (class in citylearn.end_use_load_profiles.simulate) 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) energy_transfer_bonus (citylearn.reward_function.V2GPenaltyReward property) energyplus_output_directory (citylearn.end_use_load_profiles.neighborhood.Neighborhood property) EnergySimulation (class in citylearn.data) env (citylearn.agents.base.Agent property) (citylearn.agents.base.BaselineAgent property) 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_rewards (citylearn.citylearn.CityLearnEnv 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.building.OccupantInteractionBuilding property) (citylearn.citylearn.CityLearnEnv property) EpisodeTracker (class in citylearn.base) Error estimate_action_space() (citylearn.building.Building method) (citylearn.electric_vehicle.ElectricVehicle method) estimate_observation_space() (citylearn.building.Building method) (citylearn.electric_vehicle.ElectricVehicle method) estimate_observation_space_limits() (citylearn.building.Building method) (citylearn.electric_vehicle.ElectricVehicle method) eval() (in module citylearn.end_use_load_profiles.lstm_model.model_generation) evaluate() (citylearn.citylearn.CityLearnEnv method) (citylearn.wrappers.RLlibMultiAgentEnv method) evaluate_citylearn_challenge() (citylearn.citylearn.CityLearnEnv method) EvaluationCondition (class in citylearn.citylearn) exponent (citylearn.reward_function.RewardFunction property)

F

forward() (citylearn.dynamics.LSTMDynamics method) (citylearn.end_use_load_profiles.lstm_model.model.LSTM method) (citylearn.rl.PolicyNetwork method) (citylearn.rl.SoftQNetwork method)

G

get_battery_sizing_data() (citylearn.data.DataSet method) get_cop() (citylearn.energy_model.HeatPump method) get_current_efficiency() (citylearn.energy_model.Battery method) get_dataset() (citylearn.data.DataSet method) get_dataset_names() (citylearn.data.DataSet 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_github_contents() (citylearn.data.DataSet method) get_ideal_loads() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator method) get_info() (citylearn.citylearn.CityLearnEnv method) get_input_power() (citylearn.energy_model.ElectricHeater method) (citylearn.energy_model.HeatPump method) get_lstm_training_data() (citylearn.end_use_load_profiles.neighborhood.Neighborhood 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_model() (in module citylearn.end_use_load_profiles.lstm_model.model_generation_wrapper) get_multipliers() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator method) get_normalized_observations() (citylearn.agents.sac.SAC method) get_normalized_reward() (citylearn.agents.sac.SAC method) get_optimal_clusters() (citylearn.end_use_load_profiles.clustering.Clustering method) get_periodic_observation_metadata() (citylearn.building.Building static method) (citylearn.electric_vehicle.ElectricVehicle static method) 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_pv_sizing_data() (citylearn.data.DataSet method) get_regression_variables() (citylearn.agents.marlisa.MARLISA method) get_requests_session() (citylearn.data.DataSet static method) get_schema() (citylearn.data.DataSet method) get_settings() (in module citylearn.data) get_signals() (citylearn.power_outage.PowerOutage method) (citylearn.power_outage.ReliabilityMetricsPowerOutage method) get_weather_data() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) get_zone_conditioning_metadata() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator method) GITHUB_ACCOUNT (citylearn.data.DataSet attribute) github_account (citylearn.data.DataSet property) GITHUB_API_CONTENT_URL (citylearn.data.DataSet attribute)

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_device_cop (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)

I

ideal_loads_simulator (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator property) incoming_electric_vehicle (citylearn.electric_vehicle_charger.Charger property) IndependentSACReward (class in citylearn.reward_function) indoor_dry_bulb_temperature (citylearn.building.Building property) indoor_dry_bulb_temperature_cooling_set_point (citylearn.building.Building property) indoor_dry_bulb_temperature_heating_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) (citylearn.end_use_load_profiles.lstm_model.model.LSTM method) initial_soc (citylearn.energy_model.Battery property) (citylearn.energy_model.StorageDevice property) input_size (citylearn.dynamics.LSTMDynamics property) insert_zone_metadata() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator method) iterations (citylearn.agents.marlisa.MARLISA property)

J

join_url() (in module citylearn.utilities)

L

learn() (citylearn.agents.base.Agent method) load_agent() (citylearn.citylearn.CityLearnEnv method) logging_level (citylearn.data.DataSet property) LogisticRegressionOccupant (class in citylearn.occupant) LogisticRegressionOccupantInteractionBuilding (class in citylearn.building) LogisticRegressionOccupantParameters (class in citylearn.data)

loss_coefficient (citylearn.energy_model.StorageDevice property) lower_exponent (citylearn.reward_function.ComfortReward property) lr (citylearn.agents.rlc.RLC property) LSTM (class in citylearn.end_use_load_profiles.lstm_model.model) lstm_test_data (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild 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_charging_power (citylearn.electric_vehicle_charger.Charger property) max_discharging_power (citylearn.electric_vehicle_charger.Charger property) max_input_power (citylearn.energy_model.StorageTank property) max_output_power (citylearn.energy_model.StorageTank property) max_workers (citylearn.end_use_load_profiles.neighborhood.Neighborhood property) maximum_clusters (citylearn.end_use_load_profiles.clustering.Clustering property) maximum_temperature_delta (citylearn.building.Building property) METADATA_CLUSTER_FREQUENCY (citylearn.end_use_load_profiles.neighborhood.SampleMethod attribute) MetadataClustering (class in citylearn.end_use_load_profiles.clustering) min_battery_soc (citylearn.electric_vehicle.ElectricVehicle property) min_charging_power (citylearn.electric_vehicle_charger.Charger property) min_discharging_power (citylearn.electric_vehicle_charger.Charger property) misc_path (citylearn.data.DataSet 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.electric_vehicle citylearn.electric_vehicle_charger citylearn.end_use_load_profiles citylearn.end_use_load_profiles.clustering citylearn.end_use_load_profiles.lstm_model citylearn.end_use_load_profiles.lstm_model.model citylearn.end_use_load_profiles.lstm_model.model_generation citylearn.end_use_load_profiles.lstm_model.model_generation_wrapper citylearn.end_use_load_profiles.lstm_model.preprocessing citylearn.end_use_load_profiles.neighborhood citylearn.end_use_load_profiles.simulate citylearn.energy_model citylearn.occupant citylearn.power_outage citylearn.preprocessing citylearn.reward_function citylearn.rl citylearn.utilities citylearn.wrappers

multi_simulate() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator class method) multiplier_maximum (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator property) multiplier_minimum (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator property) multiplier_probability (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator property) multiprocess_test_lstm() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method)

N

name (citylearn.building.Building property) (citylearn.electric_vehicle.ElectricVehicle property) Neighborhood (class in citylearn.end_use_load_profiles.neighborhood) NeighborhoodBuild (class in citylearn.end_use_load_profiles.neighborhood) 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.OccupantInteractionBuilding method) (citylearn.citylearn.CityLearnEnv method) (citylearn.electric_vehicle.ElectricVehicle method) (citylearn.electric_vehicle_charger.Charger method) nominal_power (citylearn.electric_vehicle_charger.Charger property) (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) numpy_random_state (citylearn.base.Environment property)

O

observation() (citylearn.wrappers.ClippedObservationWrapper method) (citylearn.wrappers.DiscreteObservationWrapper method) (citylearn.wrappers.NormalizedObservationWrapper method) (citylearn.wrappers.RLlibMultiAgentObservationWrapper method) (citylearn.wrappers.StableBaselines3ObservationWrapper method) (citylearn.wrappers.TabularQLearningObservationWrapper method) observation_dimension (citylearn.agents.rlc.RLC property) observation_metadata (citylearn.building.Building property) (citylearn.electric_vehicle.ElectricVehicle 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.electric_vehicle.ElectricVehicle property) (citylearn.wrappers.DiscreteObservationWrapper property) (citylearn.wrappers.NormalizedObservationWrapper property) (citylearn.wrappers.RLlibMultiAgentObservationWrapper property) (citylearn.wrappers.StableBaselines3ObservationWrapper property) (citylearn.wrappers.TabularQLearningObservationWrapper property)

observation_space_limit_delta (citylearn.building.Building property) observations (citylearn.citylearn.CityLearnEnv property) observations() (citylearn.building.Building method) (citylearn.electric_vehicle.ElectricVehicle method) observations_length() (citylearn.electric_vehicle.ElectricVehicle static method) Occupant (class in citylearn.occupant) occupant_count (citylearn.building.Building property) OccupantInteractionBuilding (class in citylearn.building) 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

past_charging_action_values (citylearn.electric_vehicle_charger.Charger property) past_connected_evs (citylearn.electric_vehicle_charger.Charger property) pca_compression (citylearn.agents.marlisa.MARLISA property) peak() (citylearn.cost_function.CostFunction static method) peak_penalty_weight (citylearn.reward_function.V2GPenaltyReward property) peak_percentage_threshold (citylearn.reward_function.V2GPenaltyReward property) penalty_battery_limits (citylearn.reward_function.V2GPenaltyReward property) penalty_no_car_charging (citylearn.reward_function.V2GPenaltyReward property) penalty_soc_under_5_10 (citylearn.reward_function.V2GPenaltyReward property) PeriodicNormalization (class in citylearn.preprocessing) plug_car() (citylearn.electric_vehicle_charger.Charger method) 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.base.BaselineAgent method) (citylearn.agents.q_learning.TabularQLearning method) (citylearn.agents.rbc.HourRBC method) (citylearn.agents.sac.SAC method) (citylearn.occupant.LogisticRegressionOccupant method) (citylearn.occupant.Occupant method) predict_demand() (citylearn.agents.marlisa.MARLISA method) preprocess_df() (in module citylearn.end_use_load_profiles.lstm_model.preprocessing) preprocess_idf_for_simulation() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator method) pricing (citylearn.building.Building property) Pricing (class in citylearn.data) probabilities (citylearn.occupant.LogisticRegressionOccupant property) push() (citylearn.rl.RegressionBuffer method) (citylearn.rl.ReplayBuffer method) pv (citylearn.building.Building property) PV (class in citylearn.energy_model) PV_CHOICES_FILENAME (citylearn.data.DataSet attribute)

Q

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

QUERIES_DIRECTORY (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator attribute)

R

ramping() (citylearn.cost_function.CostFunction static method) ramping_penalty_weight (citylearn.reward_function.V2GPenaltyReward property) ramping_percentage_threshold (citylearn.reward_function.V2GPenaltyReward property) RANDOM (citylearn.end_use_load_profiles.neighborhood.SampleMethod attribute) random_episode_split (citylearn.citylearn.CityLearnEnv property) random_seed (citylearn.agents.rlc.RLC property) (citylearn.base.Environment property) (citylearn.building.Building property) (citylearn.building.OccupantInteractionBuilding property) (citylearn.citylearn.CityLearnEnv property) (citylearn.end_use_load_profiles.clustering.Clustering property) (citylearn.end_use_load_profiles.neighborhood.Neighborhood property) (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator property) (citylearn.power_outage.PowerOutage property) rbc (citylearn.agents.sac.SACRBC property) RBC (class in citylearn.agents.rbc) read_json() (in module citylearn.utilities) read_pickle() (in module citylearn.utilities) read_yaml() (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) remove_ideal_loads_air_system() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator method) RemoveFeature (class in citylearn.preprocessing) replay_buffer_capacity (citylearn.agents.rlc.RLC property) ReplayBuffer (class in citylearn.rl) repository (citylearn.data.DataSet property) REPOSITORY_DATA_DATASETS_PATH (citylearn.data.DataSet attribute) REPOSITORY_DATA_MISC_PATH (citylearn.data.DataSet attribute) REPOSITORY_DATA_PATH (citylearn.data.DataSet attribute) REPOSITORY_NAME (citylearn.data.DataSet attribute) REPOSITORY_TAG (citylearn.data.DataSet attribute) reset() (citylearn.agents.base.Agent method) (citylearn.agents.marlisa.MARLISA method) (citylearn.base.Environment method) (citylearn.building.Building method) (citylearn.building.DynamicsBuilding method) (citylearn.building.LogisticRegressionOccupantInteractionBuilding method) (citylearn.building.OccupantInteractionBuilding method) (citylearn.citylearn.CityLearnEnv method) (citylearn.dynamics.Dynamics method) (citylearn.dynamics.LSTMDynamics method) (citylearn.electric_vehicle.ElectricVehicle method) (citylearn.electric_vehicle_charger.Charger method) (citylearn.energy_model.Battery method) (citylearn.energy_model.ElectricDevice method) (citylearn.energy_model.StorageDevice method) (citylearn.occupant.LogisticRegressionOccupant method) (citylearn.reward_function.RewardFunction method) (citylearn.wrappers.RLlibMultiAgentEnv method)

reset_data_sets() (citylearn.building.Building method) (citylearn.building.LogisticRegressionOccupantInteractionBuilding method) reset_dynamic_variables() (citylearn.building.Building method) (citylearn.building.DynamicsBuilding method) (citylearn.building.LogisticRegressionOccupantInteractionBuilding method) (citylearn.building.OccupantInteractionBuilding method) reset_episode_index() (citylearn.base.EpisodeTracker method) reset_power_outage_signal() (citylearn.building.Building method) reset_time_step() (citylearn.base.Environment method) reward() (citylearn.wrappers.RLlibMultiAgentRewardWrapper method) (citylearn.wrappers.StableBaselines3RewardWrapper method) reward_close_soc (citylearn.reward_function.V2GPenaltyReward property) reward_extra_self_production (citylearn.reward_function.V2GPenaltyReward property) reward_function (citylearn.citylearn.CityLearnEnv property) reward_scaling (citylearn.agents.rlc.RLC property) reward_self_ev_consumption (citylearn.reward_function.V2GPenaltyReward property) RewardFunction (class in citylearn.reward_function) rewards (citylearn.citylearn.CityLearnEnv property) RLC (class in citylearn.agents.rlc) RLlibMultiAgentActionWrapper (class in citylearn.wrappers) RLlibMultiAgentEnv (class in citylearn.wrappers) RLlibMultiAgentObservationWrapper (class in citylearn.wrappers) RLlibMultiAgentRewardWrapper (class in citylearn.wrappers) RLlibSingleAgentWrapper (class in citylearn.wrappers) rolling_episode_split (citylearn.citylearn.CityLearnEnv property) root_directory (citylearn.citylearn.CityLearnEnv property) round_trip_efficiency (citylearn.energy_model.StorageDevice property) run() (in module citylearn.end_use_load_profiles.lstm_model.model_generation) run_one_model() (in module citylearn.end_use_load_profiles.lstm_model.model_generation_wrapper)

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) sample_buildings() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) sample_cluster_labels (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild property) sample_metadata (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild property) SampleMethod (class in citylearn.end_use_load_profiles.neighborhood) schema (citylearn.citylearn.CityLearnEnv property) schema_filepath (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild property) seconds_per_time_step (citylearn.base.Environment property) set_ad_hoc_charge() (citylearn.energy_model.Battery method) set_combinations() (citylearn.wrappers.TabularQLearningActionWrapper method) (citylearn.wrappers.TabularQLearningObservationWrapper method) set_data() (citylearn.end_use_load_profiles.clustering.Clustering method) (citylearn.end_use_load_profiles.clustering.MetadataClustering 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_point_hold_time_steps (citylearn.building.LogisticRegressionOccupantInteractionBuilding property) set_random_seeds() (in module citylearn.end_use_load_profiles.lstm_model.model_generation_wrapper) set_regression_encoders() (citylearn.agents.marlisa.MARLISA method) set_schema() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) setpoint_decrease_model_filepath (citylearn.occupant.LogisticRegressionOccupant property) setpoint_increase_model_filepath (citylearn.occupant.LogisticRegressionOccupant property)

shared_observations (citylearn.citylearn.CityLearnEnv property) (citylearn.wrappers.NormalizedObservationWrapper property) simulate() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator method) simulate_dynamics (citylearn.building.DynamicsBuilding property) (citylearn.building.LSTMDynamicsBuilding property) simulate_energy_plus() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) 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) simulators (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild property) sliding_windows() (in module citylearn.end_use_load_profiles.lstm_model.preprocessing) 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) (citylearn.wrappers.RLlibMultiAgentEnv 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) sum_of_squares_error_minimum_percent_change (citylearn.end_use_load_profiles.clustering.Clustering property)

T

TabularQLearning (class in citylearn.agents.q_learning) TabularQLearningActionWrapper (class in citylearn.wrappers) TabularQLearningObservationWrapper (class in citylearn.wrappers) TabularQLearningWrapper (class in citylearn.wrappers) tag (citylearn.data.DataSet property) 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) terminated (citylearn.citylearn.CityLearnEnv property) (citylearn.wrappers.RLlibMultiAgentEnv property)

test_citylearn_simulation() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) test_lstm() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) time_step (citylearn.base.Environment property) (citylearn.wrappers.RLlibMultiAgentEnv property) time_steps (citylearn.citylearn.CityLearnEnv property) TimeSeriesData (class in citylearn.data) to() (citylearn.rl.PolicyNetwork method) train() (in module citylearn.end_use_load_profiles.lstm_model.model_generation) train_lstm() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) truncated (citylearn.citylearn.CityLearnEnv property)

U

uid (citylearn.base.Environment property) UnknownSchemaError unplug_car() (citylearn.electric_vehicle_charger.Charger method) update() (citylearn.agents.base.Agent method) (citylearn.agents.marlisa.MARLISA method) (citylearn.agents.q_learning.TabularQLearning method) (citylearn.agents.sac.SAC method) update_connected_electric_vehicle_soc() (citylearn.electric_vehicle_charger.Charger 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_set_points() (citylearn.building.LogisticRegressionOccupantInteractionBuilding method) (citylearn.building.OccupantInteractionBuilding method) update_variables() (citylearn.building.Building method) (citylearn.citylearn.CityLearnEnv method)

V

V2GPenaltyReward (class in citylearn.reward_function)

W

weather (citylearn.building.Building property) Weather (class in citylearn.data) window_size (citylearn.reward_function.V2GPenaltyReward property) 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) write_pickle() (in module citylearn.utilities) write_yaml() (in module citylearn.utilities)

Z

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