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_feedback (citylearn.internal.entity_observations.ObservationContext attribute) ACTION_FEEDBACK_BUNDLE (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) ACTION_FEEDBACK_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) action_history_ids (citylearn.agents.base.Agent property) action_map (citylearn.agents.rbc.BasicBatteryRBC property) (citylearn.agents.rbc.BasicElectricVehicleRBC_ReferenceController 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.internal.entity_interface.CityLearnEntityInterfaceService property) (citylearn.multi_community.MultiCommunityEnv property) (citylearn.wrappers.DiscreteActionWrapper property) (citylearn.wrappers.NormalizedActionWrapper property) (citylearn.wrappers.RLlibMultiAgentActionWrapper property) (citylearn.wrappers.StableBaselines3ActionWrapper property) (citylearn.wrappers.TabularQLearningActionWrapper property) action_to_state() (citylearn.energy_model.Escalator class method) actions (citylearn.agents.base.Agent property) activation_price_eur_per_kwh (citylearn.internal.demand_response.DemandResponseRequest attribute) active_actions (citylearn.building.Building property) active_chargers_at() (citylearn.internal.topology.CityLearnTopologyService method) active_deferrable_appliances_at() (citylearn.internal.topology.CityLearnTopologyService method) active_ev_ids (citylearn.internal.topology.CityLearnTopologyService property) active_ev_ids_at() (citylearn.internal.topology.CityLearnTopologyService method) active_member_ids (citylearn.internal.topology.CityLearnTopologyService property) active_member_ids_at() (citylearn.internal.topology.CityLearnTopologyService method) active_observations (citylearn.building.Building property) active_storage_at() (citylearn.internal.topology.CityLearnTopologyService method) ActivePopulation (class in citylearn.internal.kpi_population) add() (in module citylearn.internal.provenance) add_model_options() (in module citylearn.internal.loading_components) add_other_equipment() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator method) adjust_observation_space() (citylearn.internal.robustness.CityLearnRobustnessService method) adjusted_space() (in module citylearn.internal.robustness_spaces) Agent (class in citylearn.agents.base)

allocate_electrical_service() (in module citylearn.internal.electrical_limits) allow_multi_load_time_step (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator property) alpha (citylearn.agents.rlc.RLC property) append() (citylearn.internal.market_history.MarketSettlementHistory method) appliance_id (citylearn.internal.entity_interface.DeferrableApplianceRef attribute) application_scopes() (citylearn.internal.robustness_history.RobustnessHistory method) apply() (in module citylearn.internal.observation_contract) apply_actions() (citylearn.building.Building method) (citylearn.building.DynamicsBuilding method) (citylearn.building.OccupantInteractionBuilding method) (citylearn.internal.building_ops.BuildingOpsService method) (citylearn.internal.robustness.CityLearnRobustnessService method) apply_charging_constraints_to_actions() (citylearn.internal.building_ops.BuildingOpsService method) apply_events_for_time_step() (citylearn.internal.topology.CityLearnTopologyService method) apply_observations() (citylearn.internal.robustness.CityLearnRobustnessService method) arrival_soc() (in module citylearn.internal.ev_departure_audit) as_dict() (citylearn.building.Building method) (citylearn.citylearn.CityLearnEnv method) (citylearn.data.Pricing method) (citylearn.electric_vehicle.ElectricVehicle method) (citylearn.electric_vehicle_charger.Charger method) (citylearn.energy_model.Battery method) (citylearn.energy_model.DeferrableAppliance method) (citylearn.energy_model.WashingMachine method) assert_step_invariants() (citylearn.internal.physics_invariants.CityLearnPhysicsInvariantService method) assets() (citylearn.internal.provenance.CityLearnProvenanceService method) associate_chargers_to_electric_vehicles() (citylearn.citylearn.CityLearnEnv method) (citylearn.internal.runtime.CityLearnRuntimeService method) associate_incoming_car() (citylearn.electric_vehicle_charger.Charger method) at() (citylearn.internal.temporal.TimeAxis method) audit_summary() (citylearn.internal.demand_response.CityLearnDemandResponseService method) (citylearn.internal.robustness.CityLearnRobustnessService 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_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.energy_model.ElectricDevice property) axis_metadata() (in module citylearn.internal.temporal)

B

bag (citylearn.internal.provenance.Stock attribute) BalanceAuditError band (citylearn.reward_function.ComfortReward property) base_building_options() (in module citylearn.internal.loading_components) BASE_BUNDLE (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) BASE_CHARGER_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) BASE_STORAGE_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) BaselineAgent (class in citylearn.agents.base) BasicBatteryRBC (class in citylearn.agents.rbc) BasicElectricVehicleRBC_ReferenceController (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) (citylearn.internal.provenance.Stock attribute) Battery (class in citylearn.energy_model) BATTERY_CHOICES_FILENAME (citylearn.data.DataSet attribute) begin_step() (citylearn.internal.provenance.CityLearnProvenanceService method) bldg_ids (citylearn.end_use_load_profiles.clustering.Clustering property) (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild property) boundary() (citylearn.internal.balance_audit.IndependentBalanceAudit method)

build() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) build_spaces() (in module citylearn.internal.entity_layout) build_specs() (in module citylearn.internal.entity_layout) build_static_observation_rows() (in module citylearn.internal.entity_layout) Building (class in citylearn.building) building_index (citylearn.internal.entity_interface.ChargerRef attribute) (citylearn.internal.entity_interface.DeferrableApplianceRef attribute) (citylearn.internal.entity_interface.PVRef attribute) (citylearn.internal.entity_interface.StorageRef attribute) building_metadata (citylearn.agents.base.Agent property) building_name (citylearn.internal.entity_interface.ChargerRef attribute) (citylearn.internal.entity_interface.DeferrableApplianceRef attribute) (citylearn.internal.entity_interface.PVRef attribute) (citylearn.internal.entity_interface.StorageRef attribute) building_records() (citylearn.internal.kpi_equipment.EquipmentKPIAccumulator method) (in module citylearn.internal.kpi_energy) BuildingInputs (class in citylearn.internal.loading_inputs) BuildingOpsService (class in citylearn.internal.building_ops) buildings (citylearn.citylearn.CityLearnEnv property) (citylearn.wrappers.RLlibMultiAgentEnv property) BusinessAsUsualAgent (class in citylearn.agents.baseline) BusinessAsUsualBaselineResult (class in citylearn.internal.baseline)

C

