citylearn package
Subpackages
Submodules
- citylearn.base module
EnvironmentEnvironment.DEFAULT_RANDOM_SEED_RANGEEnvironment.DEFAULT_SECONDS_PER_TIME_STEPEnvironment.episode_trackerEnvironment.get_metadata()Environment.next_time_step()Environment.numpy_random_stateEnvironment.random_seedEnvironment.reset()Environment.reset_time_step()Environment.seconds_per_time_stepEnvironment.time_stepEnvironment.uid
EpisodeTrackerEpisodeTracker.episodeEpisodeTracker.episode_end_time_stepEpisodeTracker.episode_start_time_stepEpisodeTracker.episode_time_stepsEpisodeTracker.next_episode()EpisodeTracker.reset_episode_index()EpisodeTracker.simulation_end_time_stepEpisodeTracker.simulation_start_time_stepEpisodeTracker.simulation_time_steps
- citylearn.building module
BuildingBuilding.action_metadataBuilding.action_spaceBuilding.active_actionsBuilding.active_observationsBuilding.apply_actions()Building.autosize_cooling_device()Building.autosize_cooling_storage()Building.autosize_dhw_device()Building.autosize_dhw_storage()Building.autosize_electrical_storage()Building.autosize_heating_device()Building.autosize_heating_storage()Building.autosize_pv()Building.carbon_intensityBuilding.comfort_bandBuilding.cooling_demandBuilding.cooling_deviceBuilding.cooling_device_copBuilding.cooling_electricity_consumptionBuilding.cooling_storageBuilding.cooling_storage_electricity_consumptionBuilding.demand_observation_limit_factorBuilding.dhw_demandBuilding.dhw_deviceBuilding.dhw_device_copBuilding.dhw_electricity_consumptionBuilding.dhw_storageBuilding.dhw_storage_electricity_consumptionBuilding.downward_electrical_flexibilityBuilding.electric_vehicle_chargersBuilding.electrical_storageBuilding.electrical_storage_electricity_consumptionBuilding.energy_from_cooling_deviceBuilding.energy_from_cooling_device_to_cooling_storageBuilding.energy_from_cooling_storageBuilding.energy_from_dhw_deviceBuilding.energy_from_dhw_device_to_dhw_storageBuilding.energy_from_dhw_storageBuilding.energy_from_electrical_storageBuilding.energy_from_heating_deviceBuilding.energy_from_heating_device_to_heating_storageBuilding.energy_from_heating_storageBuilding.energy_simulationBuilding.energy_to_electrical_storageBuilding.energy_to_non_shiftable_loadBuilding.episode_trackerBuilding.estimate_action_space()Building.estimate_observation_space()Building.estimate_observation_space_limits()Building.get_metadata()Building.get_periodic_observation_metadata()Building.heating_demandBuilding.heating_deviceBuilding.heating_device_copBuilding.heating_electricity_consumptionBuilding.heating_storageBuilding.heating_storage_electricity_consumptionBuilding.indoor_dry_bulb_temperatureBuilding.indoor_dry_bulb_temperature_cooling_set_pointBuilding.indoor_dry_bulb_temperature_heating_set_pointBuilding.maximum_temperature_deltaBuilding.nameBuilding.net_electricity_consumptionBuilding.net_electricity_consumption_costBuilding.net_electricity_consumption_cost_without_storageBuilding.net_electricity_consumption_cost_without_storage_and_pvBuilding.net_electricity_consumption_emissionBuilding.net_electricity_consumption_emission_without_storageBuilding.net_electricity_consumption_emission_without_storage_and_pvBuilding.net_electricity_consumption_without_storageBuilding.net_electricity_consumption_without_storage_and_pvBuilding.next_time_step()Building.non_shiftable_loadBuilding.non_shiftable_load_deviceBuilding.non_shiftable_load_electricity_consumptionBuilding.observation_metadataBuilding.observation_spaceBuilding.observation_space_limit_deltaBuilding.observations()Building.occupant_countBuilding.power_outageBuilding.power_outage_signalBuilding.pricingBuilding.pvBuilding.random_seedBuilding.reset()Building.reset_data_sets()Building.reset_dynamic_variables()Building.reset_power_outage_signal()Building.simulate_power_outageBuilding.solar_generationBuilding.stochastic_power_outageBuilding.stochastic_power_outage_modelBuilding.update_cooling_demand()Building.update_cooling_storage()Building.update_dhw_storage()Building.update_electrical_storage()Building.update_energy_from_cooling_device()Building.update_energy_from_dhw_device()Building.update_energy_from_heating_device()Building.update_heating_demand()Building.update_heating_storage()Building.update_non_shiftable_load()Building.update_variables()Building.weather
DynamicsBuildingDynamicsBuilding.apply_actions()DynamicsBuilding.cooling_demand_without_partial_loadDynamicsBuilding.get_dynamics_input()DynamicsBuilding.heating_demand_without_partial_loadDynamicsBuilding.indoor_dry_bulb_temperature_without_partial_loadDynamicsBuilding.net_electricity_consumption_cost_without_storage_and_partial_loadDynamicsBuilding.net_electricity_consumption_cost_without_storage_and_partial_load_and_pvDynamicsBuilding.net_electricity_consumption_emission_without_storage_and_partial_loadDynamicsBuilding.net_electricity_consumption_emission_without_storage_and_partial_load_and_pvDynamicsBuilding.net_electricity_consumption_without_storage_and_partial_loadDynamicsBuilding.net_electricity_consumption_without_storage_and_partial_load_and_pvDynamicsBuilding.reset()DynamicsBuilding.reset_dynamic_variables()DynamicsBuilding.simulate_dynamicsDynamicsBuilding.update_indoor_dry_bulb_temperature()
LSTMDynamicsBuildingLogisticRegressionOccupantInteractionBuildingLogisticRegressionOccupantInteractionBuilding.reset()LogisticRegressionOccupantInteractionBuilding.reset_data_sets()LogisticRegressionOccupantInteractionBuilding.reset_dynamic_variables()LogisticRegressionOccupantInteractionBuilding.set_point_hold_time_stepsLogisticRegressionOccupantInteractionBuilding.update_set_points()
OccupantInteractionBuildingOccupantInteractionBuilding.apply_actions()OccupantInteractionBuilding.episode_trackerOccupantInteractionBuilding.next_time_step()OccupantInteractionBuilding.random_seedOccupantInteractionBuilding.reset()OccupantInteractionBuilding.reset_dynamic_variables()OccupantInteractionBuilding.update_set_points()
- citylearn.citylearn module
CityLearnEnvCityLearnEnv.action_namesCityLearnEnv.action_spaceCityLearnEnv.associate_electric_vehicles_to_chargers()CityLearnEnv.buildingsCityLearnEnv.central_agentCityLearnEnv.cooling_demandCityLearnEnv.cooling_electricity_consumptionCityLearnEnv.cooling_storage_electricity_consumptionCityLearnEnv.dhw_demandCityLearnEnv.dhw_electricity_consumptionCityLearnEnv.dhw_storage_electricity_consumptionCityLearnEnv.electric_vehiclesCityLearnEnv.electrical_storage_electricity_consumptionCityLearnEnv.energy_from_cooling_deviceCityLearnEnv.energy_from_cooling_device_to_cooling_storageCityLearnEnv.energy_from_cooling_storageCityLearnEnv.energy_from_dhw_deviceCityLearnEnv.energy_from_dhw_device_to_dhw_storageCityLearnEnv.energy_from_dhw_storageCityLearnEnv.energy_from_electrical_storageCityLearnEnv.energy_from_heating_deviceCityLearnEnv.energy_from_heating_device_to_heating_storageCityLearnEnv.energy_from_heating_storageCityLearnEnv.energy_to_electrical_storageCityLearnEnv.energy_to_non_shiftable_loadCityLearnEnv.episodeCityLearnEnv.episode_rewardsCityLearnEnv.episode_time_stepsCityLearnEnv.episode_trackerCityLearnEnv.evaluate()CityLearnEnv.evaluate_citylearn_challenge()CityLearnEnv.get_default_shared_observations()CityLearnEnv.get_info()CityLearnEnv.get_metadata()CityLearnEnv.heating_demandCityLearnEnv.heating_electricity_consumptionCityLearnEnv.heating_storage_electricity_consumptionCityLearnEnv.load_agent()CityLearnEnv.net_electricity_consumptionCityLearnEnv.net_electricity_consumption_costCityLearnEnv.net_electricity_consumption_cost_without_storageCityLearnEnv.net_electricity_consumption_cost_without_storage_and_partial_loadCityLearnEnv.net_electricity_consumption_cost_without_storage_and_partial_load_and_pvCityLearnEnv.net_electricity_consumption_cost_without_storage_and_pvCityLearnEnv.net_electricity_consumption_emissionCityLearnEnv.net_electricity_consumption_emission_without_storageCityLearnEnv.net_electricity_consumption_emission_without_storage_and_partial_loadCityLearnEnv.net_electricity_consumption_emission_without_storage_and_partial_load_and_pvCityLearnEnv.net_electricity_consumption_emission_without_storage_and_pvCityLearnEnv.net_electricity_consumption_without_storageCityLearnEnv.net_electricity_consumption_without_storage_and_partial_loadCityLearnEnv.net_electricity_consumption_without_storage_and_partial_load_and_pvCityLearnEnv.net_electricity_consumption_without_storage_and_pvCityLearnEnv.next_time_step()CityLearnEnv.non_shiftable_loadCityLearnEnv.observation_namesCityLearnEnv.observation_spaceCityLearnEnv.observationsCityLearnEnv.power_outageCityLearnEnv.random_episode_splitCityLearnEnv.random_seedCityLearnEnv.reset()CityLearnEnv.reward_functionCityLearnEnv.rewardsCityLearnEnv.rolling_episode_splitCityLearnEnv.root_directoryCityLearnEnv.schemaCityLearnEnv.shared_observationsCityLearnEnv.solar_generationCityLearnEnv.step()CityLearnEnv.terminatedCityLearnEnv.time_stepsCityLearnEnv.truncatedCityLearnEnv.update_variables()
ErrorEvaluationConditionEvaluationCondition.WITHOUT_STORAGE_AND_PARTIAL_LOAD_AND_PVEvaluationCondition.WITHOUT_STORAGE_AND_PARTIAL_LOAD_BUT_WITH_PVEvaluationCondition.WITHOUT_STORAGE_AND_PVEvaluationCondition.WITHOUT_STORAGE_BUT_WITH_PARTIAL_LOAD_AND_PVEvaluationCondition.WITHOUT_STORAGE_BUT_WITH_PVEvaluationCondition.WITH_STORAGE_AND_PARTIAL_LOAD_AND_PVEvaluationCondition.WITH_STORAGE_AND_PV
UnknownSchemaError
- citylearn.cost_function module
CostFunctionCostFunction.carbon_emissions()CostFunction.cost()CostFunction.discomfort()CostFunction.electricity_consumption()CostFunction.normalized_unserved_energy()CostFunction.one_minus_load_factor()CostFunction.one_minus_thermal_resilience()CostFunction.peak()CostFunction.quadratic()CostFunction.ramping()CostFunction.zero_net_energy()
- citylearn.data module
CarbonIntensityDataSetDataSet.BATTERY_CHOICES_FILENAMEDataSet.DEFAULT_CACHE_DIRECTORYDataSet.GITHUB_ACCOUNTDataSet.GITHUB_API_CONTENT_URLDataSet.PV_CHOICES_FILENAMEDataSet.REPOSITORY_DATA_DATASETS_PATHDataSet.REPOSITORY_DATA_MISC_PATHDataSet.REPOSITORY_DATA_PATHDataSet.REPOSITORY_NAMEDataSet.REPOSITORY_TAGDataSet.cache_directoryDataSet.clear_cache()DataSet.datasets_pathDataSet.get_battery_sizing_data()DataSet.get_dataset()DataSet.get_dataset_names()DataSet.get_github_contents()DataSet.get_pv_sizing_data()DataSet.get_requests_session()DataSet.get_schema()DataSet.github_accountDataSet.logging_levelDataSet.misc_pathDataSet.repositoryDataSet.tag
ElectricVehicleSimulationElectricVehicleSimulation.electric_vehicle_charger_stateElectricVehicleSimulation.chargerElectricVehicleSimulation.electric_vehicle_departure_timeElectricVehicleSimulation.electric_vehicle_required_soc_departureElectricVehicleSimulation.electric_vehicle_estimated_arrival_timeElectricVehicleSimulation.electric_vehicle_estimated_soc_arrival
EnergySimulationLogisticRegressionOccupantParametersPricingTimeSeriesDataWeatherget_settings()
- citylearn.dynamics module
- citylearn.electric_vehicle module
ElectricVehicleElectricVehicle.action_metadataElectricVehicle.action_spaceElectricVehicle.active_actionsElectricVehicle.active_observationsElectricVehicle.adjust_electric_vehicle_soc_on_system_connection()ElectricVehicle.autosize_battery()ElectricVehicle.batteryElectricVehicle.electric_vehicle_simulationElectricVehicle.estimate_action_space()ElectricVehicle.estimate_observation_space()ElectricVehicle.estimate_observation_space_limits()ElectricVehicle.get_periodic_observation_metadata()ElectricVehicle.min_battery_socElectricVehicle.nameElectricVehicle.next_time_step()ElectricVehicle.observation_metadataElectricVehicle.observation_spaceElectricVehicle.observations()ElectricVehicle.observations_length()ElectricVehicle.reset()
- citylearn.electric_vehicle_charger module
ChargerCharger.associate_incoming_car()Charger.available_nominal_powerCharger.charge_efficiency_curveCharger.charger_idCharger.charger_typeCharger.connected_electric_vehicleCharger.disassociate_incoming_car()Charger.discharge_efficiency_curveCharger.efficiencyCharger.electricity_consumptionCharger.incoming_electric_vehicleCharger.max_charging_powerCharger.max_discharging_powerCharger.min_charging_powerCharger.min_discharging_powerCharger.next_time_step()Charger.nominal_powerCharger.past_charging_action_valuesCharger.past_connected_evsCharger.plug_car()Charger.reset()Charger.unplug_car()Charger.update_connected_electric_vehicle_soc()
- citylearn.energy_model module
BatteryBattery.autosize()Battery.capacityBattery.capacity_historyBattery.capacity_loss_coefficientBattery.capacity_power_curveBattery.charge()Battery.degrade()Battery.degraded_capacityBattery.depth_of_dischargeBattery.efficiencyBattery.efficiency_historyBattery.get_current_efficiency()Battery.get_max_input_power()Battery.get_max_output_power()Battery.get_metadata()Battery.initial_socBattery.power_efficiency_curveBattery.reset()Battery.set_ad_hoc_charge()
DeviceElectricDeviceElectricHeaterHeatPumpPVStorageDeviceStorageDevice.autosize()StorageDevice.capacityStorageDevice.charge()StorageDevice.efficiencyStorageDevice.energy_balanceStorageDevice.energy_initStorageDevice.get_metadata()StorageDevice.initial_socStorageDevice.loss_coefficientStorageDevice.reset()StorageDevice.round_trip_efficiencyStorageDevice.set_energy_balance()StorageDevice.soc
StorageTank
- citylearn.occupant module
- citylearn.power_outage module
- citylearn.preprocessing module
- citylearn.reward_function module
ComfortRewardIndependentSACRewardMARLRewardFunctionSolarPenaltyAndComfortRewardSolarPenaltyRewardV2GPenaltyRewardV2GPenaltyReward.calculate()V2GPenaltyReward.calculate_ev_penalty()V2GPenaltyReward.community_weightV2GPenaltyReward.energy_transfer_bonusV2GPenaltyReward.peak_penalty_weightV2GPenaltyReward.peak_percentage_thresholdV2GPenaltyReward.penalty_battery_limitsV2GPenaltyReward.penalty_no_car_chargingV2GPenaltyReward.penalty_soc_under_5_10V2GPenaltyReward.ramping_penalty_weightV2GPenaltyReward.ramping_percentage_thresholdV2GPenaltyReward.reward_close_socV2GPenaltyReward.reward_extra_self_productionV2GPenaltyReward.reward_self_ev_consumptionV2GPenaltyReward.window_size
- citylearn.rl module
- citylearn.utilities module
- citylearn.wrappers module
ClippedObservationWrapperDiscreteActionWrapperDiscreteObservationWrapperDiscreteSpaceWrapperNormalizedActionWrapperNormalizedObservationWrapperNormalizedSpaceWrapperRLlibMultiAgentActionWrapperRLlibMultiAgentEnvRLlibMultiAgentObservationWrapperRLlibMultiAgentRewardWrapperRLlibSingleAgentWrapperStableBaselines3ActionWrapperStableBaselines3ObservationWrapperStableBaselines3RewardWrapperStableBaselines3WrapperTabularQLearningActionWrapperTabularQLearningObservationWrapperTabularQLearningWrapper