pycity_scheduling package
Subpackages
- pycity_scheduling.algorithms package
- Submodules
- pycity_scheduling.algorithms.algorithm module
- pycity_scheduling.algorithms.algorithm_ray module
- pycity_scheduling.algorithms.central_optimization_algorithm module
- pycity_scheduling.algorithms.derivative_free_aladin_algorithm module
- pycity_scheduling.algorithms.derivative_free_aladin_algorithm_ray module
- pycity_scheduling.algorithms.derivative_free_aladin_algorithm_ray_Hvet module
- pycity_scheduling.algorithms.dual_decomposition_algorithm module
- pycity_scheduling.algorithms.dual_decomposition_algorithm_mpi module
- pycity_scheduling.algorithms.dual_decomposition_algorithm_ray module
- pycity_scheduling.algorithms.exchange_admm_algorithm module
- pycity_scheduling.algorithms.exchange_admm_algorithm_mpi module
- pycity_scheduling.algorithms.exchange_admm_algorithm_ray module
- pycity_scheduling.algorithms.exchange_miqp_admm_algorithm module
- pycity_scheduling.algorithms.exchange_miqp_admm_algorithm_mpi module
- pycity_scheduling.algorithms.exchange_miqp_admm_algorithm_ray module
- pycity_scheduling.algorithms.local_optimization_algorithm module
- pycity_scheduling.algorithms.stand_alone_optimization_algorithm module
- Module contents
- pycity_scheduling.case_studies package
- pycity_scheduling.classes package
- Submodules
- pycity_scheduling.classes.apartment module
- pycity_scheduling.classes.battery module
- pycity_scheduling.classes.boiler module
- pycity_scheduling.classes.building module
- pycity_scheduling.classes.building_energy_system module
- pycity_scheduling.classes.chiller module
- pycity_scheduling.classes.city_district module
- pycity_scheduling.classes.combined_heat_power module
- pycity_scheduling.classes.curtailable_load module
- pycity_scheduling.classes.deferrable_load module
- pycity_scheduling.classes.electric_heater module
- pycity_scheduling.classes.electric_vehicle module
- pycity_scheduling.classes.electrical_entity module
- pycity_scheduling.classes.electrical_grid module
- pycity_scheduling.classes.electrical_line module
- pycity_scheduling.classes.electrical_node module
- pycity_scheduling.classes.entity_container module
- pycity_scheduling.classes.environment module
- pycity_scheduling.classes.fixed_load module
- pycity_scheduling.classes.heat_pump module
- pycity_scheduling.classes.optimization_entity module
OptimizationEntity
OptimizationEntity.copy_schedule()
OptimizationEntity.get_all_entities()
OptimizationEntity.get_decision_var()
OptimizationEntity.get_entities()
OptimizationEntity.get_lower_entities()
OptimizationEntity.get_objective()
OptimizationEntity.load_schedule()
OptimizationEntity.load_schedule_into_model()
OptimizationEntity.new_schedule()
OptimizationEntity.new_var()
OptimizationEntity.op_horizon
OptimizationEntity.op_slice
OptimizationEntity.op_time_vec
OptimizationEntity.populate_model()
OptimizationEntity.reset()
OptimizationEntity.schedule
OptimizationEntity.set_objective()
OptimizationEntity.simu_horizon
OptimizationEntity.static_entity_id
OptimizationEntity.time_slot
OptimizationEntity.timestep
OptimizationEntity.update_model()
OptimizationEntity.update_schedule()
- pycity_scheduling.classes.photovoltaic module
- pycity_scheduling.classes.prices module
- pycity_scheduling.classes.space_cooling module
- pycity_scheduling.classes.space_heating module
- pycity_scheduling.classes.thermal_cooling_storage module
- pycity_scheduling.classes.thermal_entity_cooling module
- pycity_scheduling.classes.thermal_entity_heating module
- pycity_scheduling.classes.thermal_heating_storage module
- pycity_scheduling.classes.timer module
- pycity_scheduling.classes.weather module
- pycity_scheduling.classes.wind_energy_converter module
- Module contents
Apartment
Battery
Boiler
Building
BuildingEnergySystem
Chiller
CityDistrict
CombinedHeatPower
CurtailableLoad
DeferrableLoad
ElectricHeater
ElectricVehicle
ElectricalEntity
ElectricalGrid
ElectricalLine
ElectricalNode
Environment
FixedLoad
HeatPump
OptimizationEntity
OptimizationEntity.copy_schedule()
OptimizationEntity.get_all_entities()
OptimizationEntity.get_decision_var()
OptimizationEntity.get_entities()
OptimizationEntity.get_lower_entities()
OptimizationEntity.get_objective()
OptimizationEntity.load_schedule()
OptimizationEntity.load_schedule_into_model()
OptimizationEntity.new_schedule()
OptimizationEntity.new_var()
OptimizationEntity.op_horizon
OptimizationEntity.op_slice
OptimizationEntity.op_time_vec
OptimizationEntity.populate_model()
OptimizationEntity.reset()
OptimizationEntity.schedule
OptimizationEntity.set_objective()
OptimizationEntity.simu_horizon
OptimizationEntity.static_entity_id
OptimizationEntity.time_slot
OptimizationEntity.timestep
OptimizationEntity.update_model()
OptimizationEntity.update_schedule()
Photovoltaic
Prices
SpaceCooling
SpaceHeating
ThermalCoolingStorage
ThermalEntityCooling
ThermalEntityHeating
ThermalHeatingStorage
Timer
Weather
WindEnergyConverter
filter_entities()
- pycity_scheduling.data package
- pycity_scheduling.examples package
- Submodules
- pycity_scheduling.examples.example_00_fundamentals module
- pycity_scheduling.examples.example_01_algorithm_central module
- pycity_scheduling.examples.example_02_algorithm_local module
- pycity_scheduling.examples.example_03_algorithm_stand-alone module
- pycity_scheduling.examples.example_04_algorithm_dual-decomposition module
- pycity_scheduling.examples.example_05_algorithm_exchange-admm module
- pycity_scheduling.examples.example_06_algorithm_exchange-miqp-admm module
- pycity_scheduling.examples.example_07_algorithm_aladin module
- pycity_scheduling.examples.example_08_algorithm_warmstart module
- pycity_scheduling.examples.example_09_algorithm_parallel_mpi module
- pycity_scheduling.examples.example_10_algorithm_parallel_ray module
- pycity_scheduling.examples.example_11_objective_peak-shaving module
- pycity_scheduling.examples.example_12_objective_self-consumption module
- pycity_scheduling.examples.example_13_objective_max-consumption module
- pycity_scheduling.examples.example_14_objective_price module
- pycity_scheduling.examples.example_15_objective_co2 module
- pycity_scheduling.examples.example_16_objective_valley-filling module
- pycity_scheduling.examples.example_17_district_generator module
- pycity_scheduling.examples.example_18_district_flexibility_quantification module
- pycity_scheduling.examples.example_19_scheduling_city_district_aladin module
- pycity_scheduling.examples.example_20_scheduling_complex_city_district module
- pycity_scheduling.examples.example_21_scheduling_pv+battery_system module
- pycity_scheduling.examples.example_22_scheduling_heating_and_cooling_loads module
- pycity_scheduling.examples.example_23_scheduling_convex_vs_integer_mode module
- pycity_scheduling.examples.example_24_scheduling_robust_optimization module
- pycity_scheduling.examples.example_25_scheduling_with_grid_four_load_branch module
- pycity_scheduling.examples.example_26_scheduling_with_grid_four_load_branch_out module
- pycity_scheduling.examples.example_27_scheduling_with_grid_two_load_generation_branch module
- pycity_scheduling.examples.example_28_scheduling_with_grid_N_branches module
- pycity_scheduling.examples.example_29_post-processing_schedule_evaluation module
- pycity_scheduling.examples.example_30_post-processing_metrics_evaluation module
- Module contents
- pycity_scheduling.testing package
- Subpackages
- pycity_scheduling.testing.unit_tests package
- Submodules
- pycity_scheduling.testing.unit_tests.test_algorithms module
- pycity_scheduling.testing.unit_tests.test_all_classes module
- pycity_scheduling.testing.unit_tests.test_classes module
- pycity_scheduling.testing.unit_tests.test_examples module
- pycity_scheduling.testing.unit_tests.test_util module
- Module contents
- pycity_scheduling.testing.unit_tests package
- Module contents
- Subpackages
- pycity_scheduling.util package
- Submodules
- pycity_scheduling.util.approximation module
- pycity_scheduling.util.debug module
- pycity_scheduling.util.district_analyzer module
DistrictAnalyzer
DistrictAnalyzer.add_vectors()
DistrictAnalyzer.check_start_vars_DL()
DistrictAnalyzer.compare_aggregated_entities()
DistrictAnalyzer.compare_city_ditrict_schedules()
DistrictAnalyzer.compare_entity_schedules()
DistrictAnalyzer.complete_post_analyze()
DistrictAnalyzer.complete_pre_analyze()
DistrictAnalyzer.convert_pyomo_to_numpy()
DistrictAnalyzer.count_violated_constraints()
DistrictAnalyzer.figure_number
DistrictAnalyzer.plot_city_district_schedule()
DistrictAnalyzer.plot_demand_profile()
DistrictAnalyzer.plot_electrical_demand_profile()
DistrictAnalyzer.plot_electrical_generation_profile()
DistrictAnalyzer.plot_electrical_power_imbalance()
DistrictAnalyzer.plot_entity_schedules()
DistrictAnalyzer.plot_flexible_device_schedules()
DistrictAnalyzer.plot_generation_profile()
DistrictAnalyzer.plot_heat_demand_profile()
DistrictAnalyzer.print_schedules()
DistrictAnalyzer.save_schedules()
- pycity_scheduling.util.factory module
- pycity_scheduling.util.generic_constraints module
- pycity_scheduling.util.metric module
- pycity_scheduling.util.mpi_interface module
- pycity_scheduling.util.plot_schedules module
- pycity_scheduling.util.write_schedules module
- Module contents
Submodules
pycity_scheduling.constants module
The pycity_scheduling framework
Copyright (C) 2025, Institute for Automation of Complex Power Systems (ACS), E.ON Energy Research Center (E.ON ERC), RWTH Aachen University
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
pycity_scheduling.exceptions module
The pycity_scheduling framework
Copyright (C) 2025, Institute for Automation of Complex Power Systems (ACS), E.ON Energy Research Center (E.ON ERC), RWTH Aachen University
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- exception pycity_scheduling.exceptions.MaxIterationError
Bases:
SchedulingError
Exception raised, when the maximum number of iterations (by a distributed algorithm) is reached.
- exception pycity_scheduling.exceptions.NonoptimalError
Bases:
SchedulingError
Exception raised, when a model did not converge towards an optimal solution.
pycity_scheduling.solvers module
The pycity_scheduling framework
Copyright (C) 2025, Institute for Automation of Complex Power Systems (ACS), E.ON Energy Research Center (E.ON ERC), RWTH Aachen University
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Module contents
The pycity_scheduling framework
Copyright (C) 2025, Institute for Automation of Complex Power Systems (ACS), E.ON Energy Research Center (E.ON ERC), RWTH Aachen University
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.