citylearn.internal package
Internal service modules for CityLearn runtime composition.
Submodules
- citylearn.internal.baseline module
- citylearn.internal.building_ops module
BuildingOpsServiceBuildingOpsService.apply_actions()BuildingOpsService.apply_charging_constraints_to_actions()BuildingOpsService.deferrable_appliance_observations()BuildingOpsService.get_observations_data()BuildingOpsService.observations()BuildingOpsService.update_deferrable_appliance_observations()BuildingOpsService.update_escalator_observations()BuildingOpsService.update_ev_charger_observations()BuildingOpsService.update_washing_machine_observations()
- citylearn.internal.demand_response module
CityLearnDemandResponseServiceCityLearnDemandResponseService.DEFAULT_BASELINE_METHODCityLearnDemandResponseService.DEFAULT_BASELINE_WINDOW_SECONDSCityLearnDemandResponseService.DIRECTION_CODESCityLearnDemandResponseService.ISSUER_CODESCityLearnDemandResponseService.get_metadata()CityLearnDemandResponseService.initialize()CityLearnDemandResponseService.observation_meta()CityLearnDemandResponseService.observation_values()CityLearnDemandResponseService.requestsCityLearnDemandResponseService.reset()CityLearnDemandResponseService.settle_current_time_step()CityLearnDemandResponseService.settlement_historyCityLearnDemandResponseService.summarize()
DemandResponseRequestDemandResponseRequest.activation_price_eur_per_kwhDemandResponseRequest.directionDemandResponseRequest.end_time_stepDemandResponseRequest.issuerDemandResponseRequest.orderDemandResponseRequest.request_idDemandResponseRequest.shortfall_penalty_eur_per_kwhDemandResponseRequest.start_time_stepDemandResponseRequest.target_power_kwDemandResponseRequest.tolerance_power_kw
- citylearn.internal.entity_interface module
ChargerRefCityLearnEntityInterfaceServiceCityLearnEntityInterfaceService.ACTION_FEEDBACK_BUNDLECityLearnEntityInterfaceService.ACTION_FEEDBACK_FEATURESCityLearnEntityInterfaceService.BASE_BUNDLECityLearnEntityInterfaceService.BASE_CHARGER_FEATURESCityLearnEntityInterfaceService.BASE_STORAGE_FEATURESCityLearnEntityInterfaceService.COMMUNITY_BUNDLECityLearnEntityInterfaceService.COMMUNITY_DISTRICT_EXTRA_FEATURESCityLearnEntityInterfaceService.CORE_BUILDING_EXTRA_FEATURESCityLearnEntityInterfaceService.CORE_BUNDLECityLearnEntityInterfaceService.DEFAULT_OBSERVATION_BUNDLESCityLearnEntityInterfaceService.DEFERRABLE_ACTION_FEEDBACK_FEATURESCityLearnEntityInterfaceService.DEFERRABLE_APPLIANCE_FEATURESCityLearnEntityInterfaceService.DEMAND_RESPONSE_BUNDLECityLearnEntityInterfaceService.DEMAND_RESPONSE_DISTRICT_FEATURESCityLearnEntityInterfaceService.DERIVED_FORECAST_BUILDING_SIGNALSCityLearnEntityInterfaceService.DERIVED_FORECAST_BUNDLECityLearnEntityInterfaceService.DERIVED_FORECAST_DISTRICT_SIGNALSCityLearnEntityInterfaceService.EXTRA_CHARGER_FEATURESCityLearnEntityInterfaceService.EXTRA_EV_FEATURESCityLearnEntityInterfaceService.EXTRA_STORAGE_FEATURESCityLearnEntityInterfaceService.FORECAST_BUNDLECityLearnEntityInterfaceService.FORECAST_HORIZONSCityLearnEntityInterfaceService.LEGACY_CHARGER_FEATURESCityLearnEntityInterfaceService.LEGACY_EV_FEATURESCityLearnEntityInterfaceService.LEGACY_STORAGE_FEATURESCityLearnEntityInterfaceService.PV_FEATURESCityLearnEntityInterfaceService.ROBUSTNESS_BUNDLECityLearnEntityInterfaceService.ROBUSTNESS_DISTRICT_FEATURESCityLearnEntityInterfaceService.TEMPORAL_BUILDING_FEATURESCityLearnEntityInterfaceService.TEMPORAL_BUNDLECityLearnEntityInterfaceService.TEMPORAL_DISTRICT_FEATURESCityLearnEntityInterfaceService.action_spaceCityLearnEntityInterfaceService.invalidate()CityLearnEntityInterfaceService.observation_payload()CityLearnEntityInterfaceService.observation_spaceCityLearnEntityInterfaceService.parse_actions()CityLearnEntityInterfaceService.reset()CityLearnEntityInterfaceService.specs
DeferrableApplianceRefPVRefStorageRef
- citylearn.internal.kpi module
CityLearnKPIServiceCityLearnKPIService.ELECTRICAL_RESIDUAL_EPS_KWCityLearnKPIService.EV_DEPARTURE_EPSCityLearnKPIService.EV_DEPARTURE_SERVICE_TOLERANCE_DEFAULTCityLearnKPIService.EV_DEPARTURE_WITHIN_TOLERANCE_DEFAULTCityLearnKPIService.LEGACY_COST_FUNCTIONSCityLearnKPIService.SCORECARD_DEFAULT_KPISCityLearnKPIService.evaluate()CityLearnKPIService.evaluate_legacy()CityLearnKPIService.evaluate_v2()
- citylearn.internal.loading module
CityLearnLoadingServiceCityLearnLoadingService.load()CityLearnLoadingService.load_building()CityLearnLoadingService.load_deferrable_appliance()CityLearnLoadingService.load_electric_vehicle()CityLearnLoadingService.load_escalator()CityLearnLoadingService.load_washing_machine()CityLearnLoadingService.process_metadata()
LoadContext
- citylearn.internal.physics_invariants module
- citylearn.internal.robustness module
CityLearnRobustnessServiceCityLearnRobustnessService.CONTROL_FEATURESCityLearnRobustnessService.DEFAULT_MISSING_REPLACEMENT_VALUECityLearnRobustnessService.KPI_KEYSCityLearnRobustnessService.MODULE_ALIASESCityLearnRobustnessService.TELEMETRY_FEATURESCityLearnRobustnessService.VALID_EVENT_DOMAINSCityLearnRobustnessService.VALID_MODESCityLearnRobustnessService.VALID_TARGET_TYPESCityLearnRobustnessService.adjust_observation_space()CityLearnRobustnessService.apply_actions()CityLearnRobustnessService.apply_observations()CityLearnRobustnessService.eventsCityLearnRobustnessService.get_metadata()CityLearnRobustnessService.historyCityLearnRobustnessService.initialize()CityLearnRobustnessService.observation_meta()CityLearnRobustnessService.observation_values()CityLearnRobustnessService.reset()CityLearnRobustnessService.runtime_status()CityLearnRobustnessService.summarize()CityLearnRobustnessService.validate_targets()
RobustnessEventRobustnessEvent.delay_stepsRobustnessEvent.end_time_stepRobustnessEvent.event_domainRobustnessEvent.event_idRobustnessEvent.max_valueRobustnessEvent.min_valueRobustnessEvent.modeRobustnessEvent.moduleRobustnessEvent.orderRobustnessEvent.replacement_valueRobustnessEvent.start_time_stepRobustnessEvent.stdRobustnessEvent.target_featureRobustnessEvent.target_idRobustnessEvent.target_typeRobustnessEvent.value
- citylearn.internal.runtime module
CityLearnRuntimeServiceCityLearnRuntimeService.associate_chargers_to_electric_vehicles()CityLearnRuntimeService.next_time_step()CityLearnRuntimeService.parse_actions()CityLearnRuntimeService.simulate_unconnected_ev_soc()CityLearnRuntimeService.step()CityLearnRuntimeService.step_many()CityLearnRuntimeService.step_without_feedback()CityLearnRuntimeService.update_variables()
- citylearn.internal.topology module
CityLearnTopologyServiceCityLearnTopologyService.active_chargers_at()CityLearnTopologyService.active_deferrable_appliances_at()CityLearnTopologyService.active_ev_idsCityLearnTopologyService.active_ev_ids_at()CityLearnTopologyService.active_member_idsCityLearnTopologyService.active_member_ids_at()CityLearnTopologyService.active_storage_at()CityLearnTopologyService.apply_events_for_time_step()CityLearnTopologyService.enabledCityLearnTopologyService.ev_poolCityLearnTopologyService.event_logCityLearnTopologyService.historical_chargers()CityLearnTopologyService.historical_deferrable_appliances()CityLearnTopologyService.historical_storages()CityLearnTopologyService.initialize()CityLearnTopologyService.member_lifecycleCityLearnTopologyService.member_poolCityLearnTopologyService.reset()CityLearnTopologyService.topology_versionCityLearnTopologyService.topology_version_at()
TopologyEvent
- citylearn.internal.units module