cache_directory (citylearn.data.DataSet property) caidi (citylearn.power_outage.ReliabilityMetricsPowerOutage property) calculate() (citylearn.reward_function.ComfortReward method) (citylearn.reward_function.Electric_Vehicles_Reward_Function method) (citylearn.reward_function.IndependentSACReward method) (citylearn.reward_function.MARL method) (citylearn.reward_function.MultiBuildingRewardFunction method) (citylearn.reward_function.RewardFunction method) (citylearn.reward_function.SolarPenaltyAndComfortReward method) (citylearn.reward_function.SolarPenaltyReward method) calculate_ev_penalty() (citylearn.reward_function.Electric_Vehicles_Reward_Function method) cancel() (citylearn.internal.deferrable_service_audit.ServiceLedger method) cancel_pending_and_running() (citylearn.energy_model.DeferrableAppliance method) canonical() (in module citylearn.internal.comparison) 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) capture_battery_energy_before_actions() (citylearn.internal.physics_invariants.CityLearnPhysicsInvariantService method) carbon_emissions() (citylearn.cost_function.CostFunction static method) carbon_intensity (citylearn.building.Building property) (citylearn.internal.loading_inputs.BuildingInputs attribute) CarbonIntensity (class in citylearn.data) central_agent (citylearn.citylearn.CityLearnEnv property) (citylearn.multi_community.MultiCommunityEnv property) (citylearn.reward_function.RewardFunction property) changed() (citylearn.internal.deferrable_cycles.CycleIndex method) charge() (citylearn.community_dataset.InventoryBattery method) (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 (class in citylearn.electric_vehicle_charger) charger_id (citylearn.electric_vehicle_charger.Charger property) (citylearn.internal.entity_interface.ChargerRef attribute) charger_phase_map (citylearn.building.Building property) charger_simulation (citylearn.electric_vehicle_charger.Charger property) ChargerRef (class in citylearn.internal.entity_interface) chargers_electricity_consumption (citylearn.building.Building property) ChargerSimulation (class in citylearn.data) charging_building_limit_kw (citylearn.building.Building property) charging_constraint_penalty_coefficient (citylearn.reward_function.RewardFunction property) check() (citylearn.internal.balance_audit.IndependentBalanceAudit method) citylearn module citylearn.agents module citylearn.agents.base module citylearn.agents.baseline 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.community_dataset 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.exporter module citylearn.internal module citylearn.internal.balance_audit module citylearn.internal.baseline module citylearn.internal.building_ops module citylearn.internal.capabilities module citylearn.internal.comparison module citylearn.internal.deferrable_cycles module citylearn.internal.deferrable_service_audit module citylearn.internal.demand_response module citylearn.internal.electrical_limits module citylearn.internal.entity_interface module citylearn.internal.entity_layout module citylearn.internal.entity_observations module citylearn.internal.ev_departure_audit module citylearn.internal.evaluation_progress module citylearn.internal.experiment module citylearn.internal.kpi module

citylearn.internal.kpi_community module citylearn.internal.kpi_energy module citylearn.internal.kpi_equipment module citylearn.internal.kpi_family_audit module citylearn.internal.kpi_population module citylearn.internal.kpi_service_metrics module citylearn.internal.loading module citylearn.internal.loading_components module citylearn.internal.loading_inputs module citylearn.internal.market_history module citylearn.internal.observation_contract module citylearn.internal.physics_invariants module citylearn.internal.provenance module citylearn.internal.robustness module citylearn.internal.robustness_audit module citylearn.internal.robustness_history module citylearn.internal.robustness_spaces module citylearn.internal.robustness_targets module citylearn.internal.runtime module citylearn.internal.temporal module citylearn.internal.topology module citylearn.internal.units module citylearn.multi_community module citylearn.occupant module citylearn.power_outage module citylearn.preprocessing module citylearn.reward_function module citylearn.rl module citylearn.utilities module citylearn.utils module citylearn.utils.file_handler module citylearn.utils.noise module citylearn.utils.paths 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) CityLearnBusinessAsUsualBaselineService (class in citylearn.internal.baseline) CityLearnDemandResponseService (class in citylearn.internal.demand_response) CityLearnEntityInterfaceService (class in citylearn.internal.entity_interface) CityLearnEnv (class in citylearn.citylearn) CityLearnKPIService (class in citylearn.internal.kpi) CityLearnLoadingService (class in citylearn.internal.loading) CityLearnPhysicsInvariantService (class in citylearn.internal.physics_invariants) CityLearnProvenanceService (class in citylearn.internal.provenance) CityLearnRobustnessService (class in citylearn.internal.robustness) CityLearnRuntimeService (class in citylearn.internal.runtime) CityLearnTopologyService (class in citylearn.internal.topology) clear() (citylearn.internal.baseline.CityLearnBusinessAsUsualBaselineService method) (citylearn.internal.market_history.MarketSettlementHistory method) clear_cache() (citylearn.data.DataSet method) clear_step_electric_loads_for_action() (citylearn.building.Building method) ClippedObservationWrapper (class in citylearn.wrappers) close() (citylearn.citylearn.CityLearnEnv method) (citylearn.multi_community.MultiCommunityEnv method) 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 (citylearn.internal.entity_observations.ObservationContext attribute) COMMUNITY_BUNDLE (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) COMMUNITY_DISTRICT_EXTRA_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) community_ids (citylearn.multi_community.MultiCommunityEnv property) CommunityAwareBaselineAgent (class in citylearn.agents.baseline) compare_exports() (in module citylearn.internal.comparison) compare_manifests() (in module citylearn.internal.comparison) component_constructor() (in module citylearn.internal.loading_components) compute_bess_metrics() (in module citylearn.internal.kpi_equipment) compute_district_pv_metrics() (in module citylearn.internal.kpi_equipment) compute_phase_metrics() (in module citylearn.internal.kpi_equipment) compute_pv_metrics() (in module citylearn.internal.kpi_equipment) configuration() (in module citylearn.internal.observation_contract) configure_devices() (in module citylearn.internal.loading_components) configure_tariffs() (in module citylearn.community_dataset) connected_electric_vehicle (citylearn.electric_vehicle_charger.Charger property) connected_start() (in module citylearn.internal.ev_departure_audit) connection (citylearn.internal.provenance.Stock attribute) consume_charging_constraint_penalty() (citylearn.building.Building method) context() (in module citylearn.internal.comparison) context_for() (in module citylearn.internal.entity_observations) CONTROL_FEATURES (citylearn.internal.robustness.CityLearnRobustnessService attribute) 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) core (citylearn.internal.entity_observations.ObservationContext attribute) CORE_BUILDING_EXTRA_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) CORE_BUNDLE (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) cost() (citylearn.cost_function.CostFunction static method) CostFunction (class in citylearn.cost_function) counts() (citylearn.internal.robustness_history.RobustnessHistory method) current_population() (in module citylearn.internal.kpi_population) cursor (citylearn.internal.provenance.Stock attribute) cycle_state (citylearn.energy_model.DeferrableAppliance property) CycleIndex (class in citylearn.internal.deferrable_cycles)

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) day_type (citylearn.data.WashingMachineSimulation attribute) declared_target_view() (in module citylearn.internal.robustness_targets) DEFAULT_BASELINE_METHOD (citylearn.internal.demand_response.CityLearnDemandResponseService attribute) DEFAULT_BASELINE_WINDOW_SECONDS (citylearn.internal.demand_response.CityLearnDemandResponseService attribute) DEFAULT_CACHE_DIRECTORY (citylearn.data.DataSet attribute) DEFAULT_MISSING_REPLACEMENT_VALUE (citylearn.internal.robustness.CityLearnRobustnessService attribute) DEFAULT_OBSERVATION_BUNDLES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) DEFAULT_RANDOM_SEED_RANGE (citylearn.base.Environment attribute) DEFAULT_RENDER_START_DATE (citylearn.citylearn.CityLearnEnv attribute) (citylearn.exporter.EpisodeExporter attribute) DEFAULT_SECONDS_PER_TIME_STEP (citylearn.base.Environment attribute) DEFERRABLE_ACTION_FEEDBACK_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) DEFERRABLE_APPLIANCE_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) deferrable_appliance_observations() (citylearn.internal.building_ops.BuildingOpsService method) deferrable_appliance_simulation (citylearn.energy_model.DeferrableAppliance property) deferrable_appliances (citylearn.building.Building property) deferrable_appliances_electricity_consumption (citylearn.building.Building property) deferrable_records() (in module citylearn.internal.kpi_service_metrics) deferrable_service_audit() (citylearn.internal.kpi.CityLearnKPIService method) DeferrableAppliance (class in citylearn.energy_model) DeferrableApplianceRef (class in citylearn.internal.entity_interface) DeferrableApplianceSimulation (class in citylearn.data) DEFINITION_VERSION (citylearn.agents.baseline.BusinessAsUsualAgent attribute) DEFUALT_COMFORT_BAND (citylearn.data.EnergySimulation attribute) degrade() (citylearn.energy_model.Battery method) degraded_capacity (citylearn.energy_model.Battery property) delay_steps (citylearn.internal.robustness.RobustnessEvent attribute) 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) demand_response (citylearn.internal.entity_observations.ObservationContext attribute) DEMAND_RESPONSE_BUNDLE (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) DEMAND_RESPONSE_DISTRICT_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) DemandResponseRequest (class in citylearn.internal.demand_response) depth_of_discharge (citylearn.energy_model.Battery property) derived_forecast (citylearn.internal.entity_observations.ObservationContext attribute) DERIVED_FORECAST_BUILDING_SIGNALS (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) DERIVED_FORECAST_BUNDLE (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) DERIVED_FORECAST_DISTRICT_SIGNALS (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) 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) digest() (in module citylearn.internal.comparison) direction (citylearn.internal.demand_response.DemandResponseRequest attribute) DIRECTION_CODES (citylearn.internal.demand_response.CityLearnDemandResponseService attribute) 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) district_records() (citylearn.internal.kpi_equipment.EquipmentKPIAccumulator method) (in module citylearn.internal.kpi_energy) downward_electrical_flexibility (citylearn.building.Building property) Dynamics (class in citylearn.dynamics) DynamicsBuilding (class in citylearn.building)

