omegalpes.actor package

Subpackages

• omegalpes.actor.operator_actors package
  • Submodules
  • omegalpes.actor.operator_actors.consumer_actors module
    • Consumer
      • Consumer.add_energy_consumption_maximum()
      • Consumer.add_energy_consumption_minimum()
      • Consumer.add_power_consumption_by_unit_maximum()
      • Consumer.add_power_consumption_by_unit_minimum()
      • Consumer.add_power_consumption_total_maximum()
      • Consumer.add_power_consumption_total_minimum()
      • Consumer.maximize_consumption()
      • Consumer.minimize_co2_consumption()
      • Consumer.minimize_consumption()
      • Consumer.minimize_consumption_cost()
  • omegalpes.actor.operator_actors.grid_operator_actors module
    • ElectricityGridOperator
      • ElectricityGridOperator.add_energy_transfer_maximum()
      • ElectricityGridOperator.minimize_capacity()
      • ElectricityGridOperator.minimize_energy_transfer()
    • HeatGridOperator
      • HeatGridOperator.add_RR_energy_rate_minimum_at_each_time_step()
      • HeatGridOperator.add_RR_energy_rate_minimum_over_the_study()
      • HeatGridOperator.maximize_RR_energy_rate()
      • HeatGridOperator.minimize_capacity()
      • HeatGridOperator.minimize_production()
  • omegalpes.actor.operator_actors.operator_actors module
    • OperatorActor
  • omegalpes.actor.operator_actors.producer_actors module
    • Producer
      • Producer.add_energy_production_maximum()
      • Producer.add_energy_production_minimum()
      • Producer.add_power_production_by_unit_maximum()
      • Producer.add_power_production_by_unit_minimum()
      • Producer.add_power_production_total_maximum()
      • Producer.add_power_production_total_minimum()
      • Producer.add_temporary_stop()
      • Producer.maximize_production()
      • Producer.minimize_co2_emissions()
      • Producer.minimize_costs()
      • Producer.minimize_operating_cost()
      • Producer.minimize_production()
      • Producer.minimize_starting_cost()
      • Producer.minimize_time_of_use()
      • Producer.power_consumption_maximum()
      • Producer.power_consumption_minimum()
  • omegalpes.actor.operator_actors.prosumer_actors module
    • Prosumer
      • Prosumer.add_fixed_repartition_key()
      • Prosumer.add_nb_unit_maximum()
      • Prosumer.add_nb_unit_minimum()
      • Prosumer.maximize_conso_prod_match()
      • Prosumer.maximize_selfconsumption_rate()
      • Prosumer.maximize_selfproduction_rate()
      • Prosumer.minimize_capacity()
  • omegalpes.actor.operator_actors.supplier_actors module
    • Supplier
      • Supplier.add_energy_collected_maximum()
      • Supplier.minimize_energy_collection()
  • Module contents
• omegalpes.actor.project_developer_actors package
  • Submodules
  • omegalpes.actor.project_developer_actors.developper_actors module
    • ProjectDeveloper
  • Module contents
• omegalpes.actor.regulator_actors package
  • Submodules
  • omegalpes.actor.regulator_actors.regulator_actors module
    • LocalAuthorities
    • RegulatorActor
      • RegulatorActor.add_co2_emission_maximum()
      • RegulatorActor.add_particles_emission_maximum()
    • StateAuthorities
  • Module contents

Submodules

omegalpes.actor.actor module

This modules define the basic Actor object

Few methods are available:

• add_external_constraint

• add_external_dynamic_constraint

• add_objective

class omegalpes.actor.actor.Actor(name, no_warn=True, verbose=True)

Bases: OptObject

Description

Actor class is the basic class to model an actor. The basic actor is defined by its name and description. An actor is then defined by its constraints and objectives.

Attributes

• description : description as an Actor OptObject

add_actor_constraint(cst_name, exp)

Enable to add an external constraint linked with an actor

Parameters:

• cst_name – name of the constraint

• exp – expression of the constraint

add_actor_dynamic_constraint(cst_name, exp_t, t_range='for t in time.I')

Enable to add an external dynamic constraint linked with an actor. A dynamic constraint changes over time

Parameters:

• cst_name – name of the constraint

• exp – expression of the constraint depending on the time

• t_range – expression of time for the constraint

add_objective(obj_name, exp)

Enable to add an objective linked with an actor

Parameters:

• obj_name – name of the objective

• exp – expression of the objective

remove_actor_constraints(ext_cst_name_list=None)

Enable to remove an external constraint linked with an actor

Parameters:

ext_cst_name_list – list of external constraint that would be removed

Module contents