app.model.entity

Entity

Represents any modelled object (e.g., component, device, node) in the system.

Entities form the core building blocks of the energy system model. Each Entity can have quantities (data or decision variables), hierarchical sub-entities, and semantic or optimization-relevant relations.

Attributes:
  • - (id (str) –

    Unique identifier.

  • - (quantities (Dict[str, Quantity]) –

    Named quantities belonging to this entity.

  • - (sub_entities (dict[str, Entity]) –

    Optional nested child entities.

  • - (relations (list[Relation]) –

    Constraints or rules related to this entity.

  • - (tags (dict) –

    Dictionary of tags associated with this entity.

  • - (ts_factory (TimeseriesFactory) –

    Used to generate time series objects in an advanced manner.

__dir__()

Extend the default dir to include parameters and quantities.

__getattr__(name)

Get an attribute by name, checking parameters and quantities.

__init__(id=None, ts_factory=DefaultTimeseriesFactory(), **kwargs)

Initialize the entity with an optional id.

__str__()

String representation of the entity.

add_sub_entity(entity)

Add a sub_entity to the current entity.

convert(time_set, new_freq, converter)

Delegate to a visitor for conversion.