E

edge() (citylearn.internal.balance_audit.FlowNetwork method) 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.ChargerSimulation attribute) electric_vehicle_chargers (citylearn.building.Building property) electric_vehicle_departure_time (citylearn.data.ChargerSimulation attribute) electric_vehicle_estimated_arrival_time (citylearn.data.ChargerSimulation attribute) electric_vehicle_estimated_soc_arrival (citylearn.data.ChargerSimulation attribute) electric_vehicle_id (citylearn.data.ChargerSimulation attribute) electric_vehicle_required_soc_departure (citylearn.data.ChargerSimulation attribute) electric_vehicle_session_id (citylearn.data.ChargerSimulation attribute) electric_vehicles (citylearn.citylearn.CityLearnEnv property) Electric_Vehicles_Reward_Function (class in citylearn.reward_function) ELECTRICAL_RESIDUAL_EPS_KW (citylearn.internal.kpi.CityLearnKPIService attribute) electrical_service_enabled (citylearn.building.Building property) electrical_service_mode (citylearn.building.Building property) electrical_service_violation_kw() (in module citylearn.internal.electrical_limits) electrical_storage (citylearn.building.Building property) electrical_storage_electricity_consumption (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) electrical_storage_phase_connection (citylearn.building.Building property) ElectricalServiceAllocation (class in citylearn.internal.electrical_limits) 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) emit() (citylearn.internal.evaluation_progress.EvaluationProgress method) empty_counts() (in module citylearn.internal.ev_departure_audit) enabled (citylearn.internal.topology.CityLearnTopologyService property) Encoder (class in citylearn.preprocessing) end_exploration_time_step (citylearn.agents.rlc.RLC property) end_time_step (citylearn.data.WashingMachineSimulation attribute) (citylearn.internal.demand_response.DemandResponseRequest attribute) (citylearn.internal.robustness.RobustnessEvent attribute) end_use_load_profiles (citylearn.end_use_load_profiles.neighborhood.Neighborhood property) endogenous_time_step (citylearn.internal.entity_observations.ObservationContext attribute) EndUseLoadProfilesEnergyPlusPartialLoadSimulator (class in citylearn.end_use_load_profiles.simulate) energy() (in module citylearn.internal.provenance) energy_balance (citylearn.energy_model.StorageDevice property) ENERGY_EPS (citylearn.internal.physics_invariants.CityLearnPhysicsInvariantService attribute) 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_kwh_to_power_kw() (in module citylearn.internal.units) energy_provenance_events (citylearn.energy_model.StorageDevice property) energy_simulation (citylearn.building.Building property) (citylearn.internal.loading_inputs.BuildingInputs attribute) 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)

energyplus_output_directory (citylearn.end_use_load_profiles.neighborhood.Neighborhood property) EnergySimulation (class in citylearn.data) ensure_output_dir() (citylearn.exporter.EpisodeExporter method) entity_specs (citylearn.citylearn.CityLearnEnv property) (citylearn.multi_community.MultiCommunityEnv property) env (citylearn.agents.base.Agent property) (citylearn.agents.base.BaselineAgent property) (citylearn.internal.baseline.BusinessAsUsualBaselineResult attribute) env_metadata (citylearn.reward_function.MultiBuildingRewardFunction property) (citylearn.reward_function.RewardFunction property) (citylearn.reward_function.SolarPenaltyAndComfortReward property) Environment (class in citylearn.base) environment_audit() (in module citylearn.internal.deferrable_service_audit) episode (citylearn.base.EpisodeTracker property) (citylearn.citylearn.CityLearnEnv property) (citylearn.internal.baseline.BusinessAsUsualBaselineResult attribute) 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) (citylearn.multi_community.MultiCommunityEnv property) episode_tracker (citylearn.base.Environment property) (citylearn.building.Building property) (citylearn.building.OccupantInteractionBuilding property) (citylearn.citylearn.CityLearnEnv property) EpisodeExporter (class in citylearn.exporter) EpisodeTracker (class in citylearn.base) EquipmentKPIAccumulator (class in citylearn.internal.kpi_equipment) equity_metrics() (in module citylearn.internal.kpi_family_audit) equity_records() (in module citylearn.internal.kpi_community) Error Escalator (class in citylearn.energy_model) escalator_records() (in module citylearn.internal.kpi_service_metrics) escalators (citylearn.building.Building property) escalators_electricity_consumption (citylearn.building.Building property) EscalatorSimulation (class in citylearn.data) estimate_action_space() (citylearn.building.Building method) estimate_observation_space() (citylearn.building.Building method) estimate_observation_space_limits() (citylearn.building.Building method) EV_DEPARTURE_EPS (citylearn.internal.kpi.CityLearnKPIService attribute) EV_DEPARTURE_SERVICE_TOLERANCE_DEFAULT (citylearn.internal.kpi.CityLearnKPIService attribute) EV_DEPARTURE_WITHIN_TOLERANCE_DEFAULT (citylearn.internal.kpi.CityLearnKPIService attribute) ev_pool (citylearn.internal.topology.CityLearnTopologyService property) eval() (in module citylearn.end_use_load_profiles.lstm_model.model_generation) evaluate() (citylearn.citylearn.CityLearnEnv method) (citylearn.internal.kpi.CityLearnKPIService method) (citylearn.wrappers.RLlibMultiAgentEnv method) evaluate_legacy() (citylearn.internal.kpi.CityLearnKPIService method) evaluate_v2() (citylearn.citylearn.CityLearnEnv method) (citylearn.internal.kpi.CityLearnKPIService method) (citylearn.multi_community.MultiCommunityEnv method) (citylearn.wrappers.RLlibMultiAgentEnv method) EvaluationCondition (class in citylearn.citylearn) EvaluationProgress (class in citylearn.internal.evaluation_progress) event_domain (citylearn.internal.robustness.RobustnessEvent attribute) event_id (citylearn.internal.robustness.RobustnessEvent attribute) (citylearn.internal.topology.TopologyEvent attribute) event_log (citylearn.internal.topology.CityLearnTopologyService property) events (citylearn.internal.robustness.CityLearnRobustnessService property) exclude_previously_offered_cycles() (citylearn.energy_model.DeferrableAppliance method) expected_rows() (citylearn.internal.balance_audit.IndependentBalanceAudit method) expected_summary() (citylearn.internal.balance_audit.IndependentBalanceAudit method) experiment_manifest() (in module citylearn.internal.experiment) exponent (citylearn.reward_function.RewardFunction property) export_business_as_usual_timeseries() (citylearn.exporter.EpisodeExporter method) export_episode_render_data() (citylearn.exporter.EpisodeExporter method) export_final_kpis() (citylearn.citylearn.CityLearnEnv method) (citylearn.exporter.EpisodeExporter method) (citylearn.multi_community.MultiCommunityEnv method) export_kpis_on_episode_end (citylearn.citylearn.CityLearnEnv property) export_only_final_episode (citylearn.citylearn.CityLearnEnv property) EXTRA_CHARGER_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) EXTRA_EV_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) EXTRA_STORAGE_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute)

