pycity_scheduling

The pycity_scheduling documentation v1.4.0

• pycity_scheduling.algorithms package
  • Submodules
  • pycity_scheduling.algorithms.algorithm module
    • DistributedAlgorithm
    • IterationAlgorithm
    • OptimizationAlgorithm
    • SolverNode
  • pycity_scheduling.algorithms.algorithm_ray module
    • RaySolverNode
    • get_beta()
    • list_into_n_chunks()
  • pycity_scheduling.algorithms.central_optimization_algorithm module
    • CentralOptimization
  • pycity_scheduling.algorithms.derivative_free_aladin_algorithm module
    • DerivativeFreeALADIN
  • pycity_scheduling.algorithms.derivative_free_aladin_algorithm_ray module
    • DerivativeFreeALADINRay
  • pycity_scheduling.algorithms.derivative_free_aladin_algorithm_ray_Hvet module
    • DerivativeFreeALADINRay_Hvet
  • pycity_scheduling.algorithms.dual_decomposition_algorithm module
    • DualDecomposition
  • pycity_scheduling.algorithms.dual_decomposition_algorithm_mpi module
    • DualDecompositionMPI
  • pycity_scheduling.algorithms.dual_decomposition_algorithm_ray module
    • DualDecompositionRay
  • pycity_scheduling.algorithms.exchange_admm_algorithm module
    • ExchangeADMM
  • pycity_scheduling.algorithms.exchange_admm_algorithm_mpi module
    • ExchangeADMMMPI
  • pycity_scheduling.algorithms.exchange_admm_algorithm_ray module
    • ExchangeADMMRay
  • pycity_scheduling.algorithms.exchange_miqp_admm_algorithm module
    • ExchangeMIQPADMM
  • pycity_scheduling.algorithms.exchange_miqp_admm_algorithm_mpi module
    • ExchangeMIQPADMMMPI
  • pycity_scheduling.algorithms.exchange_miqp_admm_algorithm_ray module
    • ExchangeMIQPADMMRay
  • pycity_scheduling.algorithms.local_optimization_algorithm module
    • LocalOptimization
  • pycity_scheduling.algorithms.stand_alone_optimization_algorithm module
    • StandAlone
  • Module contents
    • CentralOptimization
    • DerivativeFreeALADIN
    • DerivativeFreeALADINRay
    • DerivativeFreeALADINRay_Hvet
    • DualDecomposition
    • DualDecompositionMPI
    • DualDecompositionRay
    • ExchangeADMM
    • ExchangeADMMMPI
    • ExchangeADMMRay
    • ExchangeMIQPADMM
    • ExchangeMIQPADMMMPI
    • ExchangeMIQPADMMRay
    • LocalOptimization
    • StandAlone
• pycity_scheduling.classes package
  • Submodules
  • pycity_scheduling.classes.apartment module
    • Apartment
  • pycity_scheduling.classes.battery module
    • Battery
  • pycity_scheduling.classes.boiler module
    • Boiler
  • pycity_scheduling.classes.building module
    • Building
  • pycity_scheduling.classes.building_energy_system module
    • BuildingEnergySystem
  • pycity_scheduling.classes.chiller module
    • Chiller
  • pycity_scheduling.classes.city_district module
    • CityDistrict
  • pycity_scheduling.classes.combined_heat_power module
    • CombinedHeatPower
  • pycity_scheduling.classes.curtailable_load module
    • CurtailableLoad
  • pycity_scheduling.classes.deferrable_load module
    • DeferrableLoad
  • pycity_scheduling.classes.electric_heater module
    • ElectricHeater
  • pycity_scheduling.classes.electric_vehicle module
    • ElectricVehicle
  • pycity_scheduling.classes.electrical_entity module
    • ElectricalEntity
  • pycity_scheduling.classes.electrical_grid module
    • ElectricalGrid
  • pycity_scheduling.classes.electrical_line module
    • ElectricalLine
  • pycity_scheduling.classes.electrical_node module
    • ElectricalNode
  • pycity_scheduling.classes.entity_container module
    • EntityContainer
  • pycity_scheduling.classes.environment module
    • Environment
  • pycity_scheduling.classes.fixed_load module
    • FixedLoad
  • pycity_scheduling.classes.heat_pump module
    • HeatPump
  • pycity_scheduling.classes.optimization_entity module
    • OptimizationEntity
  • pycity_scheduling.classes.photovoltaic module
    • Photovoltaic
  • pycity_scheduling.classes.prices module
    • Prices
  • pycity_scheduling.classes.space_cooling module
    • SpaceCooling
  • pycity_scheduling.classes.space_heating module
    • SpaceHeating
  • pycity_scheduling.classes.thermal_cooling_storage module
    • ThermalCoolingStorage
  • pycity_scheduling.classes.thermal_entity_cooling module
    • ThermalEntityCooling
  • pycity_scheduling.classes.thermal_entity_heating module
    • ThermalEntityHeating
  • pycity_scheduling.classes.thermal_heating_storage module
    • ThermalHeatingStorage
  • pycity_scheduling.classes.timer module
    • Timer
  • pycity_scheduling.classes.weather module
    • Weather
  • pycity_scheduling.classes.wind_energy_converter module
    • WindEnergyConverter
  • Module contents
    • Apartment
    • Battery
    • Boiler
    • Building
    • BuildingEnergySystem
    • Chiller
    • CityDistrict
    • CombinedHeatPower
    • CurtailableLoad
    • DeferrableLoad
    • ElectricHeater
    • ElectricVehicle
    • ElectricalEntity
    • ElectricalGrid
    • ElectricalLine
    • ElectricalNode
    • Environment
    • FixedLoad
    • HeatPump
    • OptimizationEntity
    • Photovoltaic
    • Prices
    • SpaceCooling
    • SpaceHeating
    • ThermalCoolingStorage
    • ThermalEntityCooling
    • ThermalEntityHeating
    • ThermalHeatingStorage
    • Timer
    • Weather
    • WindEnergyConverter
    • filter_entities()
• pycity_scheduling.util package
  • Submodules
  • pycity_scheduling.util.approximation module
    • piecewise_linear_approx()
  • pycity_scheduling.util.debug module
    • analyze_model()
    • print_district()
  • pycity_scheduling.util.district_analyzer module
    • DistrictAnalyzer
  • pycity_scheduling.util.factory module
    • generate_simple_building()
    • generate_standard_environment()
    • generate_tabula_buildings()
    • generate_tabula_district()
  • pycity_scheduling.util.generic_constraints module
    • Constraint
    • LowerActivationLimit
  • pycity_scheduling.util.metric module
    • absolute_flexibility_gain()
    • autarky()
    • calculate_adj_costs()
    • calculate_adj_energy()
    • calculate_adj_power()
    • calculate_co2()
    • calculate_costs()
    • metric_delta_g()
    • peak_reduction_ratio()
    • peak_to_average_ratio()
    • self_consumption()
  • pycity_scheduling.util.mpi_interface module
    • MPIInterface
    • UnbufferedPrint
  • pycity_scheduling.util.plot_schedules module
    • plot_entity()
    • plot_entity_directory()
    • plot_imbalance()
  • pycity_scheduling.util.write_schedules module
    • schedule_to_csv()
    • schedule_to_dict()
    • schedule_to_json()
  • Module contents
    • calculate_flexibility_potential()
    • compute_profile()
    • extract_pyomo_value()
    • extract_pyomo_values()