Energy commodity

An energy system model is based on one or multiple energy commodities. Therefore you can add energy commodities to your dataset.

The following attributes are available:

pydantic model ensysmod.schemas.EnergyCommodityCreate

Attributes to receive via API on creation of an energy commodity.

field ref_dataset: int [Required]

Reference to the dataset where that energy commodity belongs to.

Constraints:

• gt = 0

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

field name: str [Required]

The unique name of the energy commodity inside this dataset. It is needed to add energy components of this specific commodity.

Constraints:

• min_length = 1

• max_length = 255

field description: str | None = None

Description of the energy commodity. Can be used as detailed description of the energy commodity.

Constraints:

• max_length = 1024

field unit: str [Required]

Unit of the energy commodity. Every provided data for this commodity must be in this unit.

Constraints:

• max_length = 255