F

family_audit() (citylearn.internal.kpi.CityLearnKPIService method) FileHandler (class in citylearn.utilities) (class in citylearn.utils.file_handler) fill_building_rows() (in module citylearn.internal.entity_observations) fill_charger_rows() (in module citylearn.internal.entity_observations) fill_deferrable_rows() (in module citylearn.internal.entity_observations) fill_district_row() (in module citylearn.internal.entity_observations) fill_ev_rows() (in module citylearn.internal.entity_observations) fill_pv_rows() (in module citylearn.internal.entity_observations) fill_relation_masks() (in module citylearn.internal.entity_observations) fill_storage_rows() (in module citylearn.internal.entity_observations) finish() (citylearn.internal.balance_audit.IndependentBalanceAudit method) first() (citylearn.internal.deferrable_cycles.CycleIndex method) flat_action_space (citylearn.citylearn.CityLearnEnv property)

flat_observation_space (citylearn.citylearn.CityLearnEnv property) FlowNetwork (class in citylearn.internal.balance_audit) flush_render_buffer() (citylearn.exporter.EpisodeExporter method) force_set_soc() (citylearn.energy_model.Battery method) (citylearn.energy_model.StorageDevice method) forecast (citylearn.internal.entity_observations.ObservationContext attribute) FORECAST_BUNDLE (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) FORECAST_HORIZONS (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) forward() (citylearn.dynamics.LSTMDynamics method) (citylearn.end_use_load_profiles.lstm_model.model.LSTM method) (citylearn.rl.PolicyNetwork method) (citylearn.rl.SoftQNetwork method) from_dataframe() (citylearn.data.EscalatorSimulation class method) from_dataframes() (citylearn.data.DeferrableApplianceSimulation class method)

G

generate_gaussian_noise() (citylearn.utilities.NoiseUtils static method) (citylearn.utils.noise.Noise static method) generate_scaled_noise() (citylearn.utilities.NoiseUtils static method) (citylearn.utils.noise.Noise static method) generation_mode (citylearn.energy_model.PV property) get_battery_sizing_data() (citylearn.data.DataSet method) get_cop() (citylearn.energy_model.HeatPump method) get_current_efficiency() (citylearn.community_dataset.InventoryBattery method) (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_deferrable_service_audit() (citylearn.citylearn.CityLearnEnv method) get_dynamics_input() (citylearn.building.DynamicsBuilding method) (citylearn.building.LSTMDynamicsBuilding method) get_efficiency() (citylearn.electric_vehicle_charger.Charger 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_iso_timestamp() (citylearn.exporter.EpisodeExporter method) get_kpi_family_audit() (citylearn.citylearn.CityLearnEnv method) get_lstm_training_data() (citylearn.end_use_load_profiles.neighborhood.Neighborhood method) get_max_input_power() (citylearn.community_dataset.InventoryBattery method) (citylearn.energy_model.Battery method) get_max_output_power() (citylearn.community_dataset.InventoryBattery method) (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.community_dataset.InventoryBattery method) (citylearn.energy_model.Battery method) (citylearn.energy_model.Device method) (citylearn.energy_model.ElectricDevice method) (citylearn.energy_model.Escalator method) (citylearn.energy_model.HeatPump method) (citylearn.energy_model.PV method) (citylearn.energy_model.StorageDevice method) (citylearn.internal.demand_response.CityLearnDemandResponseService method) (citylearn.internal.provenance.CityLearnProvenanceService method) (citylearn.internal.robustness.CityLearnRobustnessService method) (citylearn.multi_community.MultiCommunityEnv 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_observations_data() (citylearn.internal.building_ops.BuildingOpsService method) get_optimal_clusters() (citylearn.end_use_load_profiles.clustering.Clustering method) get_periodic_observation_metadata() (citylearn.building.Building 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_requested_power_kw() (citylearn.electric_vehicle_charger.Charger method) get_requests_session() (citylearn.data.DataSet static method) get_required_observation_names() (citylearn.reward_function.ComfortReward method) (citylearn.reward_function.Electric_Vehicles_Reward_Function method) (citylearn.reward_function.IndependentSACReward method) (citylearn.reward_function.MARL method) (citylearn.reward_function.MultiBuildingRewardFunction method) (citylearn.reward_function.RewardFunction method) (citylearn.reward_function.SolarPenaltyAndComfortReward method) (citylearn.reward_function.SolarPenaltyReward method) get_robustness_audit() (citylearn.citylearn.CityLearnEnv 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) global_id (citylearn.internal.entity_interface.ChargerRef attribute) (citylearn.internal.entity_interface.DeferrableApplianceRef attribute) (citylearn.internal.entity_interface.PVRef attribute) (citylearn.internal.entity_interface.StorageRef attribute) GridAwareBaselineAgent (class in citylearn.agents.baseline) gross_energy_charge (citylearn.electric_vehicle_charger.Charger property) (citylearn.energy_model.StorageDevice property) gross_energy_discharge (citylearn.electric_vehicle_charger.Charger property) (citylearn.energy_model.StorageDevice property)

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) historical_chargers() (citylearn.internal.topology.CityLearnTopologyService method) historical_deferrable_appliances() (citylearn.internal.topology.CityLearnTopologyService method) historical_storages() (citylearn.internal.topology.CityLearnTopologyService method) history (citylearn.internal.robustness.CityLearnRobustnessService property) history_window() (citylearn.internal.robustness.CityLearnRobustnessService method) hour (citylearn.data.WashingMachineSimulation attribute) 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) IndependentBalanceAudit (class in citylearn.internal.balance_audit) IndependentSACReward (class in citylearn.reward_function) IndexedNoise (class in citylearn.utilities) 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) initialize() (citylearn.internal.demand_response.CityLearnDemandResponseService method) (citylearn.internal.robustness.CityLearnRobustnessService method) (citylearn.internal.topology.CityLearnTopologyService method)

initiated (citylearn.energy_model.WashingMachine property) input_changes() (in module citylearn.internal.temporal) input_size (citylearn.dynamics.LSTMDynamics property) insert() (citylearn.internal.market_history.MarketSettlementHistory method) insert_zone_metadata() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator method) interface (citylearn.citylearn.CityLearnEnv property) (citylearn.multi_community.MultiCommunityEnv property) invalidate() (citylearn.internal.entity_interface.CityLearnEntityInterfaceService method) inventory() (in module citylearn.internal.comparison) inventory_differences() (in module citylearn.internal.comparison) InventoryBattery (class in citylearn.community_dataset) InventoryBuilding (class in citylearn.community_dataset) InventoryEVBuilding (class in citylearn.community_dataset) issuer (citylearn.internal.demand_response.DemandResponseRequest attribute) ISSUER_CODES (citylearn.internal.demand_response.CityLearnDemandResponseService attribute) iter_history() (citylearn.internal.robustness.CityLearnRobustnessService method) iterations (citylearn.agents.marlisa.MARLISA property)

