odys.parameters.coordinates¶

class Coordinates(BaseModel):
    """Coordinate labels along a single dimension."""

    model_config = ConfigDict(frozen=True, extra="forbid")

    dimension: str
    labels: tuple[str, ...]

    @classmethod
    def of_entities(cls, dimension: str, entities: Sequence[EnergyEntity]) -> Self:
        """Return coordinates labelled by the entities' names, in order.

        Args:
            dimension: The dimension the entities are indexed along.
            entities: The entities, such as all generators of the portfolio.

        Returns:
            The coordinates.

        """
        return cls(dimension=dimension, labels=tuple(entity.name for entity in entities))

    @property
    def dimension_coordinates_map(self) -> dict[str, list[str]]:
        """Return the xarray coordinate mapping for this dimension."""
        return {self.dimension: list(self.labels)}