energia.components.game#

energiapy.game init file

Classes

Interact()

Interaction between Players

Player([label, citations])

Player or Actor, the one taking the decisions based on information provided

class Player(label: str = '', citations: str = '', **kwargs)[source]#

Bases: _Component

Player or Actor, the one taking the decisions based on information provided

Players own certain processes and be responsible for the streams and impact caused by their decisions pertaining to this

Parameters:
  • label (str, optional) – An optional label for the component. Defaults to None.

  • citations (str | list[str] | dict[str, str | list[str]], optional) – An optional citation or description for the component. Defaults to None.

Variables:
  • model (Model) – The model to which the component belongs.

  • name (str) – Set when the component is assigned as a Model attribute.

  • constraints (list[str]) – List of constraints associated with the component.

  • domains (list[Domain]) – List of domains associated with the component.

  • aspects (dict[Aspect, list[Domain]]) – Aspects associated with the component with domains.

property I#

gana index set (I)

property cons: list[C]#

Constraints

property horizon: Periods#

Circumscribing Periods (Temporal Scale)

property network: Location#

Circumscribing Loc (Spatial Scale)

property problem: Problem#

Feasible Region

property program: Prg#

Mathematical program

show(descriptive=False, category: str = '')#

Pretty print the component

property space: Space#

Space

property time: Time#

Time

class Interact[source]#

Bases: object

Interaction between Players

Parameters:
  • player1 (Player) – First player

  • player2 (Player) – Second player

player1: Player = None#
player2: Player = None#

Modules

couple

Interact

player

Player