J

join_url() (citylearn.utilities.FileHandler static method) (citylearn.utils.file_handler.FileHandler static method)

K

kind (citylearn.internal.provenance.Stock attribute) KPI_KEYS (citylearn.internal.robustness.CityLearnRobustnessService attribute)

kpis_v2 (citylearn.internal.baseline.BusinessAsUsualBaselineResult attribute) kwargs (citylearn.internal.loading.LoadContext attribute)

L

learn() (citylearn.agents.base.Agent method) LEGACY_CHARGER_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) LEGACY_COST_FUNCTIONS (citylearn.internal.kpi.CityLearnKPIService attribute) LEGACY_EV_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) LEGACY_STORAGE_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) load() (citylearn.internal.loading.CityLearnLoadingService method) load_agent() (citylearn.citylearn.CityLearnEnv method) load_building() (citylearn.internal.loading.CityLearnLoadingService method) load_building_inputs() (in module citylearn.internal.loading_inputs) load_chargers() (in module citylearn.internal.loading_components) load_deferrable_appliance() (citylearn.internal.loading.CityLearnLoadingService method) load_electric_vehicle() (citylearn.internal.loading.CityLearnLoadingService method) load_escalator() (citylearn.internal.loading.CityLearnLoadingService method) load_kpis() (in module citylearn.internal.comparison) load_profile (citylearn.data.WashingMachineSimulation attribute)

load_washing_machine() (citylearn.internal.loading.CityLearnLoadingService method) LoadContext (class in citylearn.internal.loading) local_datasets_directories (citylearn.data.DataSet property) local_misc_directories (citylearn.data.DataSet property) 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

map_interval() (in module citylearn.internal.temporal) market_records() (in module citylearn.internal.kpi_community) market_totals() (citylearn.internal.market_history.MarketSettlementHistory method) MarketSettlementHistory (class in citylearn.internal.market_history) MARL (class in citylearn.reward_function) MARLISA (class in citylearn.agents.marlisa) MARLISARBC (class in citylearn.agents.marlisa) mask() (citylearn.internal.kpi_population.ActivePopulation method) mask_bytes (citylearn.internal.kpi_population.ActivePopulation property) 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_value (citylearn.internal.robustness.RobustnessEvent attribute) 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) member_lifecycle (citylearn.internal.topology.CityLearnTopologyService property) member_pool (citylearn.internal.topology.CityLearnTopologyService property) metadata() (in module citylearn.internal.deferrable_service_audit) (in module citylearn.internal.kpi_family_audit) (in module citylearn.internal.robustness_audit) METADATA_CLUSTER_FREQUENCY (citylearn.end_use_load_profiles.neighborhood.SampleMethod attribute) MetadataClustering (class in citylearn.end_use_load_profiles.clustering) metrics() (in module citylearn.internal.ev_departure_audit) min_charging_power (citylearn.electric_vehicle_charger.Charger property) min_discharging_power (citylearn.electric_vehicle_charger.Charger property) min_value (citylearn.internal.robustness.RobustnessEvent attribute) misc_path (citylearn.data.DataSet property) mode (citylearn.internal.robustness.RobustnessEvent attribute) module citylearn citylearn.agents citylearn.agents.base citylearn.agents.baseline citylearn.agents.marlisa citylearn.agents.q_learning citylearn.agents.rbc citylearn.agents.rlc citylearn.agents.sac citylearn.base citylearn.building citylearn.citylearn citylearn.community_dataset 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.exporter citylearn.internal citylearn.internal.balance_audit citylearn.internal.baseline citylearn.internal.building_ops citylearn.internal.capabilities citylearn.internal.comparison citylearn.internal.deferrable_cycles citylearn.internal.deferrable_service_audit citylearn.internal.demand_response citylearn.internal.electrical_limits citylearn.internal.entity_interface citylearn.internal.entity_layout citylearn.internal.entity_observations citylearn.internal.ev_departure_audit citylearn.internal.evaluation_progress citylearn.internal.experiment citylearn.internal.kpi citylearn.internal.kpi_community citylearn.internal.kpi_energy citylearn.internal.kpi_equipment citylearn.internal.kpi_family_audit citylearn.internal.kpi_population citylearn.internal.kpi_service_metrics citylearn.internal.loading citylearn.internal.loading_components citylearn.internal.loading_inputs citylearn.internal.market_history citylearn.internal.observation_contract citylearn.internal.physics_invariants citylearn.internal.provenance citylearn.internal.robustness citylearn.internal.robustness_audit citylearn.internal.robustness_history citylearn.internal.robustness_spaces citylearn.internal.robustness_targets citylearn.internal.runtime citylearn.internal.temporal citylearn.internal.topology citylearn.internal.units citylearn.multi_community citylearn.occupant citylearn.power_outage citylearn.preprocessing citylearn.reward_function citylearn.rl citylearn.utilities citylearn.utils citylearn.utils.file_handler citylearn.utils.noise citylearn.utils.paths citylearn.wrappers

module (citylearn.internal.robustness.RobustnessEvent attribute) MODULE_ALIASES (citylearn.internal.robustness.CityLearnRobustnessService attribute) multi_simulate() (citylearn.end_use_load_profiles.simulate.EndUseLoadProfilesEnergyPlusPartialLoadSimulator class method) MultiBuildingRewardFunction (class in citylearn.reward_function) MultiCommunityEnv (class in citylearn.multi_community) 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) (citylearn.energy_model.DeferrableAppliance property) (citylearn.energy_model.WashingMachine property) native_reference() (in module citylearn.internal.comparison) 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) (citylearn.energy_model.Battery method) (citylearn.energy_model.DeferrableAppliance method) (citylearn.energy_model.StorageDevice method) (citylearn.energy_model.WashingMachine method) (citylearn.internal.runtime.CityLearnRuntimeService method) node() (citylearn.internal.balance_audit.FlowNetwork method) Noise (class in citylearn.utils.noise) NoiseUtils (class in citylearn.utilities) 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) normal() (citylearn.utilities.IndexedNoise method) Normalize (class in citylearn.preprocessing) normalize_soc_series() (citylearn.data.ChargerSimulation static method) normalized_capacity_action_to_energy_kwh() (in module citylearn.internal.units) normalized_power_action_to_energy_kwh() (in module citylearn.internal.units) normalized_unserved_energy() (citylearn.cost_function.CostFunction static method) NormalizedActionWrapper (class in citylearn.wrappers) NormalizedObservationWrapper (class in citylearn.wrappers) NormalizedSpaceWrapper (class in citylearn.wrappers) NormalNoBatteryPolicy (class in citylearn.agents.baseline) NormalPolicy (class in citylearn.agents.baseline) 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_meta() (citylearn.internal.demand_response.CityLearnDemandResponseService method) (citylearn.internal.robustness.CityLearnRobustnessService method) observation_metadata (citylearn.building.Building property) observation_names (citylearn.agents.base.Agent property) (citylearn.citylearn.CityLearnEnv property) (citylearn.wrappers.NormalizedObservationWrapper property) observation_payload() (citylearn.internal.entity_interface.CityLearnEntityInterfaceService method) observation_soc_index() (citylearn.electric_vehicle.ElectricVehicle method) observation_space (citylearn.agents.base.Agent property) (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) (citylearn.internal.entity_interface.CityLearnEntityInterfaceService property) (citylearn.multi_community.MultiCommunityEnv 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) observation_values() (citylearn.internal.demand_response.CityLearnDemandResponseService method) (citylearn.internal.robustness.CityLearnRobustnessService method)

ObservationContext (class in citylearn.internal.entity_observations) observations (citylearn.citylearn.CityLearnEnv property) (citylearn.multi_community.MultiCommunityEnv property) observations() (citylearn.building.Building method) (citylearn.electric_vehicle.ElectricVehicle method) (citylearn.energy_model.DeferrableAppliance method) (citylearn.energy_model.Escalator method) (citylearn.energy_model.WashingMachine method) (citylearn.internal.building_ops.BuildingOpsService method) Occupant (class in citylearn.occupant) occupant_count (citylearn.building.Building property) OccupantInteractionBuilding (class in citylearn.building) offline (citylearn.citylearn.CityLearnEnv property) OFFLINE (citylearn.data.DataSet attribute) offline (citylearn.data.DataSet property) OfflineDataError 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) operation (citylearn.internal.topology.TopologyEvent attribute) OptimizedRBC (class in citylearn.agents.rbc) order (citylearn.internal.demand_response.DemandResponseRequest attribute) (citylearn.internal.robustness.RobustnessEvent attribute) (citylearn.internal.topology.TopologyEvent attribute) outage_options() (in module citylearn.internal.loading_components) override_render_time_step() (citylearn.exporter.EpisodeExporter method) overrides (citylearn.internal.topology.TopologyEvent attribute) owner (citylearn.internal.provenance.Stock attribute)

P

parse_actions() (citylearn.internal.entity_interface.CityLearnEntityInterfaceService method) (citylearn.internal.runtime.CityLearnRuntimeService method) parse_bool() (in module citylearn.utilities) parse_load_profile() (citylearn.data.DeferrableApplianceSimulation static method) parse_render_start_date() (citylearn.exporter.EpisodeExporter static method) past_action_values (citylearn.energy_model.DeferrableAppliance property) (citylearn.energy_model.WashingMachine property) past_charging_action_values_kwh (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) PeriodicNormalization (class in citylearn.preprocessing) phase_connection (citylearn.electric_vehicle_charger.Charger property) phase_kw (citylearn.internal.electrical_limits.ElectricalServiceAllocation attribute) plan_final_episode_exports() (citylearn.citylearn.CityLearnEnv method) plug_car() (citylearn.electric_vehicle_charger.Charger method) plus() (in module citylearn.internal.balance_audit) PolicyNetwork (class in citylearn.rl) pool_thermal() (in module citylearn.internal.kpi_family_audit) population_scope() (in module citylearn.internal.kpi_population) PORTFOLIO_COMMUNITY_ID (citylearn.multi_community.MultiCommunityEnv attribute) PORTFOLIO_NAME (citylearn.multi_community.MultiCommunityEnv attribute) power_efficiency_curve (citylearn.energy_model.Battery property) power_kw_to_energy_kwh() (in module citylearn.internal.units) power_outage (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) power_outage_signal (citylearn.building.Building property) PowerOutage (class in citylearn.power_outage) PowerRequest (class in citylearn.internal.electrical_limits) predict() (citylearn.agents.base.Agent method) (citylearn.agents.base.BaselineAgent method) (citylearn.agents.baseline.ZeroActionBaselineAgent 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) prerequisites() (in module citylearn.internal.ev_departure_audit) preview_start_energy_kwh() (citylearn.energy_model.DeferrableAppliance method) preview_start_profile_kwh() (citylearn.energy_model.DeferrableAppliance method) prices() (citylearn.internal.balance_audit.IndependentBalanceAudit method) pricing (citylearn.building.Building property) (citylearn.internal.loading_inputs.BuildingInputs attribute) Pricing (class in citylearn.data) probabilities (citylearn.occupant.LogisticRegressionOccupant property) process_metadata() (citylearn.citylearn.CityLearnEnv method) (citylearn.internal.loading.CityLearnLoadingService method) PROFILE_REQUIRED_COLUMNS (citylearn.data.DeferrableApplianceSimulation attribute) purpose (citylearn.internal.demand_response.DemandResponseRequest attribute) 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) pv_curtailment (citylearn.building.Building property) PV_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) pv_id (citylearn.internal.entity_interface.PVRef attribute) PVRef (class in citylearn.internal.entity_interface)

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) 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) ratio() (in module citylearn.internal.kpi_family_audit) rbc (citylearn.agents.sac.SACRBC property) RBC (class in citylearn.agents.rbc) RBCBasicPolicy (class in citylearn.agents.baseline) RBCCommunityPolicy (class in citylearn.agents.baseline) RBCSmartPolicy (class in citylearn.agents.baseline) read_json() (citylearn.utilities.FileHandler static method) (citylearn.utils.file_handler.FileHandler static method) read_pickle() (citylearn.utilities.FileHandler static method) (citylearn.utils.file_handler.FileHandler static method) read_yaml() (citylearn.utilities.FileHandler static method) (citylearn.utils.file_handler.FileHandler static method) record() (citylearn.internal.balance_audit.IndependentBalanceAudit method) (citylearn.internal.deferrable_service_audit.ServiceLedger method) record_departure() (in module citylearn.internal.ev_departure_audit) record_service_interval() (citylearn.energy_model.DeferrableAppliance method) records() (citylearn.internal.deferrable_service_audit.ServiceLedger method) 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) render() (citylearn.citylearn.CityLearnEnv method) (citylearn.exporter.EpisodeExporter method) (citylearn.multi_community.MultiCommunityEnv method) render_enabled (citylearn.citylearn.CityLearnEnv property) render_simulation_end_data() (citylearn.building.Building method) (citylearn.electric_vehicle.ElectricVehicle method) (citylearn.electric_vehicle_charger.Charger method) (citylearn.energy_model.WashingMachine method) render_start_date (citylearn.citylearn.CityLearnEnv property) replacement_value (citylearn.internal.robustness.RobustnessEvent attribute) 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) request_id (citylearn.internal.demand_response.DemandResponseRequest attribute) request_phase_kw (citylearn.internal.electrical_limits.PowerRequest attribute) request_total_kw (citylearn.internal.electrical_limits.PowerRequest attribute) requested_state (citylearn.energy_model.Escalator property) requested_violation_kw (citylearn.internal.electrical_limits.ElectricalServiceAllocation attribute) requests (citylearn.internal.demand_response.CityLearnDemandResponseService property) REQUIRED_COLUMNS (citylearn.data.EscalatorSimulation attribute) resample_series() (in module citylearn.internal.temporal) rescale_step_loss() (in module citylearn.internal.temporal) reset() (citylearn.agents.base.Agent method) (citylearn.agents.baseline.RBCBasicPolicy 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.DeferrableAppliance method) (citylearn.energy_model.ElectricDevice method) (citylearn.energy_model.Escalator method) (citylearn.energy_model.StorageDevice method) (citylearn.energy_model.WashingMachine method) (citylearn.internal.demand_response.CityLearnDemandResponseService method) (citylearn.internal.entity_interface.CityLearnEntityInterfaceService method) (citylearn.internal.provenance.CityLearnProvenanceService method) (citylearn.internal.robustness.CityLearnRobustnessService method) (citylearn.internal.topology.CityLearnTopologyService method) (citylearn.multi_community.MultiCommunityEnv method) (citylearn.occupant.LogisticRegressionOccupant method) (citylearn.reward_function.MultiBuildingRewardFunction method) (citylearn.reward_function.RewardFunction method) (citylearn.wrappers.RLlibMultiAgentEnv method)

reset_buffers() (in module citylearn.internal.entity_observations) 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) reset_time_tracking() (citylearn.exporter.EpisodeExporter method) residual_violation_kw (citylearn.internal.electrical_limits.ElectricalServiceAllocation attribute) resolve_schema_root() (citylearn.utilities.FileHandler static method) (citylearn.utils.file_handler.FileHandler static method) restore_render_time_step() (citylearn.exporter.EpisodeExporter static method) reward() (citylearn.wrappers.RLlibMultiAgentRewardWrapper method) (citylearn.wrappers.StableBaselines3RewardWrapper method) reward_function (citylearn.citylearn.CityLearnEnv property) reward_metadata() (in module citylearn.internal.kpi_family_audit) reward_scaling (citylearn.agents.rlc.RLC property) RewardFunction (class in citylearn.reward_function) rewards (citylearn.citylearn.CityLearnEnv property) (citylearn.multi_community.MultiCommunityEnv 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) robustness (citylearn.internal.entity_observations.ObservationContext attribute) ROBUSTNESS_BUNDLE (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) ROBUSTNESS_DISTRICT_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) RobustnessEvent (class in citylearn.internal.robustness) RobustnessHistory (class in citylearn.internal.robustness_history) rolling_episode_split (citylearn.citylearn.CityLearnEnv property) root_directory (citylearn.citylearn.CityLearnEnv property) round_trip_efficiency (citylearn.energy_model.StorageDevice property) row (citylearn.internal.entity_interface.ChargerRef attribute) (citylearn.internal.entity_interface.DeferrableApplianceRef attribute) (citylearn.internal.entity_interface.PVRef attribute) (citylearn.internal.entity_interface.StorageRef attribute) run() (citylearn.internal.baseline.CityLearnBusinessAsUsualBaselineService method) (in module citylearn.end_use_load_profiles.lstm_model.model_generation) (in module citylearn.internal.evaluation_progress) run_business_as_usual_baseline() (citylearn.citylearn.CityLearnEnv method) run_one_model() (in module citylearn.end_use_load_profiles.lstm_model.model_generation_wrapper) running() (citylearn.internal.deferrable_cycles.CycleIndex method) runtime_status() (citylearn.internal.robustness.CityLearnRobustnessService method) runtime_versions() (in module citylearn.internal.temporal) RuntimeEVBuilding (class in citylearn.community_dataset)

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) sanitize_tables() (in module citylearn.internal.entity_observations) save_to_csv() (citylearn.exporter.EpisodeExporter method) scaled() (in module citylearn.internal.provenance) scales (citylearn.internal.electrical_limits.ElectricalServiceAllocation attribute) SCHEDULE_REQUIRED_COLUMNS (citylearn.data.DeferrableApplianceSimulation attribute) schema (citylearn.citylearn.CityLearnEnv property) (citylearn.internal.loading.LoadContext attribute) schema_filepath (citylearn.end_use_load_profiles.neighborhood.NeighborhoodBuild property) SCORECARD_DEFAULT_KPIS (citylearn.internal.kpi.CityLearnKPIService attribute) seconds_per_time_step (citylearn.base.Environment property) (citylearn.multi_community.MultiCommunityEnv property) seconds_to_hours() (in module citylearn.internal.units) SENTINEL_TIME_STEP (citylearn.energy_model.DeferrableAppliance attribute) service_audit() (citylearn.energy_model.DeferrableAppliance method) service_summary() (citylearn.energy_model.DeferrableAppliance method) (citylearn.energy_model.Escalator method) ServiceLedger (class in citylearn.internal.deferrable_service_audit) ServiceOnlyBaselineAgent (class in citylearn.agents.baseline) 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_electricity_consumption() (citylearn.energy_model.ElectricDevice 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_experiment_identity() (citylearn.citylearn.CityLearnEnv method) set_linear() (citylearn.dynamics.LSTMDynamics method) set_lstm() (citylearn.dynamics.LSTMDynamics method) set_net_electricity_consumption_cost() (citylearn.building.Building method) set_networks() (citylearn.agents.marlisa.MARLISA method) (citylearn.agents.sac.SAC method) set_next_episode_index() (citylearn.base.EpisodeTracker 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) set_state() (citylearn.energy_model.Escalator method) setpoint_decrease_model_filepath (citylearn.occupant.LogisticRegressionOccupant property) setpoint_increase_model_filepath (citylearn.occupant.LogisticRegressionOccupant property) settle() (citylearn.internal.provenance.CityLearnProvenanceService method) settle_current_time_step() (citylearn.internal.demand_response.CityLearnDemandResponseService method) settlement_history (citylearn.internal.demand_response.CityLearnDemandResponseService property) settlement_prices() (in module citylearn.community_dataset) sha256() (in module citylearn.internal.temporal) shared_observations (citylearn.citylearn.CityLearnEnv property) (citylearn.wrappers.NormalizedObservationWrapper property) shortfall_penalty_eur_per_kwh (citylearn.internal.demand_response.DemandResponseRequest attribute) signature() (in module citylearn.internal.temporal) 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) simulate_unconnected_ev_soc() (citylearn.citylearn.CityLearnEnv method) (citylearn.internal.runtime.CityLearnRuntimeService method) 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) sink() (citylearn.internal.balance_audit.FlowNetwork method) (citylearn.internal.provenance.CityLearnProvenanceService method) skip_cycles_before() (citylearn.energy_model.DeferrableAppliance method) sliding_windows() (in module citylearn.end_use_load_profiles.lstm_model.preprocessing) snapshot_inputs() (in module citylearn.internal.temporal) snapshot_payload() (in module citylearn.internal.entity_observations) soc (citylearn.energy_model.StorageDevice property) SOC_EPS (citylearn.internal.physics_invariants.CityLearnPhysicsInvariantService attribute) 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) solve() (citylearn.internal.balance_audit.FlowNetwork method) source() (citylearn.internal.provenance.CityLearnProvenanceService method) source_asset_id (citylearn.internal.topology.TopologyEvent attribute) source_destinations() (citylearn.internal.provenance.CityLearnProvenanceService method) source_member_id (citylearn.internal.topology.TopologyEvent attribute) span() (citylearn.internal.evaluation_progress.EvaluationProgress method) (in module citylearn.internal.evaluation_progress) specs (citylearn.internal.entity_interface.CityLearnEntityInterfaceService property) 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() (citylearn.internal.deferrable_service_audit.ServiceLedger method) start_cycle() (citylearn.energy_model.DeferrableAppliance method) (citylearn.energy_model.WashingMachine method) start_regression_time_step (citylearn.agents.marlisa.MARLISA property) start_time_step (citylearn.data.WashingMachineSimulation attribute) (citylearn.internal.demand_response.DemandResponseRequest attribute) (citylearn.internal.robustness.RobustnessEvent attribute) start_time_steps (citylearn.power_outage.ReliabilityMetricsPowerOutage property) state (citylearn.energy_model.Escalator property) state_name (citylearn.energy_model.Escalator property) STATE_NAMES (citylearn.energy_model.Escalator attribute) STATE_NORMAL (citylearn.energy_model.Escalator attribute) STATE_SLOW (citylearn.energy_model.Escalator attribute) STATE_STANDBY (citylearn.energy_model.Escalator attribute) std (citylearn.internal.robustness.RobustnessEvent attribute) step (citylearn.internal.provenance.Stock attribute) step() (citylearn.citylearn.CityLearnEnv method) (citylearn.internal.runtime.CityLearnRuntimeService method) (citylearn.multi_community.MultiCommunityEnv method) (citylearn.wrappers.RLlibMultiAgentEnv method) step_hours (citylearn.internal.entity_observations.ObservationContext attribute) step_many() (citylearn.citylearn.CityLearnEnv method) (citylearn.internal.runtime.CityLearnRuntimeService method) step_without_feedback() (citylearn.internal.runtime.CityLearnRuntimeService method) stochastic_power_outage (citylearn.building.Building property) stochastic_power_outage_model (citylearn.building.Building property) Stock (class in citylearn.internal.provenance) storage_id (citylearn.internal.entity_interface.StorageRef attribute) StorageDevice (class in citylearn.energy_model) StorageRef (class in citylearn.internal.entity_interface) StorageTank (class in citylearn.energy_model) stored_energy_transfer (citylearn.energy_model.StorageDevice property) sum_of_squares_error_minimum_percent_change (citylearn.end_use_load_profiles.clustering.Clustering property) summarize() (citylearn.internal.demand_response.CityLearnDemandResponseService method) (citylearn.internal.robustness.CityLearnRobustnessService method) (in module citylearn.internal.deferrable_service_audit) summary() (citylearn.internal.provenance.CityLearnProvenanceService method) (citylearn.internal.robustness_history.RobustnessHistory method) (in module citylearn.internal.robustness_audit) synchronize() (citylearn.internal.provenance.CityLearnProvenanceService method)

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_asset_id (citylearn.internal.topology.TopologyEvent attribute) target_asset_type (citylearn.internal.topology.TopologyEvent attribute) target_cooling_temperature (citylearn.energy_model.HeatPump property) target_feature (citylearn.internal.robustness.RobustnessEvent attribute) target_heating_temperature (citylearn.energy_model.HeatPump property) target_id (citylearn.internal.robustness.RobustnessEvent attribute) target_member_id (citylearn.internal.topology.TopologyEvent attribute) target_power_kw (citylearn.internal.demand_response.DemandResponseRequest attribute) target_type (citylearn.internal.robustness.RobustnessEvent attribute) tau (citylearn.agents.rlc.RLC property) TELEMETRY_FEATURES (citylearn.internal.robustness.CityLearnRobustnessService attribute) temporal (citylearn.internal.entity_observations.ObservationContext attribute) TEMPORAL_BUILDING_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) TEMPORAL_BUNDLE (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) TEMPORAL_DISTRICT_FEATURES (citylearn.internal.entity_interface.CityLearnEntityInterfaceService attribute) terminate() (citylearn.dynamics.LSTMDynamics method) terminated (citylearn.citylearn.CityLearnEnv property) (citylearn.multi_community.MultiCommunityEnv 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) thermal_counts() (in module citylearn.internal.kpi_family_audit) thermal_metrics() (in module citylearn.internal.kpi_family_audit) time_step (citylearn.base.Environment property) (citylearn.internal.baseline.BusinessAsUsualBaselineResult attribute) (citylearn.internal.entity_observations.ObservationContext attribute) (citylearn.internal.topology.TopologyEvent attribute) (citylearn.multi_community.MultiCommunityEnv property) (citylearn.wrappers.RLlibMultiAgentEnv property)

time_step_ratio (citylearn.base.Environment property) (citylearn.building.Building property) (citylearn.citylearn.CityLearnEnv property) (citylearn.electric_vehicle_charger.Charger property) (citylearn.energy_model.Battery property) (citylearn.energy_model.StorageDevice property) (citylearn.internal.loading_inputs.BuildingInputs attribute) time_step_ratios (citylearn.data.EnergySimulation property) time_steps (citylearn.citylearn.CityLearnEnv property) (citylearn.multi_community.MultiCommunityEnv property) TimeAxis (class in citylearn.internal.temporal) TimeSeriesData (class in citylearn.data) to() (citylearn.rl.PolicyNetwork method) to_dataset_resolution_energy() (in module citylearn.internal.units) tolerance_power_kw (citylearn.internal.demand_response.DemandResponseRequest attribute) topology_event_log (citylearn.citylearn.CityLearnEnv property) topology_member_lifecycle (citylearn.citylearn.CityLearnEnv property) topology_mode (citylearn.citylearn.CityLearnEnv property) topology_version (citylearn.citylearn.CityLearnEnv property) (citylearn.internal.topology.CityLearnTopologyService property) topology_version_at() (citylearn.internal.topology.CityLearnTopologyService method) TopologyEvent (class in citylearn.internal.topology) total() (in module citylearn.internal.balance_audit) total_kw (citylearn.internal.electrical_limits.ElectricalServiceAllocation attribute) total_self_consumption (citylearn.citylearn.CityLearnEnv property) 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) (citylearn.multi_community.MultiCommunityEnv property)

U

uid (citylearn.base.Environment property) UnknownSchemaError unsupported_reason() (in module citylearn.internal.capabilities) unwrapped (citylearn.multi_community.MultiCommunityEnv property) 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_deferrable_appliance_observations() (citylearn.building.Building method) (citylearn.internal.building_ops.BuildingOpsService 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_escalator_observations() (citylearn.building.Building method) (citylearn.internal.building_ops.BuildingOpsService method) update_ev_charger_observations() (citylearn.building.Building method) (citylearn.internal.building_ops.BuildingOpsService 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) (citylearn.internal.runtime.CityLearnRuntimeService method) update_washing_machine_observations() (citylearn.building.Building method) (citylearn.internal.building_ops.BuildingOpsService method)

V

VALID_EVENT_DOMAINS (citylearn.internal.robustness.CityLearnRobustnessService attribute) VALID_MODES (citylearn.internal.robustness.CityLearnRobustnessService attribute) VALID_TARGET_TYPES (citylearn.internal.robustness.CityLearnRobustnessService attribute)

validate() (in module citylearn.internal.observation_contract) validate_targets() (citylearn.internal.robustness.CityLearnRobustnessService method) value (citylearn.internal.robustness.RobustnessEvent attribute)

W

washing_machine_simulation (citylearn.energy_model.WashingMachine property) washing_machines (citylearn.building.Building property) washing_machines_electricity_consumption (citylearn.building.Building property) WashingMachine (class in citylearn.energy_model) WashingMachineSimulation (class in citylearn.data) weather (citylearn.building.Building property) (citylearn.internal.loading_inputs.BuildingInputs attribute) Weather (class in citylearn.data) weighted_imports() (in module citylearn.internal.balance_audit) weights (citylearn.multi_community.MultiCommunityEnv 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) writable_record() (citylearn.internal.robustness_history.RobustnessHistory method) write_json() (citylearn.utilities.FileHandler static method) (citylearn.utils.file_handler.FileHandler static method) write_pickle() (citylearn.utilities.FileHandler static method) (citylearn.utils.file_handler.FileHandler static method) write_render_rows() (citylearn.exporter.EpisodeExporter method) write_yaml() (citylearn.utilities.FileHandler static method) (citylearn.utils.file_handler.FileHandler static method)

Z

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

ZeroActionBaselineAgent (class in citylearn.agents.baseline)